Allo

Create person note

Adds a note to a person's CRM profile.

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

Behavior

Adds a note to the CRM profile of the person identified by person_id — the per-* id from the People API.

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
400CONTACT_NOTES_UNAVAILABLEThe workspace is not on the v2 contact model yet
404PERSON_NOT_FOUNDNo person with this ID (also returned for IDs without the per- prefix)

Authorization

Authorizationstring · headerrequired

Api-Key ak_live_…

Path parameters

person_idstringrequired

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

Body

contentstringrequired

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

Responses

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