Tracking Preferences: Leitura

Obter preferências

A escolha de rastreamento de aberturas e cliques de um destinatário. Uma consulta por endereço, sem varredura.

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

Requer o escopo privacy:read na sua API key.

i

preference é null quando o destinatário nunca abriu a página de preferências de tracking e você nunca definiu nada para ele.

Argumentos

  • emailstringobrigatório

    O endereço do destinatário. Maiúsculas não importam.

    ex.: "jane.doe@example.com"

Início rápido

import axios from 'axios';

const response = await axios.post(
  'https://g.sendcorex.com/v1/privacy',
  {
    commands: [
      {
        command: "get_preferences",
        args: {
          email: "jane.doe@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_preferences",
      "id": "0",
      "type": "SUCCESS",
      "took_ms": 6,
      "data": {
        "preference": {
          "email": "jane.doe@example.com",
          "track_opens": false,
          "track_clicks": true,
          "source": "page",
          "updated_at": "2026-10-24T07:20:12.031Z"
        }
      }
    }
  ]
}

Campos da resposta

  • preference

    A preferência abaixo, ou null quando não há nenhuma.

  • preference.email

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

  • preference.track_opens

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

  • preference.track_clicks

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

  • preference.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.

  • preference.updated_at

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

Como isso afeta seus envios

  • A recusa sempre vence

    Quando track_opens ou track_clicks é false, esse tracking fica fora do email mesmo que seu envio peça com "track_opens": true.

  • Nunca escolheu

    Quando o valor é null (ou o destinatário não tem nenhuma preferência), seu envio decide, exatamente como antes.

  • Precisa do nosso motor de descadastro

    As preferências são aplicadas a envios com "unsubscribe": true. É isso também que coloca o link de preferências no email.

  • Seu padrão

    Para regras de opt-in (por exemplo, na França), envie "track_opens": false e "track_clicks": false até o destinatário permitir, e leia a preferência com Get Many antes de enviar.

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.