Partner Available Scopes

When partners are created, the system allows them to access API objects and methods based on the scopes they possess. Use this quick reference to view all the available scopes which the system can set to a partner or a sub-partner.

note

If you need certain scopes you do not have, send a request to our support team at [email protected] to get these scopes.

Access Control

Value	Description
accesscontrol.create	The partner can create Access Control objects.
accesscontrol.delete	The partner can delete Access Control objects.
accesscontrol.manage	The partner can create, read, update, and delete Access Control objects.
accesscontrol.read	The partner can read Access Control objects.
accesscontrol.update	The partner can update Access Control objects.

App

Value	Description
app.create	The partner can create Apps object actions.
app.delete	The partner can delete Apps object actions.
app.manage	The partner can create, read, update, and delete Apps object actions.
app.read	The partner can read Apps object actions.
app.read_descendant	The partner can view Apps object detailed records for the inherited partner.
app.update	The partner can update Apps object actions.

Batch

Value	Description
batch.create	The partner can create Batch actions.
batch.delete	The partner can delete Batch actions.
batch.manage	The partner can create, read, update, and delete Batch actions.
batch.read	The partner can read Batch actions.
batch.update	The partner can update Batch actions.

Calls

Value	Description
calls.create	The partner can create Call objects.
calls.delete	The partner can delete Call objects.
calls.manage	The partner can create, read, update, and delete Call objects.
calls.read	The partner can read Call objects.
calls.read_descendant	The partner can view Call object detailed records for the inherited partners.
calls.update	The partner can update Call objects.

Countries

Value	Description
countries.create	The partner can create Country objects.
countries.delete	The partner can delete Country objects.
countries.manage	The partner can create, read, update, and delete Country objects.
countries.read	The partner can read Country objects.
countries.update	The partner can update Country objects.

Endpoints

Value	Description
endpoints.create	The partner can create Endpoint objects.
endpoints.delete	The partner can delete Endpoint objects.
endpoints.manage	The partner can create, read, update, and delete Endpoint objects.
endpoints.manage_auth_required	The partner can set the auth_required attribute of the Endpoint object. This scope is not included in endpoints.manage and must be granted by CarrierX support. To request it, contact [email protected].
endpoints.read	The partner can read Endpoint objects.
endpoints.update	The partner can update Endpoint objects.

Invoices

Value	Description
invoices.adjustments	The partner can include the adjustments field when creating an Invoice object.
invoices.chargebacks	The partner can include the chargebacks field when creating an Invoice object.
invoices.create	The partner can create Invoice objects.
invoices.credits	The partner can include the credits field when creating an Invoice object.
invoices.delete	The partner can delete Invoice objects.
invoices.immediately_charges	The partner can include the immediate charges field when creating an Invoice object.
invoices.manage	The partner can create, read, update, and delete Invoice objects.
invoices.read	The partner can read Invoice objects.
invoices.refunds	The partner can include the refunds field when creating an Invoice object.
invoices.update	The partner can update Invoice objects.

Lookup

Value	Description
lookup.dids.allow_carrier	The partner can read phone number carriers.
lookup.dids.allow_cnam	The partner can read phone number CNAMs.
lookup.dids.read	The partner can read phone numbers.
lookup.ip_addresses.read	The partner can read IP addresses.
lookup.toll_free.allow_cic	The partner can read toll-free phone number CICs.
lookup.toll_free.allow_resporg	The partner can read toll-free phone number RespOrg IDs.
lookup.toll_free.read	The partner can read toll-free phone numbers.

OAuth

Value	Description
oauth.allow_token_scope_update	The partner can update token.scope field modification.
oauth.create	The partner can create OAuth Token objects.
oauth.delete	The partner can delete OAuth Token objects.
oauth.manage	The partner can create, read, update, and delete OAuth Token objects.
oauth.manage_all_tokens	If bearer auth is used, allow the partner to create, read, update, and delete tokens. Otherwise, allow the partner to create, read, update, and delete the current token.
oauth.read	The partner can read OAuth Token objects.
oauth.update	The partner can update OAuth Token objects.

Partners

