Skip to main content
POST
Create a task

Authorizations

Authorization
string
header
required

Marketplace API key

Headers

idempotency-key
string

Client-generated key protecting retries for 24 hours

X-Organization-Id
string
required

Target clinic organization ID

Body

application/json
notes
string
required

Task description / notes

Example:

"Review missing plan for Impression #3: Irritant Contact Dermatitis"

noteId
string

Note (visit) to attach the task to. Send exactly one of noteId or patientId.

Example:

"3cc73cb6-9c59-403c-a910-8af6c5693b25"

patientId
string

Patient whose chart the task goes on, with no visit — for a chart that has no note yet (a new referral). Send exactly one of noteId or patientId. Patient tasks are supported where GET /tasks/capabilities reports patientAnchor; elsewhere they are refused with 400 capability_unsupported.

Example:

"8de03039-3a9e-417a-b2b3-a8b8df183631"

providerId
string

Provider whose EHR login creates the task. Required with noteId. With patientId it is optional: omitted, the task is created by the practice's system EHR user.

Example:

"d4e5f6a7-b8c9-4d0e-1f2a-3b4c5d6e7f8a"

assigneeIds
string[]

Provider IDs to assign the task to. A task needs at least one assignee or assignee group; with noteId, at least one provider is required.

Example:
assigneeGroupIds
string[]

EHR staff-group ids from GET /tasks/assignee-groups (e.g. the practice's Billing group). Patient tasks only.

Example:
type
string

EHR task type, using the EHR's own enum name (ModMed: REVIEW, OBTAIN, COMMUNICATION, …). Omitted: REVIEW. Patient tasks only.

Example:

"OBTAIN"

details
string

EHR task details label (ModMed: INSURANCE, …). Omitted: Normal. Patient tasks only.

Example:

"INSURANCE"

priority
enum<string>

Omitted: NORMAL. Patient tasks only.

Available options:
NORMAL,
HIGH
Example:

"NORMAL"

dueDate
string

Due date (YYYY-MM-DD), today or later. Patient tasks only, on EHRs whose GET /tasks/capabilities reports dueDate; elsewhere 400 capability_unsupported.

Example:

"2026-11-13"

Response

Success

code
string
required

Response code

Example:

"success"

data
object
required