Generate a new API Token

POST 
/Accounts/:AccountSid/tokens

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

Request

Path Parameters

AccountSid uuidrequired

The unique identifier for the project you want to use to authenticate this request.

application/json

Body

required

name stringrequired

The name representing the project API token.

permissions string[]required

The permissions you would like to enable for this project API 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

application/json

Schema

Schema

id string

The ID of the created API Token.

name string

The name of the created API Token.

permissions string[]

The permissions enabled for this token.

token string

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

Example (from schema)

{
  "id": "ea14556a-984f-11ee-b9d1-0242ac120002",
  "name": "John Doe's Token",
  "permissions": [
    "calling",
    "fax",
    "messaging"
  ],
  "token": "PT037258e533e87ac63174ee136ed0798dc85d4f4f9e6d7191"
}

422

Unprocessable Entity. You may have specified invalid parameters.

application/json

Schema

Schema

type stringrequired
code stringrequired
message stringrequired
attribute string
url urirequired

Example (from schema)

{
  "code": 10003,
  "message": "Permissions contains invalid selections (valid permissions are: calling, chat, fax, management, messaging, numbers, pubsub, storage, tasking, and video)",
  "status": 400,
  "more_info": "https://developer.signalwire.com/cxml/overview/error-codes"
}

Loading...