Skip to main content
POST
Create an API key

Authorizations

Authorization
string
header
default:Bearer brew_your_api_key
required

Send your Brew API key as Authorization: Bearer brew_xxx.

Headers

Idempotency-Key
string

Optional idempotency key for safe retries. Reusing the same key with the same request body returns the original response for 24 hours.

Required string length: 1 - 100

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

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