Skip to content

Create a campaign

Creates a draft campaign for this brand. A draft is not live and nothing is sent to anybody: use scouty_request_publish when it is ready and the team will review it.

POST/v1/campaigns
  • Scopecampaigns:write
  • Write
  • MCP toolscouty_create_campaign

Markdown version for your agent

Authorization

Send a Scouty token as a bearer token in the Authorization header. The token needs the campaigns:write scope, or the call answers 403 insufficient_scope. Tokens and scopes

Authorization: Bearer $SCOUTY_TOKEN

Headers

NameTypeRequiredDescription
Idempotency-KeystringOptional

The same key the body's idempotencyKey carries. Send one or the other, or both with the same value.

Body parameters

A JSON object, sent with Content-Type: application/json.

NameTypeRequiredDescription
idempotencyKeystringRequired

A key you choose for this call, 8 to 128 characters of letters, digits, dot, underscore, colon or hyphen. Sending the same key with the same arguments replays the first answer and changes nothing, so a retry after a timeout is safe.

titlestringRequired

The campaign's name, as creators read it.

overviewstringRequired

A short description of what the campaign is.

payLinestringOptional

What the campaign pays, in one line, exactly as a creator is shown it.

deliverablesstring[]Required

What a creator is asked to make.

requirementsstring[]Required

What a creator has to be or do to take part.

marketCountryCodesstring[]Required

Two-letter country codes for the markets. An empty list reaches everywhere.

applicationDeadlinestring | nullOptional

The last day to apply, as YYYY-MM-DD, or null for no deadline.

Errors

A refusal answers { "error": { "code", "message" } }. Branch on code; the message is for a person. Every error and its fix

Statuserror.codeMeaning
400 Bad Requestinvalid_requestThe request was not the shape this capability takes, or its body was not JSON.
401 Unauthorizedmissing_token invalid_token token_revoked token_expired token_orphanedNo token, or one that is not recognized, revoked or expired.
403 Forbiddeninsufficient_scope wrong_principalThe token does not carry the scope this capability needs.
409 Conflictidempotency_conflictThat idempotency key was already used for a different request. Nothing was changed.
429 Too Many Requestsrate_limitedToo many requests this minute. Retry-After says how long is left.