Skip to main content
POST
Complete Task

Headers

TENANT
string
required

The tenant you are making this request on behalf of

API-KEY
string
required

Your api key

Path Parameters

task_id
string
required

Response

Successful Response

id
string
required
title
string
required
status
enum<string>
required
Available options:
OPEN,
IN_PROGRESS,
COMPLETED,
CANCELLED
priority
enum<string>
required
Available options:
URGENT,
HIGH,
NORMAL,
LOW
creatorId
string
required
createdDate
string<date-time>
required
description
string | null
startDate
string<date-time> | null
dueDate
string<date-time> | null
patientId
string | null
opportunityId
string | null
assigneeId
string | null
teamId
string | null
locationId
string | null
targetNoteId
string | null
targetFaxId
string | null
targetDocumentId
string | null
completedById
string | null
completedDate
string<date-time> | null
updatedDate
string<date-time> | null
patient
PatientRef · object | null

Minimal patient reference for task display (id and name only).

assignee
ProviderTiny · object | null
team
TeamRef · object | null

Minimal team reference for task display.

creator
ProviderTiny · object | null
carePlan
CarePlanStepTiny · object | null

Minimal care-plan step reference for task/event display.