Value	Description
partners.billing_method.create	The partner can create partner Billing Method objects.
partners.billing_method.delete	The partner can delete partner Billing Method objects.
partners.billing_method.manage	The partner can create, read, update, and delete Billing Method objects.
partners.billing_method.read	The partner can read partner Billing Method objects.
partners.billing_method.update	The partner can update partner Billing Method objects.
partners.create	The partner can create Partner objects.
partners.delete	The partner can delete Partner objects.
partners.manage	The partner can create, read, update, and delete Partner objects.
partners.read	The partner can read Partner objects.
partners.skip_email_verifications	The partner can change the skip_email_verification field when creating a new Partner object.
partners.skip_partner_review	The partner can change the skip_partner_review field when creating a new Partner object.
partners.update	The partner can update Partner objects.

Phone Number

Value	Description
phonenumber.create	The partner can create (rent) Phone Number objects.
phonenumber.delete	The partner can delete Phone Number objects.
phonenumber.emergency.manage	The partner can create, read, update, and delete DID Emergency objects.
phonenumber.emergency.read	The partner can read DID Emergency objects.
phonenumber.line_information.manage	The partner can create, read, update, and delete DID Line Information objects.
phonenumber.line_information.read	The partner can read DID Line Information objects.
phonenumber.manage	The partner can create, read, update, and delete Phone Number objects.
phonenumber.read	The partner can read Phone Number objects.
phonenumber.update	The partner can update Phone Number objects.

Porting

Value	Description
porting.create	The partner can create Port-In Request objects.
porting.manage	The partner can create, read, and update Port-In Request objects.
porting.read	The partner can read Port-In Request objects.
porting.update	The partner can update Port-In Request objects.

Push

Value	Description
push.create	The partner can create Push objects.
push.delete	The partner can delete Push objects.
push.manage	The partner can create, read, update, and delete Push objects.
push.read	The partner can read Push objects.
push.update	The partner can update Push objects.

Rating

Value	Description
rating.create	The partner can create Rating objects.
rating.delete	The partner can delete Rating objects.
rating.manage	The partner can create, read, update, and delete Rating objects.
rating.read	The partner can read Rating objects.
rating.update	The partner can update Rating objects.

Shortener

Value	Description
shortener.allow_domain_mode_proxypass	The partner can set the expired_mode and not_found_mode attributes for the Domain object to proxy_pass.
shortener.allow_domain_secure_required	The partner can set the secure attribute for the Domain object to required.
shortener.allow_link_mode_proxypass	The partner can set the mode attribute for the Link object to proxy_pass.
shortener.create	The partner can create Shortener objects.
shortener.delete	The partner can delete Shortener objects.
shortener.manage	The partner can create, read, update, and delete Shortener objects.
shortener.read	The partner can read Shortener objects.
shortener.update	The partner can update Shortener objects.

SMS

Value	Description
sms.create	The partner can create SMS objects.
sms.delete	The partner can delete SMS objects.
sms.manage	The partner can create, read, update, and delete SMS objects.
sms.read	The partner can read SMS objects.
sms.read_descendant	The partner can view SMS object detailed records for the inherited partners.
sms.update	The partner can update SMS objects.

Storage

Value	Description
storage.allow_container_publish_domain_update	The partner can modify the publish domain for the storage Container object.
storage.create	The partner can create Storage objects.
storage.delete	The partner can delete Storage objects.
storage.manage	The partner can create, read, update, and delete Storage objects.
storage.read	The partner can read Storage objects.
storage.update	The partner can update Storage objects.

Trunk Groups

Value	Description
trunk_groups.create	The partner can create Trunk Group objects.
trunk_groups.delete	The partner can delete Trunk Group objects.
trunk_groups.manage	The partner can create, read, update, and delete Trunk Group objects.
trunk_groups.read	The partner can read Trunk Group objects.
trunk_groups.trunks.allow_trunk_allow_forward_update	The partner can modify the allow_forward attribute of the Trunk object.
trunk_groups.trunks.create	The partner can create Trunk objects.
trunk_groups.trunks.delete	The partner can delete Trunk objects.
trunk_groups.trunks.manage	The partner can create, read, update, and delete Trunk objects.
trunk_groups.trunks.read	The partner can read Trunk objects.
trunk_groups.trunks.update	The partner can update Trunk objects.
trunk_groups.update	The partner can update Trunk Group objects.

Text-to-Speech (TTS)

Value	Description
tts.create	The partner can create TTS Text objects.
tts.manage	The partner can create TTS Text objects and read TTS Voice objects.
tts.read	The partner can read TTS Voice objects.

Verification

Value	Description
verification.create	The partner can create Verification objects.
verification.delete	The partner can delete Verification objects.
verification.manage	The partner can create, read, update, and delete Verification objects.
verification.read	The partner can read Verification objects.
verification.update	The partner can update Verification objects.