curl --request PATCH \
--url https://{organization}.rescueconsole.com/api/tasks/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"status": "done",
"notes": "Booked for 6 October at 9:00."
}
'const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({status: 'done', notes: 'Booked for 6 October at 9:00.'})
};
fetch('https://{organization}.rescueconsole.com/api/tasks/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{organization}.rescueconsole.com/api/tasks/{id}"
payload = {
"status": "done",
"notes": "Booked for 6 October at 9:00."
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text){
"task": {
"id": "<string>",
"title": "<string>",
"status": "open",
"priority": "low",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"notes": "<string>",
"due_on": "<string>",
"assignee_person_id": "<string>",
"entity_type": "person",
"entity_id": "<string>",
"medical_record_id": "<string>",
"created_by_person_id": "<string>",
"completed_at": "2023-11-07T05:31:56Z"
}
}{
"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)"
}Change a task
Send only what changes. This is also how a task is completed: send status: done, and completed_at is set to now; send status: open to reopen it, and completed_at is cleared. Saving a task that is already done does not move the date it was done. A task cannot be moved to a different record: delete it and create another. Needs write on the area of the record the task is on, or on any one area for a task on no record. A task your key may not read answers 404, the same as one that does not exist. Assigning it to somebody new sends them a notice, as Create a task does.
curl --request PATCH \
--url https://{organization}.rescueconsole.com/api/tasks/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"status": "done",
"notes": "Booked for 6 October at 9:00."
}
'const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({status: 'done', notes: 'Booked for 6 October at 9:00.'})
};
fetch('https://{organization}.rescueconsole.com/api/tasks/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{organization}.rescueconsole.com/api/tasks/{id}"
payload = {
"status": "done",
"notes": "Booked for 6 October at 9:00."
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text){
"task": {
"id": "<string>",
"title": "<string>",
"status": "open",
"priority": "low",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"notes": "<string>",
"due_on": "<string>",
"assignee_person_id": "<string>",
"entity_type": "person",
"entity_id": "<string>",
"medical_record_id": "<string>",
"created_by_person_id": "<string>",
"completed_at": "2023-11-07T05:31:56Z"
}
}{
"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 task's record ID.
Body
Send at least one field. An empty string clears notes, due_on or assignee_person_id, as null does. entity_type and entity_id are refused.
Cannot be empty.
done completes the task; open reopens it.
open, done low, normal, high The day it is due, YYYY-MM-DD.
The record ID of a person in your organization.
Response
The task, as it now is.
A task. The list returns exactly these fields; creating and changing a task return it as stored, which can carry more.
Show child attributes
Show child attributes