Skip to main content
POST
Create Note

Request

At least one parent link is required. A note must reference contact_id, related_company_id (a.k.a. company_id on the body), or deal_id. Orphan notes are rejected with 400.

Body Parameters

string
required
Note title
string
Note content (max 50,000 characters)
string
default:"general"
Note type: general, meeting, call, email, other
array
Array of tag strings
boolean
default:"false"
Pin the note
string
UUID of the linked contact. Must belong to your workspace.
string
Human name — the server fuzzy-matches within your workspace and resolves to a contact_id. Use when an agent has a name but not a UUID. If multiple contacts match, returns 400 ambiguous_reference listing candidate UUIDs — retry with contact_id.
UUID of the linked company. (Also accepts company_id as an alias.)
string
Human name — same fuzzy resolution as contact_name but against the Company table.
string
UUID of the linked deal.
string
Optional ISO 8601 timestamp. Honored verbatim if within the last 5 years and not more than 24 h in the future; otherwise the server now() is used. Never null.

Headers

Response

object
Created note with id, title, note_type, tags, is_pinned, contact_id, related_company_id, deal_id, created_date.

Errors

Orphan-note rejection example

Sub-resource alternative

If you already have a contact or company in hand, you can skip the parent-link body field and POST to the sub-resource endpoint:
  • POST /v1/contacts/{contact_id}/notes
  • POST /v1/companies/{company_id}/notes
Both accept the same body (minus the parent-link field) and enforce workspace scope on the path parameter.