OAuth & Access
Scopes
OAuth and API-key scopes that gate access to API v1 endpoints.
| Scope | Description | Status |
|---|---|---|
messages:send |
Send WhatsApp messages | Active |
messages:read |
Read messages and delivery status | Active |
messages:webhook |
Receive message events via webhooks | Active |
contacts:read |
Read contacts | Active |
contacts:write |
Create and update contacts | Active |
devices:read |
View connected devices and channels | Active |
devices:manage |
Add, connect, reconnect, and delete WhatsApp channels (Device QR + Cloud hosted onboarding) | Active |
qr:generate |
Generate QR codes for device pairing | Active |
conversations:read |
Read conversations and inbox | Active |
templates:read |
Read message templates | Active |
templates:write |
Create, edit, and delete Meta templates (explicit grant required) | Reserved |
templates:sync |
Sync Meta templates for a WhatsApp Cloud account | Reserved |
templates:send |
Send approved Meta templates (alias of messages:send when granted) | Active |
whatsapp_accounts:read |
List WhatsApp accounts and template capabilities | Active |
webhooks:manage |
Register and manage developer webhook endpoints | Active |
account:read |
Read account profile and usage | Active |
tickets:read |
Read tenant tickets and ticket types (explicit grant required) | Active |
tickets:write |
Create and update tenant tickets and ticket types (explicit grant required) | Active |
catalog:read |
Read catalog categories, items, item types and data sources (explicit grant required) | Active |
catalog:write |
Create, update, bulk upsert and delete catalog categories and items; run data sources (explicit grant required) | Active |
knowledge:read |
Read knowledge base entries (explicit grant required) | Active |
knowledge:write |
Create, update, bulk upsert and delete knowledge base entries (explicit grant required) | Active |
Channel management scope
devices:manage is active. It gates create / pairing / reconnect / delete / default / hosted Cloud onboarding.
- Credentials for API key authentication with
scopes = nullget every scope excepttemplates:write,templates:sync,templates:send,tickets:read,tickets:write,catalog:read,catalog:write,knowledge:read,knowledge:write, which need an explicit grant.devices:manageis included. - OAuth apps created before 2026-07-18 may lack it — open Dashboard → Developer Apps → Edit (or “Add devices:manage”), then have the client re-authorize to refresh the token scopes.
- Hosted Cloud onboarding also requires a redirect URI host on that Developer App (even with API key authentication).
- The hosted page is for the Washeej account owner (parent user), not team agents.
Reserved scopes
Need an explicit grant plus lifecycle canary/feature assignment. They are never included in scopes = null credentials.
| Scope | Guidance |
|---|---|
templates:write |
Create/edit/delete Meta templates via Public API (canary + explicit scope). |
templates:sync |
Sync Meta templates for a Cloud WhatsApp account (canary + explicit scope). |