Contacts : tags, statut et champs
Effacer des champs
Effacez les valeurs de champs personnalisés de 500 contacts maximum. Les champs restent définis.
https://g.sendcorex.com/v1/contactscommand: unset_fieldsNécessite le scope contact:update sur votre API key.
Pour supprimer un champ de tous les contacts et du compte, utilisez plutôt Delete Field.
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.keysstring[]obligatoireLes clés des champs à effacer.
ex. :
["age"]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: "unset_fields",
args: {
emails: [
"ana@acme.com"
],
keys: [
"age"
]
}
}
]
},
{ 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": "unset_fields",
"id": "0",
"type": "SUCCESS",
"took_ms": 14,
"data": {
"items": [
{
"id": "ana@acme.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.changedfalsequand le contact n'avait aucun de ces champs renseigné.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é.
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.