Skip to main content
POST
Create Note

Authorizations

Authorization
string
header
required

Consumer JWT minted by the tenant's backend

X-Rollout-Credential-Id
string
header
required

The Rollout Credential ID to use for queries/mutations

Query Parameters

fields
string

Comma-separated top-level fields to return; the parameter can also be repeated, once per field. id is always returned. Omit it, or pass allFields, to get every field, including original. Unknown names return 400.

Body

personId
string
required
assignedUserId
string
createdByUserId
string
subject
string
body
string
isHtml
boolean

Response

The created note.

The created note.

id
string
required
personId
string | null

Present unless the request's fields leaves it out.

assignedUserId
string | null

Present unless the request's fields leaves it out.

createdByUserId
string | null

Present unless the request's fields leaves it out.

updatedByUserId
string | null

Present unless the request's fields leaves it out.

subject
string

Present unless the request's fields leaves it out.

body
string

Present unless the request's fields leaves it out.

isHtml
boolean

Present unless the request's fields leaves it out.

created
string

Present unless the request's fields leaves it out.

updated
string | null

Present unless the request's fields leaves it out.

rolloutUpdated
string

Present unless the request's fields leaves it out.

originalIds
object

Present unless the request's fields leaves it out.

original
object

Present unless the request's fields leaves it out.