Ver .md

capi.settings_get

Ver configuração das conversões. Configuração da API de Conversões da Meta da conta: ligada, enviar Purchase a cada venda, enviar LeadSubmitted no primeiro clique de anúncio, página (só dígitos, usada quando não há clique de anúncio) e código de teste do Gerenciador de Eventos. Sem registro, devolve os padrões (desligada).

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

Entrada

Sem campos: envie {}.

JSON Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {}
}

Exemplo

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

CLI:

node cli/atomiks.mjs capi.settings_get --json '{}'

MCP: ferramenta capi_settings_get com a mesma entrada.

Saída

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

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