Targets & Blacklist

Add creators to the shop's do-not-contact list

Blacklist one or more creators so outreach automations stop targeting them.

Handles are normalized before storage (a leading @ and surrounding whitespace are stripped, the handle is lowercased), so @Creator and creator are the same entry. The call is additive and forgiving: handles already on the list are counted in duplicates_skipped, malformed handles (URLs, blanks) in invalid_skipped — neither fails the request, so a partially valid batch still applies. Check added_count for what actually changed.

At most 500 handles per request. Requires a key with read_write scope and a single shop.

post/shops/blacklist

Request body

creatorsstring[] required

Creator handles. A leading @ and surrounding whitespace are stripped and the handle is lowercased before storage. URLs are rejected. Duplicates within the request and handles already on the list are skipped, not errors.

Example request

{
  "creators": [
    "@somecreator",
    "another.creator"
  ]
}

Response

Successful Response

added_countinteger required

Handles newly blacklisted.

duplicates_skippedinteger required

Handles already on the list, left untouched.

invalid_skippedinteger required

Handles rejected as malformed (URLs, blanks).

invalid_creatorsstring[]

The rejected handles, as submitted.

messagestring required

Human-readable summary of the outcome.

Changes

No recorded changes to this endpoint across all 1 revision of this API.