Add a note to a schedule
curl --request POST \
--url https://{organization}.rescueconsole.com/api/shifts/schedules/{id}/notes \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"body": "Ana will cover the first hour and leave at 11."
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({body: JSON.stringify('Ana will cover the first hour and leave at 11.')})
};
fetch('https://{organization}.rescueconsole.com/api/shifts/schedules/{id}/notes', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{organization}.rescueconsole.com/api/shifts/schedules/{id}/notes"
payload = { "body": "Ana will cover the first hour and leave at 11." }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"id": "<string>",
"body": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"author_person_id": "<string>",
"body_blocks": [
{}
]
}{
"error": "house_trained must be 1, 0 or null (not assessed)"
}{
"error": "house_trained must be 1, 0 or null (not assessed)"
}{
"error": "house_trained must be 1, 0 or null (not assessed)"
}{
"error": "house_trained must be 1, 0 or null (not assessed)"
}Shift schedules
Add a note to a schedule
Adds a note, written as the person who created the key. Send body as plain text, or body_blocks for a formatted note. Needs write on Shifts.
A coordinator’s: needs write on Shifts AND read on People. A key without read on People is refused (403) with “Only a coordinator can do this: it needs permission to see People.”
POST
/
api
/
shifts
/
schedules
/
{id}
/
notes
Add a note to a schedule
curl --request POST \
--url https://{organization}.rescueconsole.com/api/shifts/schedules/{id}/notes \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"body": "Ana will cover the first hour and leave at 11."
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({body: JSON.stringify('Ana will cover the first hour and leave at 11.')})
};
fetch('https://{organization}.rescueconsole.com/api/shifts/schedules/{id}/notes', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{organization}.rescueconsole.com/api/shifts/schedules/{id}/notes"
payload = { "body": "Ana will cover the first hour and leave at 11." }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"id": "<string>",
"body": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"author_person_id": "<string>",
"body_blocks": [
{}
]
}{
"error": "house_trained must be 1, 0 or null (not assessed)"
}{
"error": "house_trained must be 1, 0 or null (not assessed)"
}{
"error": "house_trained must be 1, 0 or null (not assessed)"
}{
"error": "house_trained must be 1, 0 or null (not assessed)"
}Authorizations
An API key from Settings, API keys. It starts with rc_live_.
Path Parameters
The schedule's ID.
Body
application/json
Response
The note.
The note as plain text, also when it was written as a formatted note.
Who wrote it: a person's record ID. With an API key, the person who created the key.
The note as a formatted document, or null for a note written as plain text.