Champs du body
| Champ | Type | Requis | Defaut | Description |
|---|---|---|---|---|
name | string | non | Prenom | |
last_name | string | non | Nom de famille | |
job_title | string | non | Poste | |
website | string | non | URL du site web | |
address | string | non | Adresse | |
numbers | array | oui | Numéros de téléphone au format E.164. Au moins un numéro | |
emails | array | non | Adresses email | |
company_id | string | non | ID de l'entreprise associee | |
allow_duplicate_number | boolean | non | false | Autorise la creation meme si un ou plusieurs numeros sont deja attribues a une autre personne |
custom_attributes | object | non | Valeurs de vos champs personnalisés, indexées par clé de champ |
Au moins un des champs name ou last_name est requis. Une requête sans numbers, ou avec une liste vide, échoue avec 400 MISSING_FIELD.
Associations
Passez un company_id pour lier la personne a une entreprise existante. L'entreprise doit exister, sinon la requete retourne une erreur.
Numeros de telephone en double
Par defaut, creer une personne avec des numeros deja attribues a une autre personne de votre equipe retourne une erreur 409 Conflict. La reponse inclut les IDs des personnes existantes pour que vous puissiez les mettre a jour.
Pour creer la personne malgre tout, passez allow_duplicate_number a true.
{
"name": "John",
"numbers": ["+33612345678"],
"allow_duplicate_number": true
}
Pour trouver la personne existante par numero, utilisez Rechercher des personnes avec le filtre phone_number.
Attributs personnalisés
custom_attributes définit les valeurs de vos champs personnalisés. Créez d'abord le champ, puis utilisez sa key ici.
| Type d'attribut | Valeur acceptée |
|---|---|
TEXT | Une chaîne |
NUMBER | Un nombre JSON fini. Les chaînes sont rejetées. Relu comme un décimal : 180 est renvoyé sous la forme 180.0 |
BOOLEAN | Un booléen JSON |
DATE | YYYY-MM-DD ou une date-heure ISO. Stockée comme date et renvoyée au format YYYY-MM-DD |
DROPDOWN | Une clé ou un label d'option, sans distinction de casse. Toujours renvoyée sous forme de clé d'option |
- Envoyez
nullpour une clé afin d'effacer sa valeur. - Les clés absentes de la requête ne changent pas.
{}, ou l'absence decustom_attributes, ne change rien. - Une clé inconnue ou archivée renvoie
400 CUSTOM_ATTRIBUTE_KEY_UNKNOWN. Une valeur du mauvais type renvoie400 CUSTOM_ATTRIBUTE_VALUE_INVALID. Dans les deux cas,paramvautcustom_attributes.<key>. - La requête entière est validée avant toute écriture : une requête rejetée ne crée rien.
- La réponse inclut toujours
custom_attributes,{}si la personne n'en a pas. Les attributs archivés et les valeurs vides sont omis. - Les valeurs sont aussi synchronisées vers vos CRM connectés qui créent des contacts. Une valeur d'un attribut synchronisé depuis un CRM peut être écrasée par la prochaine synchronisation du CRM.
Exemple
Le nombre budget est relu comme un décimal.
{
"name": "John",
"numbers": ["+33612345678"],
"custom_attributes": {
"lead_source": "Webinar",
"budget": 5000
}
}
{
"data": {
"id": "per-abc123",
"name": "John",
"numbers": ["+33612345678"],
"custom_attributes": {
"lead_source": "Webinar",
"budget": 5000.0
}
}
}