Skip to main content
POST
Create Task
Depending on the EMR system connected to the account, additional fields beyond the base required fields may be required. If a conditionally required field is missing, the API will return a 400 error specifying the missing field.

Request Parameters

Required Fields

These fields are always required regardless of the connected EMR:
  • description (string, required): Task description/body content
  • patient_mrn (string, required): Medical Record Number (MRN) of the patient

Conditionally Required Fields

Depending on the connected EMR, some combination of the following fields will also be required:
  • subject (string, conditionally required): Task title/subject line
  • assignee_user_id (string, conditionally required): EMR user ID to assign the task to
  • phone_call_type_id (string, conditionally required): Identifier for the phone call type
  • notify_list (string[], optional): List of user identifiers to notify about the task. Must be an array of strings if provided.

Example Requests

Example Response

The response includes:
  • task_id: Unique identifier for the created task record
  • job_id: Job execution identifier for tracking the async operation

Error Responses

Missing Required Field

If a required or conditionally required field is missing, the API returns a 400 with the specific field name:

User Not Found

Webhook Notifications

When the task processing is complete, we will send a webhook to your registered endpoint. Here are examples of what those webhook payloads will look like:

Success

Failure

Authorizations

client_id
string
header
required
client_secret
string
header
required
access_token
string
header
required

Body

application/json
description
string
required

Task description/body content

patient_mrn
string
required

Medical Record Number (MRN) of the patient

subject
string

Task title/subject line. Conditionally required depending on the connected EMR.

assignee_user_id
string

EMR user ID to assign the task to. Conditionally required depending on the connected EMR.

phone_call_type_id
string

Identifier for the phone call type. Conditionally required depending on the connected EMR.

notify_list
string[]

List of user identifiers to notify about the task. Optional.

Response

Task queued successfully

success
boolean
message
string
task_id
string

Unique identifier for the created task record

job_id
integer

Job execution identifier for tracking the async operation