crm.list_add
Adicionar contato a uma lista. Idempotente. Devolve as listas do contato.
- Endpoint:
POST https://app.atomiks.com.br/api/v1/crm.list_add(corpo JSON) - Quem pode chamar: membro da conta
- Escopo da chave:
crm:write - Grava dados: sim
- Pela chave de API: sim
- Ferramenta MCP:
crm_list_add - Ficha em JSON:
https://app.atomiks.com.br/api/v1/openapi.json(operationIdcrm.list_add)
Entrada
| Campo | Tipo | Obrigatório | Nota |
|---|---|---|---|
contactId | string (uuid) | sim | |
listId | string (uuid) | sim |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"contactId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"listId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"required": [
"contactId",
"listId"
]
}Exemplo
curl -X POST https://app.atomiks.com.br/api/v1/crm.list_add \
-H "Authorization: Bearer $ATOMIKS_API_KEY" \
-H "Content-Type: application/json" \
-d '{"contactId":"00000000-0000-0000-0000-000000000000","listId":"00000000-0000-0000-0000-000000000000"}'CLI:
node cli/atomiks.mjs crm.list_add --json '{"contactId":"00000000-0000-0000-0000-000000000000","listId":"00000000-0000-0000-0000-000000000000"}'MCP: ferramenta crm_list_add com a mesma entrada.
Saída
Sucesso: {"data": ...} com o formato abaixo.
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"lists": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
}
},
"required": [
"id",
"name"
],
"additionalProperties": false
}
}
},
"required": [
"lists"
],
"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).