Ver .md

segmentation.tag_leads

Contatos que receberam a tag. Aba "Quem recebeu": os contatos que receberam a tag, do mais recente (appliedAt) ao mais antigo, só os que quem pede vê. total conta todos que a têm.

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

Entrada

CampoTipoObrigatórioNota
idstring (uuid)sim
perPageintegernão
JSON Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "id": {
      "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)$"
    },
    "perPage": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    }
  },
  "required": [
    "id"
  ]
}

Exemplo

curl -X POST https://app.atomiks.com.br/api/v1/segmentation.tag_leads \
  -H "Authorization: Bearer $ATOMIKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"id":"00000000-0000-0000-0000-000000000000"}'

CLI:

node cli/atomiks.mjs segmentation.tag_leads --json '{"id":"00000000-0000-0000-0000-000000000000"}'

MCP: ferramenta segmentation_tag_leads com a mesma entrada.

Saída

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

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