Skip to main content
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’id per-* 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

​
Mentions

Mentionnez des coéquipiers inline dans content avec la syntaxe @[Display Name](usr-xxxx) :
  • Récupérez les IDs utilisateur via GET /v2/api/users (nécessite le scope USERS_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.
@[all](all) notifie chaque membre de l’équipe. Envoyé depuis une automatisation, cela peut vite devenir bruyant — utilisez-le délibérément.
Les réponses exposent les mentions analysées sous forme de tableau structuré :
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

Lister les notes de conversation

Toutes les notes d’une conversation, paginées

Créer une note de conversation

Ajouter une note interne à une conversation

Obtenir une note de conversation

Une note par son ID

Mettre à jour une note de conversation

Modifier le contenu d’une note (auteur uniquement)

Supprimer une note de conversation

Supprimer une note (auteur uniquement)

​
Notes de personne

Lister les notes d'une personne

Toutes les notes du profil CRM d’une personne, paginées

Créer une note de personne

Ajouter une note au profil CRM d’une personne

Mettre à jour une note de personne

Modifier le contenu d’une note de personne (auteur uniquement)

Supprimer une note de personne

Supprimer une note de personne (auteur uniquement)