Tracking Preferences: Rutas
Run Commands
El punto de entrada único para las preferencias de tracking. Envía de 1 a 20 comandos en una solicitud y obtén un resultado por comando.
https://g.sendcorex.com/v1/privacyEl mismo sobre que Logs, Contacts y Bounces & Complaints. Las páginas debajo de esta documentan cada comando.
Los errores se informan por comando. Un comando que falla no detiene a los demás, y el estado HTTP sigue siendo 200.
Parámetros del cuerpo
commandsobject[]obligatorioDe 1 a 20 comandos, ejecutados en orden. El cuerpo completo puede tener hasta 1 MB.
commands[].commandstringobligatorioget_preferences,get_many,get_history,list_changesoset_preferences.commands[].argsobjectopcionalLos argumentos del comando.
commands[].idstringopcionalTu propio identificador para el resultado. Por defecto, el índice (
"0","1"…).
Inicio rápido
import axios from 'axios';
const response = await axios.post(
'https://g.sendcorex.com/v1/privacy',
{
commands: [
{
command: "set_preferences",
id: "set",
args: {
email: "jane.doe@example.com",
track_opens: false
}
},
{
command: "get_preferences",
id: "get",
args: {
email: "jane.doe@example.com"
}
}
]
},
{ headers: { Authorization: process.env.SENDCOREX_API_KEY } },
);
for (const result of response.data.results) {
if (result.type !== 'SUCCESS') console.error(result.id, result.code, result.message);
else console.log(result.id, result.data);
}Respuesta
{
"type": "SUCCESS",
"results": [
{
"command": "set_preferences",
"id": "set",
"type": "SUCCESS",
"took_ms": 9,
"data": {
"changed": true,
"preference": {
"email": "jane.doe@example.com",
"track_opens": false,
"track_clicks": true,
"source": "api",
"updated_at": "2026-10-24T07:20:12.031Z"
}
}
},
{
"command": "get_preferences",
"id": "get",
"type": "SUCCESS",
"took_ms": 3,
"data": {
"preference": {
"email": "jane.doe@example.com",
"track_opens": false,
"track_clicks": true,
"source": "api",
"updated_at": "2026-10-24T07:20:12.031Z"
}
}
}
]
}Campos de la respuesta
typeSiempre
SUCCESScuando la solicitud en sí fue aceptada.results[].commandEl comando que produjo este resultado.
results[].idEl
idque enviaste, o el índice del comando.results[].typeSUCCESSoERROR.results[].took_msTiempo que tardó el comando dentro del servidor.
results[].dataLa salida del comando. Solo está presente cuando
typeesSUCCESS.results[].code / messageEl error. Solo está presente cuando
typeesERROR.
Autenticación
Usa la API key que creas en el dashboard, en Developers → API Keys.
AuthorizationEnvía
Authorization: <api key>oAuthorization: Bearer <api key>.privacy:readGet Preferences, Get Many, Get History y List Changes.
privacy:writeSet Preferences.
Tokens de mailboxEl token del webmail no funciona aquí. Se rechaza con
WRONG_CREDENTIAL_TYPE.IPs permitidasSi la key tiene una lista de IPs permitidas, las solicitudes desde otras IPs reciben
403 IP_NOT_ALLOWED.
Rate limits y caché
Los límites se aplican por IP + API key. Cuando te pasas, la solicitud se rechaza con HTTP 429 y un header Retry-After.
15 solicitudes / segundoPico de 15. Las respuestas servidas desde la caché también cuentan.
15 simultáneasComo máximo 15 solicitudes procesándose al mismo tiempo.
Caché de lectura: 1,5 sLa misma lectura dentro de 1,5 segundos devuelve el mismo resultado. Set Preferences nunca se guarda en caché.
Errores
Los errores a nivel HTTP devuelven type, code y message. Los errores marcados con CMD vuelven dentro del resultado del comando, con HTTP 200.
- 400
INVALID_JSONEl cuerpo no es {"commands":[...]} o pesa más de 1 MB.
- 400
INVALID_ARGSLa solicitud no tiene comandos o tiene más de 20.
- 401
MISSING_AUTH_HEADERNo se envió ningún header Authorization.
- 401
INVALID_API_KEYLa API key no existe, fue revocada o se desactivó en el dashboard.
- 401
API_KEY_EXPIREDLa API key superó la fecha de expiración definida en el dashboard.
- 401
WRONG_CREDENTIAL_TYPESe envió un token de mailbox. Esta API necesita una API key del dashboard.
- 403
IP_NOT_ALLOWEDLa solicitud vino de una IP que no está entre las IPs permitidas de la key.
- 403
ACCOUNT_BLOCKEDLa cuenta está bloqueada.
- 403
MISSING_SCOPELa key no tiene ni `privacy:read` ni `privacy:write`, así que no se puede ejecutar ningún comando.
- 429
RATE_LIMITEDMás de 15 solicitudes/s o 15 simultáneas para la misma IP + API key. Espera el número de segundos indicado en Retry-After.
- 503
AUTH_UNAVAILABLELa autenticación no está disponible temporalmente. Inténtalo de nuevo.
- CMD
UNKNOWN_COMMANDEl nombre del comando no existe.
- CMD
INTERNALError del servidor. El detalle solo se escribe en el log del servidor.