Sign in

v101

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-08235133843.7 KB
Account

Update API key

Renames a company-scoped API key and/or replaces its permissions in place. The caller must have the api_keys:manage permission. The key value is unchanged. Added permissions apply on the next retry; removed permissions may remain usable for up to five minutes while API caches expire. preset and scopes replace the whole selection rather than merging into it. The response contains non-secret metadata only.

patch/api-keys/{apiKeyId}

Path parameters

apiKeyIdstring required

Exact API key ID returned by the list API keys endpoint.

Request body

namestring

New human-readable key name.

preset'full_access' | 'read_only' | 'agent_safe' | 'ai_drafting' | 'data_ingest_safe' | 'data_ingest_automations' | 'transactional_sender' | 'marketing_sender'

Replacement permission preset. Full-access keys are stored with scopes set to null, meaning all current and future permissions.

scopesstring[]

Replacement explicit permission scopes. Overrides preset when provided.

Response

API key updated

successboolean required
messagestring required

Example response

{
  "success": true,
  "message": "API key permissions updated. Added permissions apply on the next retry; removed permissions may take up to five minutes to expire across API instances."
}