Contacts : listes
Définir l'abonnement à une liste
Désabonnez jusqu'à 500 contacts d'une liste, ou réabonnez-les, sans toucher à leurs autres listes ni à leur statut global.
https://g.sendcorex.com/v1/contactscommand: set_list_subscriptionNécessite le scope contact:update sur votre API key.
Les contacts qui ne sont pas membres de la liste restent inchangés et reviennent avec changed: false. Utilisez d'abord Add To Lists pour en faire des membres.
Arguments
emailsstring[]facultatifJusqu'à 500 emails. La casse et les espaces autour sont ignorés, et les emails répétés ne comptent qu'une fois.
emailstringfacultatifUn seul email. Utilisez ceci ou
emails.list_idstringobligatoireLa liste.
ex. :
"newsletter"subscribedbooleanobligatoirefalsepour désabonner de cette liste,truepour réabonner.return_contactsbooleanfacultatifAjoute à chaque élément le contact complet après la modification.
Démarrage rapide
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);Réponse
{
"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
}
}
]
}Champs de la réponse
items[].idL'email envoyé, tel que vous l'avez envoyé.
items[].oktruequand cet email a réussi. Sifalse, l'élément contientcodeetmessage.items[].data.changedfalsesignifie que le contact était déjà ainsi : rien n'a été écrit.items[].data.contactLe contact complet après la modification. Uniquement avec
return_contacts: true.ok_count / failed_countCombien d'emails ont réussi et combien ont échoué.
Abonnement à la liste ou statut global ?
Set List SubscriptionLa personne veut toujours vos autres listes. Elle reste membre ici, marquée comme désabonnée, et n'est plus joignable que dans cette liste.
Set StatusLa personne ne veut plus aucun email, ou l'adresse a généré un bounce. Sendable passe à
falsedans toutes les listes.
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.