Skip to main content
PATCH
Update API key

Authorizations

Authorization
string
header
required

Access token issued by gtm.service.id. Its access_identity claim carries team_sid, actor_sid and actor_type, and that team scope is authoritative.

Team-SID
string
header
required

Team scope for tokens that do not carry one. Ignored when the token already names a team.

Path Parameters

sid
string
required

API key sid (id_ak_…).

Required string length: 18
Pattern: ^id_ak_

Body

application/json

Request body of update_api_key.

name
string
Required string length: 1 - 255
permissions
string[]

FULL replacement of the key's permission list.

Maximum string length: 128

Response

update success envelope.

success
enum<boolean>
required
Available options:
true
operation
enum<string>
required
Available options:
update
item
object
required
updated_fields
string[]
required
previous_values
object
required
meta
object
required