Notes

CRM record notes. Append-only. Distinct from inbox internal notes.

Official Aivyro contentAligned with the current public contract

POST/api/v1/notes

List and create require one of contact_id, company_id or deal_id. An empty record returns data: [], not 404. POST is append-only: each call creates a note. Do not send Idempotency-Key. PATCH body is title, body only — cannot re-parent.

HTTP	Path	Scope
GET	`/api/v1/notes`	`rest.crm.notes.read`
POST	`/api/v1/notes`	`rest.crm.notes.write`
GET	`/api/v1/notes/{id}`	`rest.crm.notes.read`
PATCH	`/api/v1/notes/{id}`	`rest.crm.notes.write`

Query

Parameter	Type	Notes
contact_id \| company_id \| deal_id	UUID	Exactly one on list/create. Empty is data: [].
limit / cursor	number / string	Cursor page.

Fields

Field	Type	Notes
id	UUID	Immutable.
title	string \| null	PATCH allowed.
body	string \| null	PATCH allowed.
contact_id / company_id / deal_id	UUID \| null	Cannot re-parent on PATCH.
created_at / updated_at	datetime	ISO-8601 UTC.

POST /api/v1/notes

curl -sS -X POST "$AIVYRO_API_BASE/api/v1/notes" \
  -H "Authorization: Bearer $AIVYRO_API_KEY" \
  -H 'Content-Type: application/json' \
  -d "{\"contact_id\":\"$CONTACT_ID\",\"title\":\"Follow up\",\"body\":\"Call Ada\"}"