Allo

Mettre à jour une note de personne

Remplace le content de la note. Seul l' auteur de la note peut la modifier — mettre à jour la note d'un autre utilisateur retourne une erreur 403 avec le…

PATCH/v2/api/crm/people/{person_id}/notes/{note_id}

Comportement

Remplace le content de la note. Seul l'auteur de la note peut la modifier — mettre à jour la note d'un autre utilisateur retourne une erreur 403 avec le code NOT_NOTE_AUTHOR.

Les mentions sont ré-analysées à partir du nouveau contenu — voir le guide des mentions.

Erreurs

StatutCodeQuand
400EMPTY_NOTE_CONTENTcontent est manquant ou vide
400NOTE_CONTENT_TOO_LONGcontent dépasse 4 000 caractères
400CONTACT_NOTES_UNAVAILABLELe workspace n'est pas encore sur le modèle de contacts v2
403NOT_NOTE_AUTHORL'utilisateur de l'API key n'est pas l'auteur de la note
404PERSON_NOT_FOUNDAucune personne avec cet ID
404NOTE_NOT_FOUNDAucune note avec cet ID sur cette personne

Autorisation

Authorizationstring · headerrequis

Api-Key ak_live_…

Paramètres de chemin

person_idstringrequis

Person ID (per-*) — the id field from the People API.

note_idstringrequis

Note ID (cno-*)

Corps

contentstringrequis

Note text (max 4000 characters). Mention teammates inline with @[Name](usr-...), or @[all](all) to notify the whole team.

Réponses

200Updated note
dataobject
7 champs
idstring

Note ID (cno-*)

person_idstring

Person ID (per-*)

contentstring

Note text, with mentions inline as @[Name](usr-...).

userobject

Author of a note or comment.

2 champs
idstring
namestring | null
mentionsobject[]
3 champs
user_idstring
namestring | null
deletedboolean

true if the mentioned user has since been removed from the team.

created_atstring<date-time>
updated_atstring<date-time>
400
401
403
404
429