For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Log inSign up
Support
  • Core
    • Overview
    • Authorization
    • Base URL
    • Data formats
    • Paging
    • Error codes
    • Permissions
  • Calling
  • Datasphere
  • Logs
  • Messaging
  • Phone Number Management
  • Platform
      • POSTCreate API token
      • DELDelete API token
      • PATCHUpdate API token
  • Resource Management
LogoLogoSignalWire Docs
Log inSign up
Support
PlatformProject Tokens

Update API token

|View as Markdown|Open in Claude|
PATCH
https://{your_space_name}.signalwire.com/api/project/tokens/:token_id
PATCH
/api/project/tokens/:token_id
$curl -X PATCH https://{your_space_name}.signalwire.com/api/project/tokens/token_id \
>     -H "Content-Type: application/json" \
>     -u "<project_id>:<api_token>" \
>     -d '{}'
1{
2  "id": "ea14556a-984f-11ee-b9d1-0242ac120002",
3  "name": "John Doe's Token",
4  "permissions": [
5    "calling",
6    "fax",
7    "messaging"
8  ],
9  "token": "PT037258e533e87ac63174ee136ed0798dc85d4f4f9e6d7191"
10}
Update an API Token's name or permissions. #### 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](/docs/platform/your-signalwire-api-space). #### 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
Was this page helpful?
Previous

Create PubSub token

Next
Built with

Update an API Token’s name or permissions.

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.

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

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

token_idstringRequiredformat: "uuid"
The unique identifier of the token to update.

Request

This endpoint expects an object.
namestringOptional
The name representing the API token.
permissionslist of enumsOptional
The permissions you would like to enable for this token. Valid permissions are calling, chat, datasphere, fax, management, messaging, numbers, pubsub, storage, tasking, and video

Response

The request has succeeded.
idstringformat: "uuid"
The ID of the created API Token.
namestring
The name of the created API Token.
permissionslist of enums
The permissions enabled for this token.
tokenstring
The API token that can be used along with the project ID for basic authentication

Errors

401
Unauthorized Error
404
Not Found Error
422
Unprocessable Entity Error
500
Internal Server Error

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)