Skip to main content
PUT
cURL

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-Client-Id
string
required

The location id of the practice

Path Parameters

id
string
required

The ID of the staff task to update

Body

application/json

Fields to update on the staff task

title
string

The title of the task

description
string

A detailed description of the task

task_type
enum<string>

The type of staff task. Allowed values: task, rx_refill

Available options:
task,
rx_refill
status
enum<string>

The status of the task. Setting to completed or canceled will automatically set finalized_at. Setting back to pending will clear finalized_at.

Available options:
pending,
completed,
canceled
client_id
string

The ID of the client to associate with this task

patient_id
string

The ID of the patient to associate with this task

reference_time_at
string<date-time>

A reference timestamp for the task in ISO 8601 format

Response

Staff task updated

success
boolean
required
data
object
required
message
string