Skip to navigation
Compatibility REST APITokens

Update an API Token

View as MarkdownOpen in Claude

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.

The response contains the token’s id, name, and permissions only. The token secret is returned once, by Generate a new API Token, and cannot be retrieved afterwards.

Updating a token does not rotate or reissue its secret. The existing secret keeps working after the update.

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.

Authentication

AuthorizationBasic

SignalWire Basic Authentication using Project ID and API Token.

The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password.

Example:

Authorization: Basic base64(project_id:token)

Path parameters

AccountSidstringRequiredformat: "uuid"
The unique identifier for the project you want to use to authenticate this request.
token_idstringRequiredformat: "uuid"
The unique identifier of the project API token.

Request

This endpoint expects an object.
namestringOptional>=1 character
The name representing the project API token.
permissionslist of stringsOptional

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.

Response

The request has succeeded.
idstringformat: "uuid"
The unique identifier of the API Token.
namestring>=1 character
The name of the API Token.
permissionslist of strings
The permissions enabled for this token.

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
422
Unprocessable Entity Error