L'API Notes vous permet de créer et de gérer des notes internes d'équipe. Les notes ne sont visibles que par votre équipe — jamais par le contact. Il en existe deux types :
- Notes de conversation — des notes épinglées à une conversation (un numéro de contact sur l'une de vos lignes Allo). Elles apparaissent dans la timeline de la conversation dans les applications Allo.
- Notes de personne — des notes sur le profil CRM d'une personne, adressées par l'
idper-*issu de l'API Personnes. En interne, les notes sont rattachées à la fiche contact sous-jacente de la personne, ce qui permettra des notes d'entreprise sur un futur/v2/api/crm/companies/{id}/notes.
Contraintes des notes
| Champ | Contrainte |
|---|---|
content | Requis. Non vide, 4 000 caractères maximum. |
| Mentions | Optionnelles, inline dans content. 15 maximum par note. |
| Édition | Seul l'auteur d'une note peut la modifier ou la supprimer. |
Mentions
Mentionnez des coéquipiers inline dans content avec la syntaxe @[Display Name](usr-xxxx) :
{
"content": "Escalate to @[Jane Doe](usr-abc123) tomorrow"
}
- Récupérez les IDs utilisateur via
GET /v2/api/users(nécessite le scopeUSERS_READ). - Utilisez
@[all](all)pour notifier toute l'équipe. - Une note ou un commentaire peut contenir au maximum 15 mentions.
- Les mentions avec un ID utilisateur inconnu sont ignorées silencieusement — elles s'affichent comme du texte brut et ne notifient personne.
Les mentions déclenchent les mêmes notifications que les applications Allo : les coéquipiers mentionnés reçoivent une notification push, un email et une entrée dans leur centre de notifications in-app.
Les réponses exposent les mentions analysées sous forme de tableau structuré :
{
"mentions": [
{ "user_id": "usr-abc123", "name": "Jane Doe", "deleted": false }
]
}
deleted vaut true lorsque l'utilisateur mentionné a depuis été retiré de l'équipe.
Les mentions fonctionnent de la même façon dans les commentaires de fils de discussion.
Webhooks
Abonnez-vous aux événements conversation_note.created, conversation_note.updated et conversation_note.deleted pour les notes de conversation, et contact_note.created, contact_note.updated et contact_note.deleted pour les notes de personne. Voir le Catalogue d'événements.
Endpoints
Notes de conversation
Toutes les notes d'une conversation, paginées
Ajouter une note interne à une conversation
Une note par son ID
Modifier le contenu d'une note (auteur uniquement)
Supprimer une note (auteur uniquement)
Notes de personne
Toutes les notes du profil CRM d'une personne, paginées
Ajouter une note au profil CRM d'une personne
Modifier le contenu d'une note de personne (auteur uniquement)
Supprimer une note de personne (auteur uniquement)