Skip to main content
POST
Add a note to a shift

Authorizations

Authorization
string
header
required

An API key from Settings, API keys. It starts with rc_live_.

Path Parameters

id
string
required

The shift's ID.

Body

application/json
body
string

The note as plain text. Required unless you send body_blocks.

body_blocks
object[]

A formatted note, as a list of blocks. A paragraph block has a type of p and a list of runs, each with its text. When you send it, body is made from it.

Response

The note.

id
string
required
body
string
required

The note as plain text, also when it was written as a formatted note.

created_at
string<date-time>
required
author_person_id
string | null

Who wrote it: a person's record ID. With an API key, the person who created the key.

body_blocks
object[] | null

The note as a formatted document, or null for a note written as plain text.