Contacts : champs personnalisés
Définir un champ
Créez un champ personnalisé, ou renommez-le et modifiez ses options. Chaque champ est indexé séparément : vous pouvez filtrer et trier dessus immédiatement.
https://g.sendcorex.com/v1/contactscommand: define_fieldNécessite le scope contact:create sur votre API key.
Le rappeler avec les mêmes key et type met à jour le nom et les options. Le type ne change jamais : essayer échoue avec TYPE_LOCKED. Pour le changer, supprimez le champ et recréez-le.
Arguments
keystringobligatoirea-z,0-9et_, commençant par une lettre, 40 caractères maximum.ex. :
"plan"typestringobligatoiretext,number,date,bool,enumoumulti_enum.ex. :
"enum"namestringfacultatifNom affiché. Par défaut, la clé.
ex. :
"Plan"optionsstring[]facultatifObligatoire pour
enumetmulti_enum: les valeurs autorisées.ex. :
["free", "pro", "business"]
Démarrage rapide
import axios from 'axios';
const response = await axios.post(
'https://g.sendcorex.com/v1/contacts',
{
commands: [
{
command: "define_field",
args: {
key: "plan",
name: "Plan",
type: "enum",
options: [
"free",
"pro",
"business"
]
}
}
]
},
{ 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": "define_field",
"id": "0",
"type": "SUCCESS",
"took_ms": 14,
"data": {
"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"
}
}
]
}Champs de la réponse
(field)Le champ tel qu'enregistré :
key,name,type,options,created_at,updated_at.
Types
textJusqu'à 2 000 caractères. Filtrez par égalité (sans tenir compte de la casse ni des accents),
containsouexists.numberEntiers ou décimaux, négatifs compris.
"1234,5"est lu comme 1234.5. Plages et tri.dateYYYY-MM-DDou ISO. Plages et tri.booltrueoufalse."yes","sim"et"1"sont lus comme vrai.enumL'une des
options."PRO"est enregistré comme"pro". Une valeur hors des options fait échouer l'élément.multi_enumN'importe quel nombre d'
options, sous forme de liste ou de"tech, golf". Ne peut pas servir au tri.
Créez tous vos champs d'un coup
Corps de la requête
{
"commands": [
{
"command": "define_field",
"args": {
"key": "plan",
"name": "Plan",
"type": "enum",
"options": [
"free",
"pro",
"business"
]
}
},
{
"command": "define_field",
"args": {
"key": "age",
"name": "Age",
"type": "number"
}
},
{
"command": "define_field",
"args": {
"key": "city",
"name": "City",
"type": "text"
}
},
{
"command": "define_field",
"args": {
"key": "birthday",
"name": "Birthday",
"type": "date"
}
},
{
"command": "define_field",
"args": {
"key": "interests",
"name": "Interests",
"type": "multi_enum",
"options": [
"golf",
"tech",
"travel"
]
}
},
{
"command": "define_field",
"args": {
"key": "vip",
"name": "VIP",
"type": "bool"
}
}
]
}Un compte peut avoir jusqu'à 100 champs. Au-delà, define_field échoue avec LIMIT_REACHED.
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
TYPE_LOCKEDdefine_field a tenté de changer le type d'un champ existant. Supprimez-le et recréez-le.
- CMD
LIMIT_REACHEDLe compte a déjà 100 champs personnalisés.
- CMD
INTERNALErreur serveur. Le détail n'est écrit que dans le log du serveur.