Allo

Create conversation note

Adds an internal team note to a conversation. Notes are never visible to the contact.

POST/v2/api/conversations/{contact_number}/notes

Behavior

Adds an internal team note to the conversation with contact_number. Notes are never visible to the contact.

Identify the line the conversation belongs to with either allo_number (E.164, list your lines with GET /v2/api/numbers) or sender_id (for sender-ID inbox conversations). Omitting both returns 400 with code MISSING_ALLO_NUMBER_OR_SENDER_ID.

Mentions

Mention teammates inline in content with @[Display Name](usr-xxxx) — they receive the same push, email, and in-app notifications as mentions made from the Allo apps. See the mentions guide.

Errors

StatusCodeWhen
400EMPTY_NOTE_CONTENTcontent is missing or blank
400NOTE_CONTENT_TOO_LONGcontent exceeds 4,000 characters
400MISSING_ALLO_NUMBER_OR_SENDER_IDNeither allo_number nor sender_id was provided
403ALLO_NUMBER_FORBIDDENYou do not have access to this Allo line
404SENDER_ID_NOT_FOUNDNo sender ID with this identifier on your account

Authorization

Authorizationstring · headerrequired

Api-Key ak_live_…

Path parameters

contact_numberstringrequired

The contact's phone number (E.164)

Body

contentstringrequired

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

allo_numberstring

The Allo line the conversation belongs to (E.164). Required unless sender_id is provided.

sender_idstring | null

Sender-ID inbox identifier, as an alternative to allo_number for sender-ID conversations.

Responses

201Note created
dataobject
8 fields
idstring

Note ID (not-*)

contentstring

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

contact_numberstring

The contact's phone number (E.164).

allo_numberstring | null

The Allo line the conversation belongs to (E.164).

userobject

Author of a note or comment.

2 fields
idstring
namestring | null
mentionsobject[]
3 fields
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