Skip to content

Create Record Note

POST
/notes

Create a note attached to one or MORE records.

With records, the first entry is the primary record and every entry is linked; without it, entity_type/entity_id name the single record. Every record is authorised for write before anything is stored.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Mirrors GlobalNoteCreateRequest.

object
content
required

Note body.

string
entity_id

Id of that record.

string
""
entity_type

Record type the note is attached to.

string
""
mentioned_users

Teammates mentioned in the note.

Array<object>

Mirrors contacts.usecases.notes.cmd.MentionedUser.

object
email
Any of:
string
id
required

User id.

string
name
required

Display name.

string
records
Any of:
Array<object>
object
key
additional properties
any
source_url
Any of:
string

Responses

201

Successful Response

object
data
required

An open envelope for one record, one dashboard or one job receipt.

Open because most of these reads are COMPUTED shapes - an engagement summary, a next-best-step, an intelligence status - that grow with the product, and dropping a field from an advisory read makes it say “nothing to report” rather than “we did not tell you”.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string