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

Authorization

Send a Scouty token as a bearer token in the Authorization header. The token needs the campaigns:read 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.

Errors

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

Statuserror.codeMeaning
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.
429 Too Many Requestsrate_limitedToo many requests this minute. Retry-After says how long is left.