Skip to main content
POST
Exclude a post from earnings

Authorizations

x-api-key
string
header
required

API key created in Dashboard → Settings → Developer

Path Parameters

id
string<uuid>
required

ID of the post

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
dryRun
boolean
default:false

With true, run every check and roll back. Nothing is excluded, recorded, or sent.

Body

application/json
message
string

Optional. Shown to the creator.

Required string length: 1 - 1000
reason
string
deprecated

Earlier name for message. Send one of the two, not both.

Required string length: 1 - 1000

Response

Post excluded, or the dry-run result

id
string<uuid>
required
excluded
enum<boolean>
required
Available options:
true
creatorNotified
boolean
required

True when a reason was sent to the creator