Tracking Preferences: Escritura

Establecer preferencias

Registra la elección de tracking de un destinatario, por ejemplo el consentimiento que recopilaste en tus propios formularios o en tu CRM.

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

Requiere el scope privacy:write en tu API key.

i

Envía solo lo que cambió: un campo que omites conserva su valor actual. Enviar los mismos valores otra vez no cambia nada y changed vuelve como false.

i

Los cambios hechos aquí se registran con source: "api" en el historial. No disparan el webhook tracking_preferences_updated, así que una sincronización con el CRM nunca entra en bucle.

Argumentos

  • emailstringobligatorio

    La dirección del destinatario.

    p. ej. "jane.doe@example.com"

  • track_opensbooleanopcional

    true permite el seguimiento de aperturas, false lo rechaza.

    p. ej. true

  • track_clicksbooleanopcional

    true permite el seguimiento de clics, false lo rechaza.

    p. ej. true

Inicio 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);

Respuesta

{
  "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 de la respuesta

  • changed

    false cuando el destinatario ya tenía esos valores (no se escribió nada).

  • preference

    El estado después de la llamada.

  • preference.email

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

  • preference.track_opens

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

  • preference.track_clicks

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

  • preference.source

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

  • preference.updated_at

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

Cómo afecta a tus envíos

  • El rechazo siempre gana

    Cuando track_opens o track_clicks es false, ese tracking se deja fuera del email aunque tu envío lo pida con "track_opens": true.

  • Nunca eligió

    Cuando el valor es null (o el destinatario no tiene ninguna preferencia), decide tu envío, exactamente como antes.

  • Requiere nuestro motor de bajas

    Las preferencias se aplican a los envíos con "unsubscribe": true. Eso es también lo que pone el enlace de preferencias en el email.

  • Tu valor por defecto

    Para reglas de opt-in (por ejemplo, Francia), envía "track_opens": false y "track_clicks": false hasta que el destinatario lo permita, y lee la preferencia con Get Many antes de enviar.

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.