Skip to main content
POST
Append a note to a task
This endpoint appends a note to a task that already exists in the EMR. To find a task’s emr_task_id, perform a live fetch with POST /v1/patients/fetch and include: ["tasks"] — each task in the response carries its emr_task_id.

Request Parameters

  • emr_task_id (string, required): The EMR ID of the task to append the note to. Obtain this from the tasks[] array returned by POST /v1/patients/fetch with include: ["tasks"].
  • note (string, required): The note body content.

Example Request

Example Response

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

Error Responses

Missing Required Field

Unexpected Field

Only emr_task_id and note are accepted. Any other field returns a 400:

Webhook Notifications

When the task note processing is complete, we will send a webhook to your registered endpoint.

Success

Failure

Authorizations

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

Body

application/json
emr_task_id
string
required

EMR ID of the task to append the note to. Obtain it from the tasks[] array returned by POST /v1/patients/fetch with include: ["tasks"].

Example:

"task-emr-123"

note
string
required

Note text to append to the task.

Example:

"Called patient; left a message about their results."

callback_urls
string[]

URLs to receive the completion webhook for this task note.

Example:
expires_at
string<date-time> | null

Optional ISO 8601 timestamp with an explicit timezone offset, in the future when submitted. Cobalt starts no new operation attempt after this deadline and reports reasons[].code EXPIRED. An attempt already in progress, including write reconciliation, may finish after it.

Example:

"2027-06-15T14:30:00Z"

Response

Task note queued for processing

success
boolean
required
Example:

true

message
string
required
Example:

"Task queued for processing."

task_note_id
string
required
Example:

"task-note-123"

job_id
integer
required
Example:

1