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 support@carrierx.com to get these scopes.

Global Settings

Access Control

Value	ID	Description
accesscontrol.create	61	The partner can create Access Control objects.
accesscontrol.delete	64	The partner can delete Access Control objects.
accesscontrol.manage	60	The partner can create, read, update, and delete Access Control objects.
accesscontrol.read	62	The partner can read Access Control objects.
accesscontrol.update	63	The partner can update Access Control objects.

App

Value	ID	Description
app.create	121	The partner can create Apps object actions.
app.delete	124	The partner can delete Apps object actions.
app.manage	120	The partner can create, read, update, and delete Apps object actions.
app.read	122	The partner can read Apps object actions.
app.read_descendant	327	The partner can view Apps object detailed records for the inherited partner.
app.update	123	The partner can update Apps object actions.

Batch

Value	ID	Description
batch.create	311	The partner can create Batch actions.
batch.delete	314	The partner can delete Batch actions.
batch.manage	310	The partner can create, read, update, and delete Batch actions.
batch.read	312	The partner can read Batch actions.
batch.update	313	The partner can update Batch actions.

Calls

Value	ID	Description
calls.create	111	The partner can create Call objects.
calls.delete	114	The partner can delete Call objects.
calls.manage	110	The partner can create, read, update, and delete Call objects.
calls.read	112	The partner can read Call objects.
calls.read_descendant	326	The partner can view Call object detailed records for the inherited partners.
calls.update	113	The partner can update Call objects.

Countries

Value	ID	Description
countries.create	201	The partner can create Country objects.
countries.delete	204	The partner can delete Country objects.
countries.manage	200	The partner can create, read, update, and delete Country objects.
countries.read	202	The partner can read Country objects.
countries.update	203	The partner can update Country objects.

Endpoints

Value	ID	Description
endpoints.create	31	The partner can create Endpoint objects.
endpoints.delete	34	The partner can delete Endpoint objects.
endpoints.manage	30	The partner can create, read, update, and delete Endpoint objects.
endpoints.read	32	The partner can read Endpoint objects.
endpoints.update	33	The partner can update Endpoint objects.

Invoices

Value	ID	Description
invoices.adjustments	139	The partner can include the adjustments field when creating an Invoice object.
invoices.chargebacks	137	The partner can include the chargebacks field when creating an Invoice object.
invoices.create	131	The partner can create Invoice objects.
invoices.credits	138	The partner can include the credits field when creating an Invoice object.
invoices.delete	134	The partner can delete Invoice objects.
invoices.immediately_charges	135	The partner can include the immediate charges field when creating an Invoice object.
invoices.manage	130	The partner can create, read, update, and delete Invoice objects.
invoices.read	132	The partner can read Invoice objects.
invoices.refunds	136	The partner can include the refunds field when creating an Invoice object.
invoices.update	133	The partner can update Invoice objects.

Lookup

Value	ID	Description
lookup.dids.allow_carrier	164	The partner can read phone number carriers.
lookup.dids.allow_cnam	162	The partner can read phone number CNAMs.
lookup.dids.allow_lrn	163	The partner can read phone number LRNs.
lookup.dids.read	161	The partner can read phone numbers.
lookup.ip_addresses.read	160	The partner can read IP addresses.

OAuth

Value	ID	Description
oauth.allow_token_scope_update	26	The partner can update token.scope field modification.
oauth.create	21	The partner can create OAuth Token objects.
oauth.delete	24	The partner can delete OAuth Token objects.
oauth.manage	20	The partner can create, read, update, and delete OAuth Token objects.
oauth.manage_all_tokens	25	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	22	The partner can read OAuth Token objects.
oauth.update	23	The partner can update OAuth Token objects.

Partners

