Offboard a creator
Marks a creator as offboarded on one campaign, so they are no longer counted as working on it. Nothing is sent to the creator and their own record is untouched.
https://api.tryscouty.com/v1/campaigns/{campaignId}/creators/{memberId}/offboard - Scope
creators:manage - Write
- Safe to retry
- MCP tool
scouty_offboard_creator
Authorization
Send a Scouty token as a bearer token in the Authorization header. The token needs the creators:manage 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 this creator is on. |
memberId | integer | Required | The creator's id, as scouty_list_applicants reports it. |
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. |
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. |