PLATFORM APISubaccounts

Create a subaccount

View as Markdown

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
subaccount_namestringRequired
The name for the new subaccount. This should be a unique identifier that distinguishes it from other subaccounts within the main account.
user_emailstringOptional
This is the email address of the user you wish to invite to the subaccount. When this optional parameter is filled in, a "sign in" link will be generated and sent back in the response. The user can use this link to sign in and set up their account.
twilio_account_sidstringOptional
This is the Twilio SID of the subaccount.
twilio_auth_tokenstringOptional
This is the Twilio Token of the subaccount.
concurrencyintegerOptional
The maximum number of calls the subaccount can handle at the same time.
max_agentsinteger or nullOptional
The maximum number of agents the subaccount is allowed to create. Null if no limit is set.
max_minutesinteger or nullOptional
The maximum number of minutes allocated to this subaccount. Null if no limit is set.
max_workflow_runsinteger or nullOptional
The maximum number of workflow runs allocated to this subaccount. Null if no limit is set.
grant_permissionslist of enumsOptional

Permissions to grant to the subaccount. Duplicate values are not allowed, and any value also present in revoke_permissions is rejected by the API.

revoke_permissionslist of enumsOptional

Permissions to revoke from the subaccount. Duplicate values are not allowed, and any value also present in grant_permissions is rejected by the API.

Response

200
statusstringOptional
Whether the request was successful.
responseobjectOptional

Errors

400
Bad Request Error
401
Unauthorized Error
500
Internal Server Error
502
Bad Gateway Error