Update a campaign
Changes the words on one campaign. A draft or paused campaign is written straight away. A live campaign's change is held for the team to review, so creators keep reading what they signed up to until it goes through.
https://api.tryscouty.com/v1/campaigns/{campaignId} - Scope
campaigns:write - Write
- Safe to retry
- MCP tool
scouty_update_campaign
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_TOKENPath parameters
| Name | Type | Required | Description |
|---|---|---|---|
campaignId | integer | Required | The campaign to change. |
Headers
| Name | Type | Required | Description |
|---|---|---|---|
Idempotency-Key | string | Optional | 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.
| Name | Type | Required | Description |
|---|---|---|---|
idempotencyKey | string | Required | 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. |
changes | object | Required | Only the fields you are changing. Everything else is left as it is. |
changes.title | string | Optional | The campaign's name, as creators read it. |
changes.overview | string | Optional | A short description of what the campaign is. |
changes.payLine | string | Optional | What the campaign pays, in one line, exactly as a creator is shown it. |
changes.deliverables | string[] | Optional | What a creator is asked to make. |
changes.requirements | string[] | Optional | What a creator has to be or do to take part. |
changes.marketCountryCodes | string[] | Optional | Two-letter country codes for the markets. An empty list reaches everywhere. |
changes.applicationDeadline | string | null | Optional | The last day to apply, as YYYY-MM-DD, or null for no deadline. |
changes.activationMode | string | Optional | What happens when a creator signs: auto walks them in, manual waits for you, off does nothing. One of |
Errors
A refusal answers { "error": { "code", "message" } }. Branch on code; the message is for a person. Every error and its fix
| Status | error.code | Meaning |
|---|---|---|
| 400 Bad Request | invalid_request | The request was not the shape this capability takes, or its body was not JSON. |
| 401 Unauthorized | missing_token invalid_token token_revoked token_expired token_orphaned | No token, or one that is not recognized, revoked or expired. |
| 403 Forbidden | insufficient_scope wrong_principal | The token does not carry the scope this capability needs. |
| 404 Not Found | not_found | No such route, or no such campaign for this client. |
| 409 Conflict | idempotency_conflict | That idempotency key was already used for a different request. Nothing was changed. |
| 429 Too Many Requests | rate_limited | Too many requests this minute. Retry-After says how long is left. |