API scopes
A key’s scopes are the most it can ever do; a token asks for some or all of them. Choose the scopes when you create the key (see API keys and scopes), and give each key only the ones its system needs.
| Scope | Allows |
|---|---|
account:read |
View Account Details |
account:create |
Create Account Resources |
account:update |
Update Account Resources |
account:delete |
Remove Account Resources |
billing:read |
View Billing and Pricing Information |
tickets:read |
View Support Tickets |
tickets:create |
Raise Support Tickets |
tickets:update |
Reply to and Update Support Tickets |
webhooks:read |
View Webhook Endpoints |
webhooks:create |
Register Webhook Endpoints |
webhooks:update |
Update Webhook Endpoints |
webhooks:delete |
Remove Webhook Endpoints |
watch:read |
View Watches |
watch:create |
Create Watches |
watch:delete |
Remove Watches |
data:read |
View Data Services (NBN and Opticomm) |
data:create |
Create/Order Data Services (NBN and Opticomm) |
data:update |
Update Data Services (NBN and Opticomm) |
data:delete |
Cancel Data Services (NBN and Opticomm) |
voice:read |
View Voice Services and Data |
voice:create |
Create Voice Services |
voice:update |
Update Voice Services |
voice:delete |
Cancel Voice Services |
sms:read |
View SMS Messages and History |
sms:send |
Send SMS Messages |