All documentation
Documentation
PATCH /sdk/v1/campaign-creators/:campaignCreatorRecordId/visibility
Hides or unhides one campaign creator record. Visibility is scoped to this campaign membership; it does not hide the creator's profile from other campaigns.
All requests require X-Application-Id and X-Api-Key.
Path parameter
campaignCreatorRecordId(required): the campaign creator record to update. Get this value from the v2 campaign creator list or v1 campaign creator list.
Body
hidden(required): a boolean. Sendtrueto hide the creator orfalseto unhide the creator.
Example request
curl -sS "$BASE_URL/sdk/v1/campaign-creators/CCR_123/visibility" \
-X PATCH \
-H "Content-Type: application/json" \
-H "X-Application-Id: $APP_ID" \
-H "X-Api-Key: $API_KEY" \
-d '{"hidden": true}'
Response
{
"success": true,
"data": {
"campaignCreatorRecordId": "CCR_123",
"hidden": true
}
}
Hidden campaign creators are excluded from creator lists by default. Set
includeHidden=true when listing campaign creators to retrieve them and their
campaignCreatorRecordId, then send {"hidden": false} to unhide one.
Repeating {"hidden": true} preserves the existing hide date. Unhiding clears
that date, and a later hide records a new date. Analytics summary, series,
and top can use this date as a performance cutoff with includeHidden=false;
see analytics.
Common errors
400: the record ID is invalid,hiddenis missing or is not a boolean, or the request supplies anagencyId401: missing or invalid SDK credentials404: the campaign creator record does not exist or belongs to another agency
