Tasks

Update an existing task

This is a partial update endpoint — only fields included in the request body are modified. All fields are optional. Fields not included in the request will remain unchanged.

Please note: All dates listed (creation times, due dates, reminder dates) are listed in UTC, so you'll want to adjust for your local timezone.

patch/tasks/{task_id}

Request

  • Base URL: https://clinic-subdomain.md-hq.com/api/v1
  • URL: https://clinic-subdomain.md-hq.com/api/v1/tasks/{task_id}
  • Auth: HTTP basic

Path parameters

task_idinteger required

Request body

dr_idinteger

A valid ID of a non-archived, non-resource user who the task is being added for.

subjectstring
priority'low' | 'normal' | 'high'
notesstring
pt_idinteger

A valid ID of a non-archived patient to associate with the task.

due_datestring date-time

A time stamp (YYYY-MM-DD HH:MM:SS format) representing the due date for this task.

remind_minutes_beforeinteger

Represents the number of minutes before your due date to remind the user of the task (due_date must be set).

completed_onstring date-time nullable

Marks the task as complete or incomplete. Pass a valid timestamp (YYYY-MM-DD HH:MM:SS format) to mark complete. The date must be today or in the past — future dates are rejected. Pass null or false to reset the task to incomplete.

associated_resource_type'soap' | 'documents' nullable

Links the task to a resource type (encounter note or document). Pass null or empty to unlink. If set, associated_resource_id must also be provided. If a pt_id is set, the linked resource must belong to the same patient.

associated_resource_idinteger

The ID of the linked resource. Required when associated_resource_type is set.

Response

OK

Changes

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