Tokens

Update an API Token

Changes the name or enabled permission categories of an existing project API token. For the SignalWire REST API's project route, use Update API token.

Permissions

The API token used to authenticate must have the following scope(s) enabled to make a successful request: Management.

Learn more about API scopes.

patch/Accounts/{AccountSid}/tokens/{token_id}

Path parameters

AccountSidstring uuid required

Universal Unique Identifier.

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

token_idstring uuid required

Universal Unique Identifier.

The unique identifier of the project API token.

Request body

namestring

The name representing the project API token.

permissionsstring[]

The permissions you would like to enable for this project API token. If not provided, existing permissions are kept. Valid permissions are: calling, chat, datasphere, fax, management, messaging, numbers, pubsub, storage, tasking, and video.

Example request

{
  "name": "John Doe's Token",
  "permissions": [
    "calling",
    "fax",
    "messaging"
  ]
}

Response

The request has succeeded.

idstring uuid required

Universal Unique Identifier.

namestring required

The name of the created API Token.

permissionsstring[] required

The permissions enabled for this token.

tokenstring required

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

Example response

{
  "name": "John Doe's Token",
  "permissions": [
    "calling",
    "fax",
    "messaging"
  ],
  "token": "PT037258e533e87ac63174ee136ed0798dc85d4f4f9e6d7191"
}