Pular para o conteúdo principal
POST
Criar uma nova chave de API

Autorizações

X-API-Key
string
header
obrigatório

Corpo

application/json
name
string
obrigatório

Nome da chave de API (máx. 80 caracteres)

expiresAt
string<date-time>

Data de expiração opcional

scopes
enum<string>[]

Scopes da nova chave. Omita para uma chave de acesso total. <resource>:write inclui <resource>:read.

Opções disponíveis:
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
Exemplo:

Resposta

201 - application/json

Chave de API criada

id
string

UUID da chave

name
string

Nome da chave

keyPrefix
string

Prefixo da chave para identificação

scopes
string[] | null

Scopes da chave; null significa acesso total

fullKey
string

Chave de API completa (exibida apenas uma vez)

createdAt
string<date-time>