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.

POSThttps://g.sendcorex.com/v1/privacy
i

El mismo sobre que Logs, Contacts y Bounces & Complaints. Las páginas debajo de esta documentan cada comando.

i

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[]obligatorio

    De 1 a 20 comandos, ejecutados en orden. El cuerpo completo puede tener hasta 1 MB.

  • commands[].commandstringobligatorio

    get_preferences, get_many, get_history, list_changes o set_preferences.

  • commands[].argsobjectopcional

    Los argumentos del comando.

  • commands[].idstringopcional

    Tu 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

  • type

    Siempre SUCCESS cuando la solicitud en sí fue aceptada.

  • results[].command

    El comando que produjo este resultado.

  • results[].id

    El id que enviaste, o el índice del comando.

  • results[].type

    SUCCESS o ERROR.

  • results[].took_ms

    Tiempo que tardó el comando dentro del servidor.

  • results[].data

    La salida del comando. Solo está presente cuando type es SUCCESS.

  • results[].code / message

    El error. Solo está presente cuando type es ERROR.

Autenticación

Usa la API key que creas en el dashboard, en Developers → API Keys.

  • Authorization

    Envía Authorization: <api key> o Authorization: Bearer <api key>.

  • privacy:read

    Get Preferences, Get Many, Get History y List Changes.

  • privacy:write

    Set Preferences.

  • Tokens de mailbox

    El token del webmail no funciona aquí. Se rechaza con WRONG_CREDENTIAL_TYPE.

  • IPs permitidas

    Si 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 / segundo

    Pico de 15. Las respuestas servidas desde la caché también cuentan.

  • 15 simultáneas

    Como máximo 15 solicitudes procesándose al mismo tiempo.

  • Caché de lectura: 1,5 s

    La 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.

  • 400INVALID_JSON

    El cuerpo no es {"commands":[...]} o pesa más de 1 MB.

  • 400INVALID_ARGS

    La solicitud no tiene comandos o tiene más de 20.

  • 401MISSING_AUTH_HEADER

    No se envió ningún header Authorization.

  • 401INVALID_API_KEY

    La API key no existe, fue revocada o se desactivó en el dashboard.

  • 401API_KEY_EXPIRED

    La API key superó la fecha de expiración definida en el dashboard.

  • 401WRONG_CREDENTIAL_TYPE

    Se envió un token de mailbox. Esta API necesita una API key del dashboard.

  • 403IP_NOT_ALLOWED

    La solicitud vino de una IP que no está entre las IPs permitidas de la key.

  • 403ACCOUNT_BLOCKED

    La cuenta está bloqueada.

  • 403MISSING_SCOPE

    La key no tiene ni `privacy:read` ni `privacy:write`, así que no se puede ejecutar ningún comando.

  • 429RATE_LIMITED

    Má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.

  • 503AUTH_UNAVAILABLE

    La autenticación no está disponible temporalmente. Inténtalo de nuevo.

  • CMDUNKNOWN_COMMAND

    El nombre del comando no existe.

  • CMDINTERNAL

    Error del servidor. El detalle solo se escribe en el log del servidor.