Allo

Creer une personne

Champ Type Requis Defaut Description ------- ------ -------- -------- ------------- name string non Prenom last name string non Nom de famille job title…

POST/v2/api/crm/people

Champs du body

ChampTypeRequisDefautDescription
namestringnonPrenom
last_namestringnonNom de famille
job_titlestringnonPoste
websitestringnonURL du site web
addressstringnonAdresse
numbersarrayouiNuméros de téléphone au format E.164. Au moins un numéro
emailsarraynonAdresses email
company_idstringnonID de l'entreprise associee
allow_duplicate_numberbooleannonfalseAutorise la creation meme si un ou plusieurs numeros sont deja attribues a une autre personne
custom_attributesobjectnonValeurs 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'attributValeur acceptée
TEXTUne chaîne
NUMBERUn nombre JSON fini. Les chaînes sont rejetées. Relu comme un décimal : 180 est renvoyé sous la forme 180.0
BOOLEANUn booléen JSON
DATEYYYY-MM-DD ou une date-heure ISO. Stockée comme date et renvoyée au format YYYY-MM-DD
DROPDOWNUne clé ou un label d'option, sans distinction de casse. Toujours renvoyée sous forme de clé d'option
  • Envoyez null pour une clé afin d'effacer sa valeur.
  • Les clés absentes de la requête ne changent pas. {}, ou l'absence de custom_attributes, ne change rien.
  • Une clé inconnue ou archivée renvoie 400 CUSTOM_ATTRIBUTE_KEY_UNKNOWN. Une valeur du mauvais type renvoie 400 CUSTOM_ATTRIBUTE_VALUE_INVALID. Dans les deux cas, param vaut custom_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
    }
  }
}

Autorisation

Authorizationstring · headerrequis

Api-Key ak_live_…

Corps

namestring | null

First name

last_namestring | null

Last name

job_titlestring | null

Job title

websitestring | null

Website URL

addressstring | null

Postal address

numbersstring[]requis

Phone numbers in E.164 format. At least one number is required.

emailsstring[]

Email addresses

company_idstring | null

ID of the company to associate with

allow_duplicate_numberboolean

When true, allows creating a person even if the phone numbers are already assigned to another person. Defaults to false.

custom_attributesobject | null

Values for the person's custom attributes, keyed by attribute key. TEXT takes a string, NUMBER a finite JSON number (numeric strings are rejected), BOOLEAN a JSON boolean, DATE a YYYY-MM-DD string or ISO datetime, and DROPDOWN an option key or label (case-insensitive). Send null to clear a value; keys you omit are left untouched, and {} or omitting the field changes nothing. An unknown or archived key, or a value of the wrong type, rejects the whole request with CUSTOM_ATTRIBUTE_KEY_UNKNOWN or CUSTOM_ATTRIBUTE_VALUE_INVALID.

Réponses

200Person created
dataobject

A person in the CRM

14 champs
idstring

Unique person identifier

namestring | null

First name

last_namestring | null

Last name

job_titlestring | null

Job title

websitestring | null

Website URL

addressstring | null

Postal address

numbersstring[]

Phone numbers in E.164 format

emailsstring[]

Email addresses

companyobject | null

Embedded company reference

2 champs
idstring

Company ID

namestring

Company name

interactionsinteger

Total number of interactions (calls + messages)

last_activity_atstring<date-time> | null

Timestamp of the last activity

created_atstring<date-time>

When the person was created

updated_atstring<date-time>

When the person was last updated

custom_attributesobject

Values of the person's custom attributes, keyed by attribute key. Always present, {} when there are none. Archived attributes and empty values are omitted. NUMBER values are decimals (180 is returned as 180.0), DATE values are YYYY-MM-DD and DROPDOWN values are the option key. Create the attributes first with POST /v2/api/crm/attributes.

400
401
409
422
429