Contacts : segments
Enregistrer un segment
Enregistrez une requête sous un nom, pour que votre application et le dashboard puissent l'exécuter plus tard. Les contacts ne sont pas copiés : le segment est réévalué à chaque exécution.
https://g.sendcorex.com/v1/contactscommand: save_segmentNécessite le scope contact:create sur votre API key.
Le where est validé à l'enregistrement : une clé ou un champ inconnu échoue avec INVALID_ARGS tout de suite, pas à la prochaine exécution.
Arguments
segment_idstringfacultatifVotre propre id. Généré s'il est omis. Enregistrer avec un id existant remplace ce segment.
ex. :
"engaged-vips"namestringfacultatifNom affiché.
ex. :
"Engaged VIPs"whereobjectobligatoireLe même
whereque Query Contacts.sortstring | objectfacultatifLe même
sortque Query Contacts.ex. :
"open_rate"
Démarrage rapide
import axios from 'axios';
const response = await axios.post(
'https://g.sendcorex.com/v1/contacts',
{
commands: [
{
command: "save_segment",
args: {
segment_id: "engaged-vips",
name: "Engaged VIPs",
where: {
tags: {
has: "vip"
},
last_open_at: {
within_days: 30
}
},
sort: "open_rate"
}
}
]
},
{ 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": "save_segment",
"id": "0",
"type": "SUCCESS",
"took_ms": 14,
"data": {
"segment_id": "engaged-vips",
"name": "Engaged VIPs",
"where": {
"tags": {
"has": "vip"
},
"last_open_at": {
"within_days": 30
}
},
"sort": {
"field": "open_rate"
},
"created_at": "2026-10-10T12:00:00.000Z",
"updated_at": "2026-10-10T12:00:00.000Z"
}
}
]
}Champs de la réponse
(segment)Le segment tel qu'enregistré.
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
INTERNALErreur serveur. Le détail n'est écrit que dans le log du serveur.