Update API token
Changed onChanges the name or enabled permission categories of an existing project API token. Use it to change a token's permissions without replacing its identifier; remove permissions that the token's server-side caller no longer needs. For the account-scoped Compatibility API route, use Update an API Token.
Updating a token does not change its value. The response omits the token secret, which is returned only by Create API token and Regenerate API token.
Permissions
With a project API token, the token must have the following scope(s) enabled to make a successful request: Management.
With a Personal access token there are no scopes. The token holder must be an owner or admin of the space, and the request reaches only the projects the holder is enabled for, plus their subprojects.
Learn more about API scopes.
Token Permissions
You can modify 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, datasphere, fax, management, messaging, numbers, pubsub, storage, tasking, and video
Request
- Base URLhttps://{Your_Space_Name}.signalwire.com
- URLhttps://{Your_Space_Name}.signalwire.com/api/project/tokens/{token_id}
- Auth
- HTTP basic
- or HTTP basic
Path parameters
Universal Unique Identifier.
The unique identifier of the token to update.
Request body
Example request
{
"name": "John Doe's Token",
"permissions": [
"calling",
"fax",
"messaging"
]
}Response
The request has succeeded.
Example response
{
"name": "John Doe's Token",
"permissions": [
"calling",
"fax",
"messaging"
],
"last_used_at": "2024-05-06T12:20:00Z"
}Changes
- breaking
response property
namelist-of-types was widened by adding typesnullto media typeapplication/jsonof response200 - info
added the required property
to the response with the status - info
added the required property
to the response with the status
- breaking
- info
the endpoint scheme security
SignalWireBasicAuthwas added to the API - info
the endpoint scheme security
SignalWirePersonalAccessTokenAuthwas added to the API
- info
Some revisions have not been checked yet.