Contactos: listas

Quitar de listas

Saca hasta 500 contactos de una o más listas. Dejan de ser miembros; nada más cambia en ellos.

POSThttps://g.sendcorex.com/v1/contactscommand: remove_from_lists
i

Necesita el scope contact:update en tu API key.

i

Cuando alguien se da de baja de una lista, mejor usa Set List Subscription con subscribed: false: sigue en la lista como dado de baja, así conservas el registro de que se fue.

Argumentos

  • emailsstring[]opcional

    Hasta 500 emails. Se ignoran las mayúsculas y los espacios alrededor, y los emails repetidos cuentan una vez.

  • emailstringopcional

    Un solo email. Usa este o emails.

  • list_idsstring[]obligatorio

    Las listas de las que salir.

    p. ej. ["leads"]

  • list_idstringopcional

    Una sola lista. Usa este o list_ids.

  • return_contactsbooleanopcional

    Añade a cada elemento el contacto completo después del cambio.

Inicio rápido

import axios from 'axios';

const response = await axios.post(
  'https://g.sendcorex.com/v1/contacts',
  {
    commands: [
      {
        command: "remove_from_lists",
        args: {
          emails: [
            "ana@acme.com"
          ],
          list_ids: [
            "leads"
          ]
        }
      }
    ]
  },
  { 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": "remove_from_lists",
      "id": "0",
      "type": "SUCCESS",
      "took_ms": 14,
      "data": {
        "items": [
          {
            "id": "ana@acme.com",
            "ok": true,
            "data": {
              "changed": true
            }
          }
        ],
        "ok_count": 1,
        "failed_count": 0
      }
    }
  ]
}

Campos de la respuesta

  • items[].id

    El email que enviaste, tal como lo enviaste.

  • items[].ok

    true cuando este email funcionó. Cuando es false, el elemento tiene code y message.

  • items[].data.changed

    false cuando el contacto no estaba en ninguna de estas listas.

  • items[].data.contact

    El contacto completo después del cambio. Solo con return_contacts: true.

  • ok_count / failed_count

    Cuántos emails funcionaron y cuántos fallaron.

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, se revocó o se desactivó en el dashboard.

  • 429RATE_LIMITED

    Más de 15 peticiones/s o 15 simultáneas para la misma IP + API key. Espera los segundos indicados en Retry-After.

  • CMDMISSING_SCOPE

    La API key no tiene el scope que necesita este comando. Los demás comandos de la petición se ejecutan igualmente.

  • CMDINVALID_ARGS

    Falta un argumento obligatorio o no es válido: email, valor de campo, opción de enum, clave del where, id de lista…

  • CMDNOT_FOUND

    El contacto, la lista, el campo o el segmento no existe.

  • CMDINTERNAL

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