Campaigns

Remove a creator from a campaign

Removes the creator from ONE campaign (terminal removed status). The campaign lives in the x-shop-id shop; pass its id in the body. Removed creators disappear from the creator's portal views.

Paid/completed creators are blocked (409) — their payout ledger is preserved and never overwritten.

Idempotent: removing an already-removed creator returns 200 with code='already_removed' (no error). Combined with the Idempotency-Key replay, repeated calls are always safe.

X-Dry-Run: true validates + echoes the intended action without writing or sending the optional SMS.

post/campaigns/creators/{creator_id}/remove

Path parameters

creator_idinteger required

Headers

Idempotency-Keystring nullable

X-Dry-Runstring nullable

Request body

campaign_idinteger required

Campaign (in the x-shop-id shop) to remove the creator from.

messagestring nullable

Optional SMS sent to the creator on removal. Removal is otherwise silent (no email, no default SMS). Length capped at 320 to match the service's SMS limit. SKIPPED on X-Dry-Run.

Response

Removed (or idempotent already-removed).

successboolean

codestring

ok on a real removal; already_removed on an idempotent no-op replay of an already-removed mapping.

dataobject

{campaign_creator_mapping_id, status='removed'}.

Changes

No recorded changes to this endpoint across all 2 revisions of this API.