Skip to main content

Generate a new API Token

Generate an API Token for a project to be used to authenticate requests within the project.

Permissions

You must set the functions allowed by this API Token by selecting which types of requests this API Token is allowed to make. Valid options are: calling, chat, fax, management, messaging, numbers, pubsub, storage, tasking, and video

Request Body REQUIRED
name string REQUIRED

The name representing the API token.

permissions array REQUIRED

The permissions you would like to enable for this token. Valid permissions are calling, chat, fax, management, messaging, numbers, pubsub, storage, tasking, and video

subproject_id string

The unique identifier of the subproject you would like to create a token for. The subproject passed must be a child of the project used to authenticate the request.

Responses
200

OK

Schema OPTIONAL
id string OPTIONAL

The ID of the created API Token.

name string OPTIONAL

The name of the created API Token.

permissions array OPTIONAL

The permissions enabled for this token.

token string OPTIONAL

The API token that can be used along with the project ID for basic authentication

422

Unprocessable Entity. You may have specified invalid parameters.

Schema OPTIONAL
type string
code string
message string
attribute string OPTIONAL
url uri