Skip to content
ScoutyDocs
  • Get startedGuides
  • Control and troubleshootingGuides
  • API referenceAPI reference
  • Limits, errors, and policiesGuides

Choose which SideShift campaign a campaign maps to

Sets which campaign on the connected SideShift account this campaign's creators are checked against, as the picker on the dashboard does. The id must be on the account's list right now.

PATCH/v1/campaigns/{campaignId}/activation/sideshift
  • Scopecampaigns:write
  • Write
  • Safe to retry
  • MCP toolscouty_choose_sideshift_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

Path parameters

NameTypeRequiredDescription
campaignIdintegerRequired

The campaign whose activation flow this is about.

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.

sideshiftCampaignIdstringRequired

The SideShift campaign's id, as scouty_list_sideshift_campaigns lists it.

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.
404 Not Foundnot_foundNo such route, or no such campaign for this client.
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.