Skip to main content
The Notes API lets you create and manage internal team notes. Notes are only visible to your team — never to the contact. There are two kinds:
  • Conversation notes — notes pinned to a conversation (a contact phone number on one of your Allo lines). They appear in the conversation timeline in the Allo apps.
  • Person notes — notes on a person’s CRM profile, addressed by the per-* id from the People API. Under the hood, notes attach to the person’s underlying contact record, which is what will allow company notes on a future /v2/api/crm/companies/{id}/notes.

​
Note constraints

​
Mentions

Mention teammates inline in content using the syntax @[Display Name](usr-xxxx):
  • Get user IDs from GET /v2/api/users (requires the USERS_READ scope).
  • Use @[all](all) to notify the whole team.
  • A note or comment can contain at most 15 mentions.
  • Mentions with unknown user IDs are silently dropped — they render as plain text and notify no one.
Mentions trigger the same notifications as the Allo apps: the mentioned teammates receive a push notification, an email, and an entry in their in-app notification center.
@[all](all) notifies every member of the team. Sent from an automation, this can get noisy fast — use it deliberately.
Responses expose the parsed mentions as a structured array:
deleted is true when the mentioned user has since been removed from the team. Mentions work the same way in thread comments.

​
Webhooks

Subscribe to the conversation_note.created, conversation_note.updated, and conversation_note.deleted events for conversation notes, and contact_note.created, contact_note.updated, and contact_note.deleted for person notes. See the Event catalog.

​
Endpoints

​
Conversation notes

List conversation notes

All notes on a conversation, paginated

Create conversation note

Add an internal note to a conversation

Get conversation note

A single note by ID

Update conversation note

Edit a note’s content (author only)

Delete conversation note

Delete a note (author only)

​
Person notes

List person notes

All notes on a person’s CRM profile, paginated

Create person note

Add a note to a person’s CRM profile

Update person note

Edit a person note’s content (author only)

Delete person note

Delete a person note (author only)