Skip to main content
POST
Create custom contact field
Scope requis : CRM_WRITE

Champs du body

Les champs DROPDOWN sont synchronisés depuis vos intégrations CRM et ne peuvent pas être créés ici.

Dérivation de la clé

La key est dérivée du label : minuscules, accents supprimés, séquences de caractères non alphanumériques remplacées par _, tronquée à 64 caractères. Lead Source devient lead_source. Un label qui correspond à la clé d’un champ natif est rejeté avec ATTRIBUTE_KEY_RESERVED. Les clés réservées sont name, phone_numbers, company, job_title, emails, last_activity, website, created_at et updated_at.

Créer deux fois le même champ

L’appel peut être répété sans risque. Si un champ avec la même clé et le même type existe déjà, l’endpoint renvoie 201 avec already_existed à true et le label avec lequel il a été créé. Rien n’est créé.
Si la clé existe avec un autre type, la requête renvoie 409 ATTRIBUTE_KEY_CONFLICT.

Limites

Une équipe peut avoir jusqu’à 150 champs personnalisés TEXT, 50 NUMBER, 30 DATE et 30 BOOLEAN. Lorsqu’un type est plein, créer un autre champ de ce type renvoie 409 ATTRIBUTE_SLOTS_EXHAUSTED.

Erreurs

Autorisations

Authorization
string
header
requis

Corps

application/json

Request body for creating a custom contact field

label
string
requis

Display name of the field. The key is derived from it: lowercase, accents removed, runs of non-alphanumeric characters replaced by _, truncated to 64 characters. Must contain at least one letter or digit and must not resolve to a built-in field key such as name, company or website.

Required string length: 1 - 255
Exemple:

"Lead Source"

type
enum<string>
requis

Value type of the field

Options disponibles:
TEXT,
NUMBER,
DATE,
BOOLEAN
Exemple:

"TEXT"

Réponse

The custom field that was created, or the existing one

data
object