Champs personnalisés

Un champ personnalisé est une donnée que vous gardez sur chaque contact, au-delà de l'adresse et du nom — utm_source, plan_tier, signup_date. Il est défini une fois pour toute l'organisation, et chaque contact peut ensuite porter une valeur pour lui. Voir Ce que fait un champ personnalisé pour les règles qui le gouvernent. Ces appels gèrent les définitions : la clé, le libellé et le type. Les valeurs, elles, s'écrivent sur le contact, avec customFields sur Ajouter ou mettre à jour un contact.
  • La clé et le type sont fixés à la création. Seul le libellé se renomme. Pour changer l'un ou l'autre, créez un nouveau champ.
  • Une organisation a au plus 50 champs personnalisés.
  • Certaines clés sont réservées parce que chaque contact les a déjà (email, first_name, status…) et sont refusées.

La boucle, de bout en bout

  1. Lire les champs. GET /api/v1/custom-fields liste chaque clé définie dans l'organisation.
  2. Créer ce qui manque. POST /api/v1/custom-fields avec une key, un label et un type.
  3. Écrire les valeurs. Envoyez customFields sur Ajouter ou mettre à jour un contact. Une clé qui n'est pas définie ici est refusée : créez d'abord le champ.