Contactos: listas
Establecer suscripción a la lista
Da de baja hasta 500 contactos de una lista, o vuelve a suscribirlos, sin tocar sus otras listas ni su estado global.
https://g.sendcorex.com/v1/contactscommand: set_list_subscriptionNecesita el scope contact:update en tu API key.
Los contactos que no son miembros de la lista se quedan como están y vuelven con changed: false. Usa Add To Lists para hacerlos miembros primero.
Argumentos
emailsstring[]opcionalHasta 500 emails. Se ignoran las mayúsculas y los espacios alrededor, y los emails repetidos cuentan una vez.
emailstringopcionalUn solo email. Usa este o
emails.list_idstringobligatorioLa lista.
p. ej.
"newsletter"subscribedbooleanobligatoriofalsepara dar de baja de esta lista,truepara volver a suscribir.return_contactsbooleanopcionalAñ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: "set_list_subscription",
args: {
emails: [
"bob@gmail.com"
],
list_id: "newsletter",
subscribed: false
}
}
]
},
{ 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_list_subscription",
"id": "0",
"type": "SUCCESS",
"took_ms": 14,
"data": {
"items": [
{
"id": "bob@gmail.com",
"ok": true,
"data": {
"changed": true
}
}
],
"ok_count": 1,
"failed_count": 0
}
}
]
}Campos de la respuesta
items[].idEl email que enviaste, tal como lo enviaste.
items[].oktruecuando este email funcionó. Cuando esfalse, el elemento tienecodeymessage.items[].data.changedfalsesignifica que el contacto ya estaba así, así que no se escribió nada.items[].data.contactEl contacto completo después del cambio. Solo con
return_contacts: true.ok_count / failed_countCuántos emails funcionaron y cuántos fallaron.
¿Suscripción a la lista o estado global?
Set List SubscriptionLa persona aún quiere tus otras listas. Sigue siendo miembro aquí, marcada como dada de baja, y deja de recibir envíos solo en esta lista.
Set StatusLa persona no quiere ningún email, o la dirección rebotó. Sendable pasa a
falseen todas las listas.
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.
- 401
INVALID_API_KEYLa API key no existe, se revocó o se desactivó en el dashboard.
- 429
RATE_LIMITEDMás de 15 peticiones/s o 15 simultáneas para la misma IP + API key. Espera los segundos indicados en Retry-After.
- CMD
MISSING_SCOPELa API key no tiene el scope que necesita este comando. Los demás comandos de la petición se ejecutan igualmente.
- CMD
INVALID_ARGSFalta un argumento obligatorio o no es válido: email, valor de campo, opción de enum, clave del where, id de lista…
- CMD
NOT_FOUNDEl contacto, la lista, el campo o el segmento no existe.
- CMD
INTERNALError del servidor. El detalle solo se escribe en el log del servidor.