Passer au contenu principal
PUT
Update person
Scope requis : CRM_WRITE

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.
  • 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.

Autorisations

Authorization
string
header
requis

Paramètres de chemin

id
string
requis

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

Exemple:

"per-abc123"

Corps

application/json

Request body for updating a person. Only provided fields will be updated.

name
string | null

First name

last_name
string | null

Last name

job_title
string | null

Job title

website
string | null

Website URL

address
string | null

Postal address

numbers
string[] | null

Phone numbers (replaces all existing numbers)

emails
string[] | null

Email addresses (replaces all existing emails)

company_id
string | null

ID of the company to associate with

custom_attributes
object | 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.

Exemple:

Réponse

Person updated

data
object

A person in the CRM