Allo

Update person note

Updates a person note's content. Only the note's author can edit it.

PATCH/v2/api/crm/people/{person_id}/notes/{note_id}

Behavior

Replaces the note's content. Only the note's author can edit it — updating someone else's note returns 403 with code NOT_NOTE_AUTHOR.

Mentions are re-parsed from the new content — 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
403NOT_NOTE_AUTHORThe API key's user is not the note's author
404PERSON_NOT_FOUNDNo person with this ID
404NOTE_NOT_FOUNDNo note with this ID on this person

Authorization

Authorizationstring · headerrequired

Api-Key ak_live_…

Path parameters

person_idstringrequired

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

note_idstringrequired

Note ID (cno-*)

Body

contentstringrequired

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

Responses

200Updated note
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
403
404
429