Skip to main content
POST
Create a note

Authorizations

X-API-Key
string
header
required

API key (sk_xxx) from Developer Settings. No X-Account-ID needed.

Headers

x-account-id
string | null

Body

application/json
entity_type
string
required

Entity type this note references (company, contact, deal, activity).

entity_id
string<uuid>
required

Primary entity identifier the note is attached to.

body
string
required
Minimum string length: 1
title
string | null
Maximum string length: 255
pinned
boolean
default:false
metadata
Metadata · object

Response

Successful Response

id
string<uuid>
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
entity_type
string
required

Entity type this note references (company, contact, deal, activity).

entity_id
string<uuid>
required

Primary entity identifier the note is attached to.

body
string
required
Minimum string length: 1
account_id
string<uuid>
required
title
string | null
Maximum string length: 255
pinned
boolean
default:false
metadata
Metadata · object
created_by
string<uuid> | null