Scopes
Common combinations
Related scopes on the same integrator:
segments:read— validate audiencetemplates:read— choose templatemessages:send— if sending goes through the messages API instead of campaigns
Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
API Key permissions to create and monitor campaigns (campaigns:*).
campaigns:*. Creating a campaign requires audience and content — segments, templates, and messages scopes in the full flow.| Scope | Allows |
|---|---|
campaigns:read | GET /v1/campaigns, GET /v1/campaigns/{id} |
campaigns:create | POST /v1/campaigns |
campaigns:update | PATCH /v1/campaigns/{id}, cancel |
campaigns:delete | DELETE /v1/campaigns/{id} |
campaigns:run | POST /v1/campaigns/{id}/run, run preview |
| Flow | Scopes |
|---|---|
| Monitor campaigns only | campaigns:read |
| Automation triggers campaigns | campaigns:read, campaigns:create, campaigns:run, segments:read |
| Full management | campaigns:* |
segments:read — validate audiencetemplates:read — choose templatemessages:send — if sending goes through the messages API instead of campaigns| Code | Cause |
|---|---|
| 403 | Missing campaigns:create |
| 400 | Empty segment, template incompatible with channel |
403 PLAN_LIMIT | Campaign or send limit for the plan |
Esta página foi útil?
