Ver .md

pipelines.import_sources

Listas ou segmentos de contatos para importar numa etapa. Até 50 listas (kind: "lists") ou segmentos (kind: "segments") por busca no nome (q), cada um com leadCount. Com ids, devolve só esses e recalcula a contagem dos segmentos na hora (passo de confirmação).

  • Endpoint: POST https://app.atomiks.com.br/api/v1/pipelines.import_sources (corpo JSON)
  • Quem pode chamar: membro da conta
  • Escopo da chave: crm:read
  • Grava dados: não
  • Pela chave de API: sim
  • Ferramenta MCP: pipelines_import_sources
  • Ficha em JSON: https://app.atomiks.com.br/api/v1/openapi.json (operationId pipelines.import_sources)

Entrada

CampoTipoObrigatórioNota
kind"lists" | "segments"sim
qstringnão
idsstring (uuid)[]não
JSON Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "kind": {
      "type": "string",
      "enum": [
        "lists",
        "segments"
      ]
    },
    "q": {
      "type": "string",
      "maxLength": 80
    },
    "ids": {
      "maxItems": 50,
      "type": "array",
      "items": {
        "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": [
    "kind"
  ]
}

Exemplo

curl -X POST https://app.atomiks.com.br/api/v1/pipelines.import_sources \
  -H "Authorization: Bearer $ATOMIKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"kind":"lists"}'

CLI:

node cli/atomiks.mjs pipelines.import_sources --json '{"kind":"lists"}'

MCP: ferramenta pipelines_import_sources com a mesma entrada.

Saída

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

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