sales.utms

Rastreamento (UTMs) da venda. UTMs, src e sck da venda. Vendas do Atomiks usam a origem de anúncio do contato; pedidos de plataforma trazem os parâmetros que a plataforma enviou.

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

Entrada

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200
    }
  },
  "required": [
    "id"
  ]
}

Exemplo

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

CLI:

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

MCP: ferramenta sales_utms com a mesma entrada.

Saída

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

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "utms": {
      "type": "object",
      "properties": {
        "utmSource": {
          "type": [
            "string",
            "null"
          ]
        },
        "utmMedium": {
          "type": [
            "string",
            "null"
          ]
        },
        "utmCampaign": {
          "type": [
            "string",
            "null"
          ]
        },
        "utmContent": {
          "type": [
            "string",
            "null"
          ]
        },
        "utmTerm": {
          "type": [
            "string",
            "null"
          ]
        },
        "src": {
          "type": [
            "string",
            "null"
          ]
        },
        "sck": {
          "type": [
            "string",
            "null"
          ]
        }
      },
      "required": [
        "utmSource",
        "utmMedium",
        "utmCampaign",
        "utmContent",
        "utmTerm",
        "src",
        "sck"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "utms"
  ],
  "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).