external_recovery.create_list

Criar lista de contatos para recuperação. Cria a lista manual name (se já existe uma com esse nome, usa a existente) e põe nela os contatos dos itens dos status escolhidos (statuses). Itens sem contato vinculado ficam de fora e são contados em withoutContact.

• Endpoint: POST https://app.atomiks.com.br/api/v1/external_recovery.create_list (corpo JSON)
• Quem pode chamar: membro da conta
• Escopo da chave: crm:write
• Grava dados: sim
• Pela chave de API: sim
• Ferramenta MCP: external_recovery_create_list
• Ficha em JSON: https://app.atomiks.com.br/api/v1/openapi.json (operationId external_recovery.create_list)

Entrada

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 80
    },
    "statuses": {
      "minItems": 1,
      "maxItems": 5,
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "failed",
          "chargeback",
          "refunded",
          "canceled",
          "cartAbandonment"
        ]
      }
    }
  },
  "required": [
    "name",
    "statuses"
  ]
}

Exemplo

curl -X POST https://app.atomiks.com.br/api/v1/external_recovery.create_list \
  -H "Authorization: Bearer $ATOMIKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Recuperação externa","statuses":["failed","cartAbandonment"]}'

CLI:

node cli/atomiks.mjs external_recovery.create_list --json '{"name":"Recuperação externa","statuses":["failed","cartAbandonment"]}'

MCP: ferramenta external_recovery_create_list com a mesma entrada.

Saída

Sucesso: {"data": ...} com o formato abaixo.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "added": {
      "type": "number"
    },
    "withoutContact": {
      "type": "number"
    }
  },
  "required": [
    "id",
    "name",
    "added",
    "withoutContact"
  ],
  "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).