Tracking Preferences: Leitura

Listar alterações

Toda mudança de preferência da sua conta, da mais antiga para a mais nova, com um cursor. Mantenha seu CRM sincronizado sem perder nenhuma.

POSThttps://g.sendcorex.com/v1/privacycommand: list_changes
i

Requer o escopo privacy:read na sua API key.

i

Guarde o next_cursor e envie-o na próxima chamada. Ele sempre volta, mesmo quando nada mudou.

i

As mudanças aparecem cerca de 5 segundos depois de acontecerem, e o feed guarda os últimos 90 dias.

Argumentos

  • cursorstringopcional

    O next_cursor da chamada anterior. Sem ele, você começa no início dos 90 dias.

    ex.: "ZjowMDAwMDAwMDgzOjE3NjEyOTA0MTIwMzE6amFuZS5kb2VAZXhhbXBsZS5jb20"

  • limitnumberopcional

    Mudanças por chamada, de 1 a 1000. Padrão: 100.

    ex.: 100

Início rápido

import axios from 'axios';

const response = await axios.post(
  'https://g.sendcorex.com/v1/privacy',
  {
    commands: [
      {
        command: "list_changes",
        args: {
          cursor: "ZjowMDAwMDAwMDgzOjE3NjEyOTA0MTIwMzE6amFuZS5kb2VAZXhhbXBsZS5jb20",
          limit: 100
        }
      }
    ]
  },
  { headers: { Authorization: process.env.SENDCOREX_API_KEY } },
);

const [result] = response.data.results;
if (result.type !== 'SUCCESS') throw new Error(`${result.code}: ${result.message}`);
console.log(result.data);

Resposta

{
  "type": "SUCCESS",
  "results": [
    {
      "command": "list_changes",
      "id": "0",
      "type": "SUCCESS",
      "took_ms": 6,
      "data": {
        "changes": [
          {
            "email": "jane.doe@example.com",
            "track_opens": false,
            "track_clicks": true,
            "source": "page",
            "updated_at": "2026-10-24T07:20:12.031Z"
          },
          {
            "email": "marc.dupont@example.fr",
            "track_opens": false,
            "track_clicks": false,
            "source": "api",
            "updated_at": "2026-10-24T07:41:55.508Z"
          }
        ],
        "next_cursor": "ZjowMDAwMDAwMDgzOjE3NjEyOTA0MTIwMzE6amFuZS5kb2VAZXhhbXBsZS5jb20",
        "has_more": false
      }
    }
  ]
}

Campos da resposta

  • changes

    As mudanças desta chamada, da mais antiga para a mais nova. Cada uma é o estado completo do destinatário depois da mudança.

  • next_cursor

    Envie-o como cursor na próxima chamada.

  • has_more

    true quando já há mais mudanças esperando: chame de novo na hora.

  • changes[].email

    O endereço do destinatário, em minúsculas.

  • changes[].track_opens

    true o destinatário permite o rastreamento de aberturas, false recusou, null nunca escolheu.

  • changes[].track_clicks

    true o destinatário permite o rastreamento de cliques, false recusou, null nunca escolheu.

  • changes[].source

    Quem fez a mudança: page (o destinatário, na página de preferências de tracking), api (você, com Set Preferences) ou dashboard.

  • changes[].updated_at

    Quando a mudança foi feita. ISO 8601, UTC.

Sincronize com seu CRM

Guarde o cursor em algum lugar que sobreviva a um restart. A cada ciclo, leia até has_more ser false e grave cada mudança no contato do seu CRM (Salesforce, HubSpot…).

Node.js

let cursor = await loadCursor(); // null the first time

async function sync() {
  let more = true;
  while (more) {
    const [r] = await call({ command: 'list_changes', args: cursor ? { cursor, limit: 500 } : { limit: 500 } });
    for (const c of r.data.changes) {
      if (c.source === 'api') continue; // you made this change yourself
      await crm.updateContact(c.email, { trackOpens: c.track_opens, trackClicks: c.track_clicks, consentAt: c.updated_at });
    }
    cursor = r.data.next_cursor;
    await saveCursor(cursor);
    more = r.data.has_more;
  }
}

setInterval(sync, 60_000);
i

Prefere push? O webhook tracking_preferences_updated envia cada mudança feita na página no momento em que acontece. Use este comando como rede de segurança.

Erros

Erros no nível HTTP retornam type, code e message. Erros marcados com CMD voltam dentro do resultado do comando, com HTTP 200.

  • 401INVALID_API_KEY

    A API key não existe, foi revogada ou foi desativada no dashboard.

  • 429RATE_LIMITED

    Mais de 15 requisições/s ou 15 simultâneas para o mesmo IP + API key. Aguarde o número de segundos em Retry-After.

  • CMDMISSING_SCOPE

    A API key não tem o escopo deste comando (`privacy:read` para ler, `privacy:write` para alterar).

  • CMDINVALID_ARGS

    Um argumento é inválido: `email` ausente ou malformado, mais de 100 `emails`, `track_opens` que não é `true`/`false`, limit fora do intervalo…

  • CMDINVALID_CURSOR

    O cursor está malformado ou veio de outra conta. Comece de novo sem cursor.

  • CMDINTERNAL

    Erro no servidor. O detalhe só é gravado no log do servidor.