Allo

Créer une note de personne

Ajoute une note au profil CRM de la personne identifiée par person id — l' id per- issu de l'API Personnes.

POST/v2/api/crm/people/{person_id}/notes

Comportement

Ajoute une note au profil CRM de la personne identifiée par person_id — l'id per-* issu de l'API Personnes.

Mentions

Mentionnez des coéquipiers inline dans content avec @[Display Name](usr-xxxx) — ils reçoivent les mêmes notifications push, email et in-app que les mentions faites depuis les applications Allo. 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
404PERSON_NOT_FOUNDAucune personne avec cet ID (également retourné pour les IDs sans le préfixe per-)

Autorisation

Authorizationstring · headerrequis

Api-Key ak_live_…

Paramètres de chemin

person_idstringrequis

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

Corps

contentstringrequis

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

Réponses

201Note created
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
404
429