tasks

Update a task

Applies a partial update to an existing task. Only the fields you send are changed; everything else on the task is left as it is.

Setting description replaces any rich text the task carries, so the text you send is what staff see in the app.

patch/tasks/{id}

Request

Base URL: https://api.ritten.io/v1
URL: https://api.ritten.io/v1/tasks/{id}
Auth: none declared

Path parameters

idstring uuid required

ID of the task to update.

Request body

titlestring

Short summary of the task. Unstructured clinical free text; may contain PHI.

descriptionstring

Unstructured clinical free text; may contain PHI. Replaces any rich text the task carries.

assigneeIdstring uuid

The staff user to assign the task to. Must be an active staff user.

priority'Low' | 'Medium' | 'High'

status'New' | 'Working' | 'Complete' | 'Won't Do'

dueDatestring date

Date the task is due. Send an empty string to clear an existing due date.

Example request

{
  "status": "Complete"
}

Response

Task updated successfully.

idstring uuid

titlestring

descriptionstring

status'New' | 'Working' | 'Complete' | 'Won't Do'

priority'Low' | 'Medium' | 'High'

assigneeIdstring uuid nullable

The user the task is assigned to, or null if unassigned.

createdByIdstring uuid nullable

The user who created the task, or null if it was created by an automation.

patientIdstring uuid nullable

The client the task is linked to, or null if it is not client-linked.

dueDatestring date nullable

The date the task is due, or null if it has no due date.

createdAtstring date-time

updatedAtstring date-time nullable

When the task was last updated, or null if it has never been updated.

statusUpdatedAtstring date-time nullable

When the task's status last changed, or null if it has never changed.

Example response

{
  "id": "182c2e54-3494-4b85-aba5-038cf539d5bf",
  "title": "Call the pharmacy",
  "description": "Confirm the refill went through.",
  "assigneeId": "9a5e64b0-0a73-4cb5-ab32-44fea16da4e1",
  "dueDate": "2024-01-31",
  "createdAt": "2024-01-01T00:00:00Z",
  "updatedAt": "2024-01-02T00:00:00Z",
  "statusUpdatedAt": "2024-01-02T00:00:00Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.