Skip to main content
POST
Create a note

Authorizations

X-API-KEY
string
header
required

Body

application/json

Note to create

entityId
string
required

ForeignKeyId is the ID of the client or company to attach the note to.

Example:

"f47ac10b-58cc-4372-a567-0e02b2c3d479"

entityType
enum<string>
required

ForeignKeyType is the kind of entity to attach the note to.

Available options:
client,
company
Example:

"client"

title
string
required

Title is the short heading of the note.

Example:

"Onboarding call summary"

content
string

Content is the body of the note. Optional; a note may have a title only.

Example:

"Discussed the rollout timeline and next steps."

Response

OK

content
string

Content is the body of the note.

Example:

"Discussed the rollout timeline and next steps."

createdAt
string
creatorId
string

CreatorId is the ID of the internal user who created the note. TODO(@foley): Let's remove this and use CreatedBy from Model, we'll need to do some backward compatibility work for the platform API.

Example:

"7b1c5d9e-2f34-4a8b-9c0d-1e2f3a4b5c6d"

data
string
entityId
string

ForeignKeyId is the ID of the client or company the note is attached to.

Example:

"f47ac10b-58cc-4372-a567-0e02b2c3d479"

entityType
enum<string>

ForeignKeyType is the kind of entity the note is attached to.

Available options:
client,
company
Example:

"client"

id
string
identityId
string
object
string
portalId
string

PortalID is the workspace the note belongs to.

Example:

"a1b2c3d4-5678-90ab-cdef-1234567890ab"

previousAttributes
object
ref
string
title
string

Title is the short heading of the note.

Example:

"Onboarding call summary"

updatedAt
string