Skip to main content
Each scope is a door on your key: send, query, or cancel, open only what you need.
Each scope unlocks one type of RCS operation. Use only what your integration needs.

​
How to send the key

Recommended
Alternative
Each API Key belongs to one workspace. You cannot access another workspace with the same key.

​
Common combinations

Send only

rcs:send

Send and query

rcs:send, rcs:read

With scheduling

rcs:send, rcs:cancel

Full flow

rcs:send, rcs:read, rcs:cancel
An empty scope list on creation = ADMIN access. Always restrict in production.

​
Available scopes

Send immediate or scheduled RCS to 1 to 100 numbers per request. Types: BASIC, CARD, CAROUSEL, FILE.
Query status and data for one send by id.
Cancel queued or scheduled message. Only with QUEUED or SCHEDULED status. Credits refunded when applicable.

​
Common errors

Check Authorization: Bearer sk_... and that the key wasn’t deleted in the dashboard.
Suspended or expired workspace. Fix the plan in the dashboard.
Check operation scope. On send, verify credits (60 per message, PLAN_LIMIT_CREDITS) and whether scheduling is on the plan (PLAN_LIMIT_SCHEDULING).
Cancel only works with QUEUED or SCHEDULED status. After send, cancellation is not available.

​
Next steps