contacts.export_create

Exportar contatos em CSV. Enfileira um CSV (UTF-8 com BOM, vírgula) com tudo que casa com filter/q (mesmo formato de contacts.list), nas colunas pedidas e na ordem dada. Até 100 000 contatos. Roda em segundo plano com as permissões de quem pediu: só sai o que a pessoa vê na lista. Acompanhe por contacts.export_get.

Colunas: ids de coluna da lista de contatos (me.view_prefs_get), cf:<id> e as só da exportação: id, subOrigin (anúncio/detalhe da origem), createdAt (DD/MM/AAAA HH:mm, Brasília) e, das vendas não canceladas, purchasesCount, productsCount, lifetimeValue, ticketAverage, lastBuyPrice, lastBuyDate (DD/MM/AAAA), purchasedOfferNames (produtos separados por ; ). Valores em reais como número puro com ponto (1234.50).

Cabeçalhos em snake_case, como no original: nome, email, telefone, documento, tags (separadas por ; ), origem, sub_origem, status_email, cidade, estado, endereco, criado_em, ultimo_valor, qtd_compras, qtd_produtos, ltv, ticket_medio, ultima_compra, ofertas_compradas, id; campo personalizado = rótulo em minúsculas com _ no lugar dos espaços.

notifyEmail (opcional): ao terminar, manda para esse endereço um e-mail com o link do arquivo, válido pelas 24 horas em que ele fica guardado.

Endpoint: POST https://app.atomiks.com.br/api/v1/contacts.export_create (corpo JSON)
Quem pode chamar: membro da conta
Escopo da chave: contacts:read
Grava dados: sim
Pela chave de API: sim
Ferramenta MCP: contacts_export_create
Ficha em JSON: https://app.atomiks.com.br/api/v1/openapi.json (operationId contacts.export_create)

Entrada

Campo	Tipo	Obrigatório
`filter`	object[]	não
`q`	string	não
`columns`	string[]	sim
`notifyEmail`	string (email)	não

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "filter": {
      "maxItems": 200,
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "maxLength": 64
          },
          "order": {
            "type": "integer",
            "minimum": 0,
            "maximum": 1000
          },
          "field": {
            "type": "string",
            "maxLength": 60
          },
          "operator": {
            "type": "string",
            "maxLength": 30
          },
          "negation": {
            "default": false,
            "type": "boolean"
          },
          "parentId": {
            "anyOf": [
              {
                "type": "string",
                "maxLength": 64
              },
              {
                "type": "null"
              }
            ]
          },
          "valueString": {
            "anyOf": [
              {
                "type": "string",
                "maxLength": 4000
              },
              {
                "type": "null"
              }
            ]
          },
          "valueNumber": {
            "type": [
              "number",
              "null"
            ]
          },
          "valueDate": {
            "anyOf": [
              {
                "type": "string",
                "maxLength": 40
              },
              {
                "type": "null"
              }
            ]
          },
          "valueBool": {
            "type": [
              "boolean",
              "null"
            ]
          },
          "valueUuid": {
            "anyOf": [
              {
                "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)$"
              },
              {
                "type": "null"
              }
            ]
          }
        },
        "required": [
          "field",
          "operator"
        ],
        "additionalProperties": false
      }
    },
    "q": {
      "type": "string",
      "maxLength": 100
    },
    "columns": {
      "minItems": 1,
      "maxItems": 80,
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "notifyEmail": {
      "type": "string",
      "maxLength": 254,
      "format": "email",
      "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
    }
  },
  "required": [
    "columns"
  ]
}

Exemplo

curl -X POST https://app.atomiks.com.br/api/v1/contacts.export_create \
  -H "Authorization: Bearer $ATOMIKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"columns":["contact","email","phone","tags","origin"]}'

CLI:

node cli/atomiks.mjs contacts.export_create --json '{"columns":["contact","email","phone","tags","origin"]}'

MCP: ferramenta contacts_export_create com a mesma entrada.

Saída

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

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