Skip to main content
PATCH
Update API Key
Rename a company-scoped API key, replace its permissions, or both. The caller must have the api_keys:manage permission. The key value does not change. Added permissions apply on the next retry, so use this instead of issuing a replacement key when a call fails with a missing-scope error. Removed permissions may remain usable for up to five minutes while API caches expire.
preset and scopes replace the whole permission selection rather than merging into it. Call List API Keys first and send the full set you want.

Request

string
required
Exact API key ID returned by the list API keys endpoint.
string
New human-readable key name.
string
Replacement permission preset: full_access, read_only, agent_safe, ai_drafting, data_ingest_safe, data_ingest_automations, transactional_sender, or marketing_sender.
string[]
Replacement explicit permission scopes. Overrides preset when provided.
Provide at least one of name, preset, or scopes.

Responses