Skip to main content
POST
Remove a creator from a program

Authorizations

x-api-key
string
header
required

API key created in Dashboard → Settings → Developer

Path Parameters

id
string<uuid>
required

The program id

creatorId
string
required

The creator id from GET /creators

Query Parameters

scope
enum<string>
default:company

Choose the data scope. company (default) limits results to the API key company's data. agency includes the parent agency and its linked brands. scope=agency requires a parent agency key; other keys receive 403.

Available options:
company,
agency

Body

application/json
reason
string
required

Why the creator is removed. Stored on the removal's record; the creator does not see it.

Maximum string length: 500
Example:

"No posts in 30 days"

paymentAction
enum<string>
required

No default. keep: the creator is still paid for work already done. remove: the creator's unpaid earnings on the program are cancelled. remove is allowed only when the preview returns canRemovePayments: true.

Available options:
keep,
remove
creatorName
string
required

creatorName from the preview. Letter case and spaces are ignored.

Maximum string length: 300
Example:

"Ava Stone"

programName
string
required

programName from the preview. Letter case and spaces are ignored.

Maximum string length: 300
Example:

"Fall Launch"

creatorHandle
string

Required only when the preview returns sameNameCreators: one of this creator's handles that no creator in sameNameCreators has. A leading @ and letter case are ignored.

Maximum string length: 300
Example:

"@avastone"

Response

The creator was removed

programId
string<uuid>
programName
string
creatorId
string
creatorName
string
removed
enum<boolean>
Available options:
true
paymentAction
enum<string>
Available options:
keep,
remove
warnings
string[]

A product order whose cancellation needs a check