Contacts : champs personnalisés
Lister les champs
Tous les champs personnalisés du compte, avec leur type et leurs options, triés par clé.
https://g.sendcorex.com/v1/contactscommand: list_fieldsNécessite le scope contact:read sur votre API key.
Arguments
Cet endpoint n'accepte aucun argument.
Démarrage rapide
import axios from 'axios';
const response = await axios.post(
'https://g.sendcorex.com/v1/contacts',
{
commands: [
{
command: "list_fields"
}
]
},
{ 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": "list_fields",
"id": "0",
"type": "SUCCESS",
"took_ms": 14,
"data": {
"fields": [
{
"key": "age",
"name": "Age",
"type": "number",
"options": null,
"created_at": "2026-10-01T10:00:00.000Z",
"updated_at": "2026-10-01T10:00:00.000Z"
},
{
"key": "plan",
"name": "Plan",
"type": "enum",
"options": [
"free",
"pro",
"business"
],
"created_at": "2026-10-01T10:00:00.000Z",
"updated_at": "2026-10-01T10:00:00.000Z"
}
],
"limit": 100
}
}
]
}Champs de la réponse
fields[].keyLa clé utilisée dans
fields, danswhereet danssort(fields.<key>).fields[].nameNom affiché.
fields[].typetext,number,date,bool,enumoumulti_enum.fields[].optionsLes valeurs autorisées des champs
enumetmulti_enum.limitLe nombre de champs autorisés pour le compte (100).
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
INTERNALErreur serveur. Le détail n'est écrit que dans le log du serveur.