Sign in
Project Tokens

Update API token

Changes the name or enabled permission categories of an existing project API token. Use it to rotate a token's responsibilities 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.

The response contains the token's id, name, and permissions only. The token secret is returned once, by Create API token, and cannot be retrieved afterwards.

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

patch/api/project/tokens/{token_id}

Path parameters

token_idstring uuid required

Universal Unique Identifier.

The unique identifier of the token to update.

Request body

namestring

The name representing the API token.

permissionsProjectTokenPermission[]

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

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 API Token.

permissionsProjectTokenPermission[] required

The permissions enabled for this token.

Example response

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

Changes

Changed in 4 of the 161 revisions of this API.23

  • 45bac4fd93ab2See the full diff
    • ○

      the endpoint scheme security SignalWireBasicAuth was added to the API

      api-security-added

    • ○

      the endpoint scheme security SignalWirePersonalAccessTokenAuth was added to the API

      api-security-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 5ef081980be31See the full diff
    • ▲

      removed the required property from the response with the status

      response-required-property-removed

  • 1e3821e9fce41See the full diff
    • ○

      added the required property to the response with the status

      response-required-property-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • c8d5bfa3a2501See the full diff
    • ▲

      removed the required property from the response with the status

      response-required-property-removed

Of the 161 revisions, 3 have a changelog that could not be searched.