Skip to main content
PATCH

Authorizations

Authorization
string
header
required

Pass the API key in the Authorization header, You need to put Token keyword before the API key. e.g. 'Authorization: Token '

Query Parameters

projectId
string<uuid>
required

ID of the project. With an API key, it must be the key's own project.

Example:

"fbb9e8b2-2dbb-40f9-a051-9404624e3247"

Body

application/json
apiKeyId
string
required

The key's id or ref (one of your keys).

Example:

"key_9f2c4e1a7b3d5f6081a2c3d4e5f60718"

name
string

New name, unique in the project.

Minimum string length: 1
Example:

"Call center server"

allowedDomains
string[]

Hostnames the key may be used from, such as example.com or *.example.com (any subdomain). No protocol, at most 255 characters each. Empty: any domain. A public key checks them against the Origin header. Replaces the saved list; [] removes the limit.

Required string length: 1 - 255
Example:
agentIds
string<uuid>[]

Agents the key may create call tokens for (agents of this project). Empty or omitted: every agent. Replaces the saved list.

Example:

Response

Successful response

success
boolean
Example:

true

message
string
Example:

"success"

data
object

An API key. Never contains a secret key's value, except secret in the response that creates or rotates it.