Tracking Preferences: Lectura

Obtener varias

Las preferencias de hasta 100 destinatarios en un comando. Úsalo justo antes de un envío para decidir track_opens y track_clicks por destinatario.

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

Requiere el scope privacy:read en tu API key.

i

Solo vuelven los destinatarios que tienen una preferencia. Una dirección que no aparece en la respuesta nunca eligió nada.

Argumentos

  • emailsstring[]obligatorio

    De 1 a 100 direcciones de destinatarios. Se ignoran los duplicados y las direcciones inválidas.

    p. ej. ["jane.doe@example.com", "marc.dupont@example.fr", "new.person@example.com"]

Inicio rápido

import axios from 'axios';

const response = await axios.post(
  'https://g.sendcorex.com/v1/privacy',
  {
    commands: [
      {
        command: "get_many",
        args: {
          emails: [
            "jane.doe@example.com",
            "marc.dupont@example.fr",
            "new.person@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);

Respuesta

{
  "type": "SUCCESS",
  "results": [
    {
      "command": "get_many",
      "id": "0",
      "type": "SUCCESS",
      "took_ms": 6,
      "data": {
        "preferences": [
          {
            "email": "jane.doe@example.com",
            "track_opens": false,
            "track_clicks": true,
            "source": "page",
            "updated_at": "2026-10-24T07:20:12.031Z"
          },
          {
            "email": "marc.dupont@example.fr",
            "track_opens": false,
            "track_clicks": false,
            "source": "api",
            "updated_at": "2026-10-24T07:41:55.508Z"
          }
        ]
      }
    }
  ]
}

Campos de la respuesta

  • preferences

    Una entrada por cada destinatario que tiene una preferencia.

  • preferences[].email

    La dirección del destinatario, en minúsculas.

  • preferences[].track_opens

    true el destinatario permite el seguimiento de aperturas, false lo rechazó, null nunca eligió.

  • preferences[].track_clicks

    true el destinatario permite el seguimiento de clics, false lo rechazó, null nunca eligió.

  • preferences[].source

    Quién hizo el cambio: page (el destinatario, en la página de preferencias de tracking), api (tú, con Set Preferences) o dashboard.

  • preferences[].updated_at

    Cuándo se hizo el cambio. ISO 8601, UTC.

Antes de enviar

Lee el lote y luego envía a cada destinatario con el tracking que permite. Los destinatarios sin preferencia siguen tu valor por defecto.

Node.js

const [r] = await call({ command: 'get_many', args: { emails: batch.map((x) => x.email) } });
const prefs = new Map(r.data.preferences.map((p) => [p.email, p]));

for (const x of batch) {
  const p = prefs.get(x.email.toLowerCase());
  await send({
    to: x.email,
    unsubscribe: true,
    track_opens: p?.track_opens === true,   // opt-in: only when allowed
    track_clicks: p?.track_clicks === true,
  });
}
i

No necesitas hacer esto para respetar un rechazo: con "unsubscribe": true, un destinatario que desactivó el tracking nunca es seguido. Esto es para reglas de opt-in, donde el tracking debe quedar desactivado hasta que el destinatario lo permita.

La respuesta

data

{
  "preferences": [
    {
      "email": "jane.doe@example.com",
      "track_opens": false,
      "track_clicks": true,
      "source": "page",
      "updated_at": "2026-10-24T07:20:12.031Z"
    },
    {
      "email": "marc.dupont@example.fr",
      "track_opens": false,
      "track_clicks": false,
      "source": "api",
      "updated_at": "2026-10-24T07:41:55.508Z"
    }
  ]
}

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.

  • 401INVALID_API_KEY

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

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

  • CMDMISSING_SCOPE

    La API key no tiene el scope de este comando (`privacy:read` para leer, `privacy:write` para modificar).

  • CMDINVALID_ARGS

    Un argumento no es válido: `email` ausente o mal formado, más de 100 `emails`, `track_opens` que no es `true`/`false`, limit fuera de rango…

  • CMDINTERNAL

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