Contactos: segmentos
Borrar segmento
Elimina un segmento guardado. Solo desaparece la consulta guardada; no se toca ningún contacto.
https://g.sendcorex.com/v1/contactscommand: delete_segmentNecesita el scope contact:delete en tu API key.
Argumentos
segment_idstringobligatorioEl segmento que se elimina.
p. ej.
"engaged-vips"
Inicio rápido
import axios from 'axios';
const response = await axios.post(
'https://g.sendcorex.com/v1/contacts',
{
commands: [
{
command: "delete_segment",
args: {
segment_id: "engaged-vips"
}
}
]
},
{ 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_segment",
"id": "0",
"type": "SUCCESS",
"took_ms": 14,
"data": {
"deleted": true
}
}
]
}Campos de la respuesta
deletedtruecuando el segmento se eliminó.
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.