Tracking Preferences: Leitura
Obter histórico
Cada mudança de um destinatário, da mais nova para a mais antiga: o que escolheu, quando e quem mudou. Seu registro de consentimento para auditorias.
https://g.sendcorex.com/v1/privacycommand: get_historyRequer o escopo privacy:read na sua API key.
O histórico é mantido enquanto a preferência existir. Cada entrada é o estado completo depois daquela mudança.
Argumentos
emailstringobrigatórioO endereço do destinatário.
ex.:
"jane.doe@example.com"limitnumberopcionalQuantas mudanças, de 1 a 500. Padrão: 50.
ex.:
50
Início rápido
import axios from 'axios';
const response = await axios.post(
'https://g.sendcorex.com/v1/privacy',
{
commands: [
{
command: "get_history",
args: {
email: "jane.doe@example.com",
limit: 50
}
}
]
},
{ 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_history",
"id": "0",
"type": "SUCCESS",
"took_ms": 6,
"data": {
"history": [
{
"email": "jane.doe@example.com",
"track_opens": false,
"track_clicks": true,
"source": "page",
"updated_at": "2026-10-24T07:20:12.031Z"
},
{
"email": "jane.doe@example.com",
"track_opens": true,
"track_clicks": true,
"source": "api",
"updated_at": "2026-09-02T10:05:41.220Z"
}
]
}
}
]
}Campos da resposta
historyAs mudanças, da mais nova para a mais antiga. Vazio quando o destinatário nunca teve uma preferência.
history[].emailO endereço do destinatário, em minúsculas.
history[].track_openstrueo destinatário permite o rastreamento de aberturas,falserecusou,nullnunca escolheu.history[].track_clickstrueo destinatário permite o rastreamento de cliques,falserecusou,nullnunca escolheu.history[].sourceQuem fez a mudança:
page(o destinatário, na página de preferências de tracking),api(você, com Set Preferences) oudashboard.history[].updated_atQuando a mudança foi feita. ISO 8601, UTC.
Erros
Erros no nível HTTP retornam type, code e message. Erros marcados com CMD voltam dentro do resultado do comando, com HTTP 200.
- 401
INVALID_API_KEYA API key não existe, foi revogada ou foi desativada no dashboard.
- 429
RATE_LIMITEDMais de 15 requisições/s ou 15 simultâneas para o mesmo IP + API key. Aguarde o número de segundos em Retry-After.
- CMD
MISSING_SCOPEA API key não tem o escopo deste comando (`privacy:read` para ler, `privacy:write` para alterar).
- CMD
INVALID_ARGSUm argumento é inválido: `email` ausente ou malformado, mais de 100 `emails`, `track_opens` que não é `true`/`false`, limit fora do intervalo…
- CMD
INTERNALErro no servidor. O detalhe só é gravado no log do servidor.