Skip to navigation
REST ClientProject

update

View as MarkdownOpen in Claude

tokens.update

Update an existing API token. Uses PATCH.

Path parameters

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

Request

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

idstringRequiredformat: "uuid"
The ID of the API Token.
namestring or nullRequired
The name of the API Token. `null` when the token has no name.
permissionslist of enumsRequired
The permissions enabled for this token.
last_used_atdatetime or nullRequired
The date and time the token last authenticated a request. `null` if it never has.
revoked_atdatetime or nullRequired
The date and time SignalWire revoked the token's value, for example after detecting that the value was exposed. `null` if it has not been revoked. A revoked token keeps its `id` and still appears in [List API tokens](/docs/apis/rest/project-tokens/list-tokens), but its previous value no longer authenticates and no replacement value has been issued to you. To get a working value, [regenerate the token](/docs/apis/rest/project-tokens/regenerate-token), which also clears `revoked_at`.

Response Example

Response
{
  "id": "ea14556a-984f-11ee-b9d1-0242ac120002",
  "name": "John Doe's Token",
  "permissions": [
    "calling",
    "fax",
    "messaging"
  ],
  "last_used_at": "2024-05-06T12:20:00Z",
  "revoked_at": null
}

Example

import { RestClient } from "@signalwire/sdk";
const client = new RestClient({
  project: "your-project-id",
  token: "your-api-token",
  host: "your-space.signalwire.com"
});
await client.project.tokens.update("token-id", { name: "renamed-token" });