capi.stage_event_set

Definir o evento da Meta de uma etapa. Define (ou, com null, remove) o evento da API de Conversões enviado quando um card entra na etapa. Só etapas abertas; Ganho já manda Purchase pela venda. Eventos: LeadSubmitted, InitiateCheckout, AddToCart, ViewContent, OrderCreated, OrderShipped, OrderDelivered, OrderCanceled, OrderReturned, CartAbandoned, QualifiedLead, RatingProvided, ReviewProvided.

• Endpoint: POST https://app.atomiks.com.br/api/v1/capi.stage_event_set (corpo JSON)
• Quem pode chamar: administrador da conta
• Escopo da chave: conversions:write
• Grava dados: sim
• Pela chave de API: sim
• Ferramenta MCP: capi_stage_event_set
• Ficha em JSON: https://app.atomiks.com.br/api/v1/openapi.json (operationId capi.stage_event_set)

Entrada

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

Exemplo

curl -X POST https://app.atomiks.com.br/api/v1/capi.stage_event_set \
  -H "Authorization: Bearer $ATOMIKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"stageId":"00000000-0000-0000-0000-000000000000","eventName":"QualifiedLead"}'

CLI:

node cli/atomiks.mjs capi.stage_event_set --json '{"stageId":"00000000-0000-0000-0000-000000000000","eventName":"QualifiedLead"}'

MCP: ferramenta capi_stage_event_set com a mesma entrada.

Saída

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

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