Contactos: listas
Eliminar lista
Elimina una lista. Desaparece al instante; sus miembros se sacan de ella en segundo plano. Los contactos se conservan.
https://g.sendcorex.com/v1/contactscommand: delete_listNecesita el scope contact:delete en tu API key.
Solo se quita la pertenencia. Los contactos, sus etiquetas, campos y otras listas se mantienen. Para eliminar también a las personas, búscalas primero y usa Delete Contacts.
Argumentos
list_idstringobligatorioLa lista que se elimina.
p. ej.
"old-leads"
Inicio rápido
import axios from 'axios';
const response = await axios.post(
'https://g.sendcorex.com/v1/contacts',
{
commands: [
{
command: "delete_list",
args: {
list_id: "old-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": "delete_list",
"id": "0",
"type": "SUCCESS",
"took_ms": 14,
"data": {
"deleted": true,
"purging": true
}
}
]
}Campos de la respuesta
deletedtrue. La lista ya no aparece en List Lists ni en Get List.purgingtruemientras los miembros se sacan de la lista en segundo plano.
Qué pasa en segundo plano
Las listas grandes se limpian por lotes. Hasta que termine, list_lists con include_deleting: true sigue mostrando la lista con status: "deleting".
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.