Value	ID	Description
partners.billing_method.create	9	The partner can create partner Billing Method objects.
partners.billing_method.delete	12	The partner can delete partner Billing Method objects.
partners.billing_method.manage	8	The partner can create, read, update, and delete Billing Method objects.
partners.billing_method.read	10	The partner can read partner Billing Method objects.
partners.billing_method.update	11	The partner can update partner Billing Method objects.
partners.create	2	The partner can create Partner objects.
partners.delete	5	The partner can delete Partner objects.
partners.manage	1	The partner can create, read, update, and delete Partner objects.
partners.read	3	The partner can read Partner objects.
partners.skip_email_verifications	6	The partner can change the skip_email_verification field when creating a new Partner object.
partners.skip_partner_review	7	The partner can change the skip_partner_review field when creating a new Partner object.
partners.update	4	The partner can update Partner objects.

Phone Number

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

Push

Value	ID	Description
push.create	101	The partner can create Push objects.
push.delete	104	The partner can delete Push objects.
push.manage	100	The partner can create, read, update, and delete Push objects.
push.read	102	The partner can read Push objects.
push.update	103	The partner can update Push objects.

Rating

Value	ID	Description
rating.create	151	The partner can create Rating objects.
rating.delete	154	The partner can delete Rating objects.
rating.manage	150	The partner can create, read, update, and delete Rating objects.
rating.read	152	The partner can read Rating objects.
rating.update	153	The partner can update Rating objects.

Shortener

Value	ID	Description
shortener.allow_domain_mode_proxypass	196	The partner can set the expired_mode and not_found_mode attributes for the Domain object to proxy_pass.
shortener.allow_domain_secure_required	195	The partner can set the secure attribute for the Domain object to required.
shortener.allow_link_mode_proxypass	197	The partner can set the mode attribute for the Link object to proxy_pass.
shortener.create	191	The partner can create Shortener objects.
shortener.delete	194	The partner can delete Shortener objects.
shortener.manage	190	The partner can create, read, update, and delete Shortener objects.
shortener.read	192	The partner can read Shortener objects.
shortener.update	193	The partner can update Shortener objects.

SMS

Value	ID	Description
sms.create	91	The partner can create SMS objects.
sms.delete	94	The partner can delete SMS objects.
sms.manage	90	The partner can create, read, update, and delete SMS objects.
sms.read	92	The partner can read SMS objects.
sms.read_descendant	325	The partner can view SMS object detailed records for the inherited partners.
sms.update	93	The partner can update SMS objects.

Storage

Value	ID	Description
storage.allow_container_publish_domain_update	185	The partner can modify the publish domain for the storage Container object.
storage.create	181	The partner can create Storage objects.
storage.delete	184	The partner can delete Storage objects.
storage.manage	180	The partner can create, read, update, and delete Storage objects.
storage.read	182	The partner can read Storage objects.
storage.update	183	The partner can update Storage objects.

Trunk Groups

Value	ID	Description
trunk_groups.create	41	The partner can create Trunk Group objects.
trunk_groups.delete	44	The partner can delete Trunk Group objects.
trunk_groups.manage	40	The partner can create, read, update, and delete Trunk Group objects.
trunk_groups.read	42	The partner can read Trunk Group objects.
trunk_groups.trunks.allow_trunk_allow_forward_update	50	The partner can modify the allow_forward attribute of the Trunk object.
trunk_groups.trunks.create	46	The partner can create Trunk objects.
trunk_groups.trunks.delete	49	The partner can delete Trunk objects.
trunk_groups.trunks.manage	45	The partner can create, read, update, and delete Trunk objects.
trunk_groups.trunks.read	47	The partner can read Trunk objects.
trunk_groups.trunks.update	48	The partner can update Trunk objects.
trunk_groups.update	43	The partner can update Trunk Group objects.

Text-to-Speech (TTS)

Value	ID	Description
tts.create	331	The partner can create TTS Text objects.
tts.manage	330	The partner can create TTS Text objects and read TTS Voice objects.
tts.read	332	The partner can read TTS Voice objects.

Verification

Value	ID	Description
verification.create	171	The partner can create Verification objects.
verification.delete	174	The partner can delete Verification objects.
verification.manage	170	The partner can create, read, update, and delete Verification objects.
verification.read	172	The partner can read Verification objects.
verification.update	173	The partner can update Verification objects.