Skip to main content
POST
Create API Key
The plaintext key is returned exactly once, in the response to this call. Store it immediately in a secure secret manager - it cannot be retrieved later. If it is lost, revoke the key and create a new one.

Request

Headers

string
Strongly recommended. Same key returns the original result (including the plaintext secret) within 24 hours.

Body Parameters

string
required
Human-readable key name. 1 - 120 characters.
array
required
Array of scope strings. At least one is required. Examples: read:contacts, write:contacts, read:deals, write:deals, write:email, write:ai, admin:api_keys, admin:webhooks.
string
Optional description explaining the intended use of the key.
string
Optional override: standard (default), high, or unmetered. unmetered is only available on enterprise plans.
string
Optional ISO 8601 expiry timestamp. After this time, requests with the key return 401 invalid_key.

Response

object
Responses include X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset, and X-Request-ID.

Example Response

Errors