api_keys.create
Criar chave de API. Cria uma chave de API com escopos. A chave completa (key) aparece só nesta resposta; guarde-a. Escopos admin:* só para super-admin.
- Endpoint:
POST https://app.atomiks.com.br/api/v1/api_keys.create(corpo JSON) - Quem pode chamar: administrador da conta
- Escopo da chave: nenhum (qualquer chave serve)
- Grava dados: sim
- Pela chave de API: não (só pela interface)
- Ferramenta MCP: não
- Ficha em JSON:
https://app.atomiks.com.br/api/v1/openapi.json(operationIdapi_keys.create)
Entrada
| Campo | Tipo | Obrigatório | Nota |
|---|---|---|---|
name | string | sim | |
scopes | "account:read" | "account:write" | "team:read" | "team:write" | "activity:read" | "admin:read" | "admin:write" | "channels:read" | "channels:write" | "contacts:read" | "ads:read" | "ads:write" | "messages:read" | "messages:send" | "messages:manage" | "crm:read" | "crm:write" | "conversions:read" | "conversions:write" | "automations:read" | "automations:write" | "marketing:read" | "marketing:write"[] | sim |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 1,
"maxLength": 80
},
"scopes": {
"minItems": 1,
"type": "array",
"items": {
"type": "string",
"enum": [
"account:read",
"account:write",
"team:read",
"team:write",
"activity:read",
"admin:read",
"admin:write",
"channels:read",
"channels:write",
"contacts:read",
"ads:read",
"ads:write",
"messages:read",
"messages:send",
"messages:manage",
"crm:read",
"crm:write",
"conversions:read",
"conversions:write",
"automations:read",
"automations:write",
"marketing:read",
"marketing:write"
]
}
}
},
"required": [
"name",
"scopes"
]
}Exemplo
curl -X POST https://app.atomiks.com.br/api/v1/api_keys.create \
-H "Authorization: Bearer $ATOMIKS_API_KEY" \
-H "Content-Type: application/json" \
-d '{"name":"Integração","scopes":["team:read"]}'Saída
Sucesso: {"data": ...} com o formato abaixo.
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"id": {
"type": "string"
},
"key": {
"type": "string"
}
},
"required": [
"id",
"key"
],
"additionalProperties": false
}Erros
{"error": {"code", "message", "requestId"}}. Códigos: invalid_input (400), unauthorized (401), forbidden / account_pending / scope_missing (403), not_found (404), limit_reached (409), internal (500).