Skip to main content
POST
Create a new API key

Authorizations

X-API-Key
string
header
required

Body

application/json
name
string
required

API key name (max 80 characters)

expiresAt
string<date-time>

Optional expiry date

scopes
enum<string>[]

Scopes for the new key. Leave out for a full-access key. <resource>:write includes <resource>:read.

Available options:
accounts:read,
accounts:write,
posts:read,
posts:write,
media:read,
media:write,
analytics:read,
inbox:read,
inbox:write,
ai:read,
ai:write,
biolinks:read,
biolinks:write,
teams:read,
teams:write,
settings:read,
settings:write,
webhooks:read,
webhooks:write,
support:read,
support:write,
templates:read,
whatsapp:read,
whatsapp:write
Example:

Response

201 - application/json

API key created

id
string

Key UUID

name
string

Key name

keyPrefix
string

Key prefix for identification

scopes
string[] | null

Scopes of the key; null means full access

fullKey
string

Full API key (shown only once)

createdAt
string<date-time>