Tracking Preferences: Escrita
Definir preferências
Registre a escolha de tracking de um destinatário, por exemplo o consentimento que você coletou nos seus próprios formulários ou no seu CRM.
https://g.sendcorex.com/v1/privacycommand: set_preferencesRequer o escopo privacy:write na sua API key.
Envie só o que mudou: um campo que você deixa de fora mantém o valor atual. Enviar os mesmos valores de novo não muda nada e changed volta false.
As mudanças feitas aqui ficam registradas com source: "api" no histórico. Elas não disparam o webhook tracking_preferences_updated, então uma sincronização com o CRM nunca entra em loop.
Argumentos
emailstringobrigatórioO endereço do destinatário.
ex.:
"jane.doe@example.com"track_opensbooleanopcionaltruepermite o rastreamento de aberturas,falserecusa.ex.:
truetrack_clicksbooleanopcionaltruepermite o rastreamento de cliques,falserecusa.ex.:
true
Início rápido
import axios from 'axios';
const response = await axios.post(
'https://g.sendcorex.com/v1/privacy',
{
commands: [
{
command: "set_preferences",
args: {
email: "jane.doe@example.com",
track_opens: true,
track_clicks: true
}
}
]
},
{ 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": "set_preferences",
"id": "0",
"type": "SUCCESS",
"took_ms": 6,
"data": {
"changed": true,
"preference": {
"email": "jane.doe@example.com",
"track_opens": true,
"track_clicks": true,
"source": "api",
"updated_at": "2026-10-24T08:02:19.744Z"
}
}
}
]
}Campos da resposta
changedfalsequando o destinatário já tinha esses valores (nada foi gravado).preferenceO estado depois da chamada.
preference.emailO endereço do destinatário, em minúsculas.
preference.track_openstrueo destinatário permite o rastreamento de aberturas,falserecusou,nullnunca escolheu.preference.track_clickstrueo destinatário permite o rastreamento de cliques,falserecusou,nullnunca escolheu.preference.sourceQuem fez a mudança:
page(o destinatário, na página de preferências de tracking),api(você, com Set Preferences) oudashboard.preference.updated_atQuando a mudança foi feita. ISO 8601, UTC.
Como isso afeta seus envios
A recusa sempre venceQuando
track_opensoutrack_clickséfalse, esse tracking fica fora do email mesmo que seu envio peça com"track_opens": true.Nunca escolheuQuando o valor é
null(ou o destinatário não tem nenhuma preferência), seu envio decide, exatamente como antes.Precisa do nosso motor de descadastroAs preferências são aplicadas a envios com
"unsubscribe": true. É isso também que coloca o link de preferências no email.Seu padrãoPara regras de opt-in (por exemplo, na França), envie
"track_opens": falsee"track_clicks": falseaté 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.
- 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.