Tracking Preferences: Leitura

Obter várias

As preferências de até 100 destinatários em um comando. Use logo antes de um envio para decidir track_opens e track_clicks por destinatário.

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

Requer o escopo privacy:read na sua API key.

i

Só voltam os destinatários que têm uma preferência. Um endereço ausente da resposta nunca escolheu nada.

Argumentos

  • emailsstring[]obrigatório

    1 a 100 endereços de destinatários. Duplicados e endereços inválidos são ignorados.

    ex.: ["jane.doe@example.com", "marc.dupont@example.fr", "new.person@example.com"]

Início rápido

import axios from 'axios';

const response = await axios.post(
  'https://g.sendcorex.com/v1/privacy',
  {
    commands: [
      {
        command: "get_many",
        args: {
          emails: [
            "jane.doe@example.com",
            "marc.dupont@example.fr",
            "new.person@example.com"
          ]
        }
      }
    ]
  },
  { 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": "get_many",
      "id": "0",
      "type": "SUCCESS",
      "took_ms": 6,
      "data": {
        "preferences": [
          {
            "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"
          }
        ]
      }
    }
  ]
}

Campos da resposta

  • preferences

    Uma entrada por destinatário que tem uma preferência.

  • preferences[].email

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

  • preferences[].track_opens

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

  • preferences[].track_clicks

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

  • preferences[].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.

  • preferences[].updated_at

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

Antes de enviar

Leia o lote e depois envie para cada destinatário com o tracking que ele permite. Destinatários sem preferência seguem o seu padrão.

Node.js

const [r] = await call({ command: 'get_many', args: { emails: batch.map((x) => x.email) } });
const prefs = new Map(r.data.preferences.map((p) => [p.email, p]));

for (const x of batch) {
  const p = prefs.get(x.email.toLowerCase());
  await send({
    to: x.email,
    unsubscribe: true,
    track_opens: p?.track_opens === true,   // opt-in: only when allowed
    track_clicks: p?.track_clicks === true,
  });
}
i

Você não precisa fazer isso para respeitar uma recusa: com "unsubscribe": true, um destinatário que desligou o tracking nunca é rastreado. Isto é para regras de opt-in, em que o tracking precisa ficar desligado até o destinatário permitir.

A resposta

data

{
  "preferences": [
    {
      "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"
    }
  ]
}

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…

  • CMDINTERNAL

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