Skip to main content
POST
/
api-keys
{
  "id": 1,
  "api_key_id": "ak_1234567890abcdef",
  "name": "Minha API Key",
  "api_key": "rbak_1234567890abcdef1234567890abcdef",
  "permissions": [
    "read:emails",
    "write:emails"
  ],
  "is_active": true,
  "expires_at": "2025-12-31T23:59:59Z",
  "created_at": "2025-01-21T16:30:00Z",
  "user_id": "user_123",
  "domain_name": 1
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Modelo para criação de API Key

​
name
string
required

Nome da API Key

Required string length: 1 - 255
Example:

"Minha API Key"

​
permissions
enum<string>[]
required

Lista de permissões

Permissões disponíveis para API Keys

Available options:
read:emails,
write:emails,
read:webhooks,
write:webhooks,
read:stats,
read:suppressions,
write:suppressions,
admin
Example:
["read:emails", "write:emails"]
​
expires_at
string<date-time> | null

Data de expiração (opcional)

Example:

"2025-12-31T23:59:59Z"

Response

API Key criada com sucesso

Modelo de resposta para criação de API Key (inclui a chave real)

​
id
integer
required

ID da API Key

​
api_key_id
string
required

ID único da API Key

Example:

"ak_1234567890abcdef"

​
name
string
required

Nome da API Key

Example:

"Minha API Key"

​
api_key
string
required

Chave da API (mostrada apenas na criação)

Example:

"rbak_1234567890abcdef1234567890abcdef"

​
permissions
string[]
required

Lista de permissões

Example:
["read:emails", "write:emails"]
​
is_active
boolean
required

Status ativo

Example:

true

​
created_at
string<date-time>
required

Data de criação

Example:

"2025-01-21T16:30:00Z"

​
user_id
string
required

ID do usuário proprietário

Example:

"user_123"

​
expires_at
string<date-time> | null

Data de expiração

Example:

"2025-12-31T23:59:59Z"

​
domain_name
integer | null

ID do domínio

Example:

1