Contacts : listes
Supprimer une liste
Supprimez une liste. Elle disparaît immédiatement ; ses membres en sont retirés en arrière-plan. Les contacts eux-mêmes sont conservés.
https://g.sendcorex.com/v1/contactscommand: delete_listNécessite le scope contact:delete sur votre API key.
Seule l'appartenance est supprimée. Les contacts, leurs tags, champs et autres listes restent. Pour supprimer aussi les personnes, interrogez-les d'abord puis utilisez Delete Contacts.
Arguments
list_idstringobligatoireLa liste à supprimer.
ex. :
"old-leads"
Démarrage rapide
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);Réponse
{
"type": "SUCCESS",
"results": [
{
"command": "delete_list",
"id": "0",
"type": "SUCCESS",
"took_ms": 14,
"data": {
"deleted": true,
"purging": true
}
}
]
}Champs de la réponse
deletedtrue. La liste n'apparaît plus dans List Lists ni dans Get List.purgingtruependant que les membres sont retirés de la liste en arrière-plan.
Ce qui se passe en arrière-plan
Les grandes listes sont nettoyées par lots. Tant que ce n'est pas fini, list_lists avec include_deleting: true affiche encore la liste avec status: "deleting".
Erreurs
Les erreurs au niveau HTTP renvoient type, code et message. Les erreurs marquées CMD reviennent dans le résultat de la commande, avec HTTP 200.
- 401
INVALID_API_KEYL'API key n'existe pas, a été révoquée ou désactivée dans le dashboard.
- 429
RATE_LIMITEDPlus de 15 requêtes/s ou 15 simultanées pour la même IP + API key. Attendez le nombre de secondes indiqué dans Retry-After.
- CMD
MISSING_SCOPEL'API key n'a pas le scope requis par cette commande. Les autres commandes de la requête s'exécutent quand même.
- CMD
INVALID_ARGSUn argument obligatoire est manquant ou invalide : email, valeur de champ, option d'enum, clé de where, id de liste…
- CMD
NOT_FOUNDLe contact, la liste, le champ ou le segment n'existe pas.
- CMD
INTERNALErreur serveur. Le détail n'est écrit que dans le log du serveur.