Skip to main content
POST
Create an API key

Authorizations

__session
string
cookie
required

A signed-in Clerk browser session whose active organization role is exactly org:admin. API-key and OAuth actors are rejected.

Body

application/json
name
string
Required string length: 1 - 80
permissions
enum<string>[]
Minimum array length: 1
Available options:
all,
contacts,
emails,
automations,
transactional,
domains,
sends,
audiences,
brands
brandId
string
Required string length: 1 - 64
replacesKeyId
string
Required string length: 1 - 64

Response

The new key. Store key now — it is not shown again.

key
string
required
Minimum string length: 1
keyId
string
required
Minimum string length: 1
message
string
required
Minimum string length: 1