Sign in

v93

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

Create API key

Creates a company-scoped API key. The caller must have the api_keys:manage permission. Account-scoped keys select the target company with the x-company-id header; companyId in the JSON body is not a supported selector. The plain key is returned only once.

post/api-keys

Request body

namestring

Human-readable key name.

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

Permission preset to apply when scopes is omitted. Defaults to full_access. Full-access keys are stored with scopes set to null, meaning all current and future permissions.

scopesstring[]

Explicit permission scopes for the new key. Overrides preset when provided.

Response

API key created

successboolean
messagestring
instructionsobject

Example response

{
  "success": true
}