Allo

Mettre a jour une personne

Cet endpoint effectue une mise a jour partielle -- seuls les champs inclus dans le body sont modifies. Les champs omis restent inchanges.

PUT/v2/api/crm/people/{id}

Mise a jour partielle

Cet endpoint effectue une mise a jour partielle -- seuls les champs inclus dans le body sont modifies. Les champs omis restent inchanges.

Tous les champs de l'endpoint de creation sont acceptes et optionnels.

custom_attributes est aussi accepté. Seules les clés envoyées changent.

Dissocier une entreprise

Envoyez company_id comme chaine vide ("") pour retirer l'association de la personne avec son entreprise actuelle.

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 modifie 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

Cette requête définit lead_source et efface budget. Les autres attributs personnalisés restent inchangés.

{
  "custom_attributes": {
    "lead_source": "Referral",
    "budget": null
  }
}
{
  "data": {
    "id": "per-abc123",
    "name": "John",
    "custom_attributes": {
      "lead_source": "Referral"
    }
  }
}

Autorisation

Authorizationstring · headerrequis

Api-Key ak_live_…

Paramètres de chemin

idstringrequis

Person ID (e.g., "per-abc123")

Corps

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 (replaces all existing numbers)

emailsstring[]

Email addresses (replaces all existing emails)

company_idstring | null

ID of the company to associate with

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 updated
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
404
422
429