Contacts : tags, statut et champs
Définir le statut
Modifiez le statut global de 500 contacts maximum : désabonnez-les, bloquez-les ou réabonnez-les dans toutes les listes à la fois.
https://g.sendcorex.com/v1/contactscommand: set_statusNécessite le scope contact:update sur votre API key.
Le statut est global. Un contact qui n'est pas subscribed ne peut recevoir d'envois dans aucune liste, même s'il y est encore abonné. Pour quitter une seule liste, utilisez Set List Subscription.
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.statusstringobligatoiresubscribed,unsubscribed,bounced,complainedoublocked.ex. :
"unsubscribed"reasonstringfacultatifPourquoi le statut a changé. Enregistré dans
status_reason.ex. :
"asked by email"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_status",
args: {
emails: [
"bob@gmail.com"
],
status: "unsubscribed",
reason: "asked by email"
}
}
]
},
{ 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_status",
"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é.
Statuts
subscribedPeut recevoir les emails des listes auxquelles il est abonné.
unsubscribedA demandé à ne plus recevoir d'emails.
bouncedL'adresse n'accepte pas les emails.
complainedA signalé l'un de vos emails comme spam.
blockedBloqué par vous. À utiliser pour les adresses que vous ne voulez jamais contacter.
Remettre subscribed sur quelqu'un qui s'est désabonné ou s'est plaint ne doit se faire que s'il l'a demandé.
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.