Skip to main content
POST
Create a note
Use the Cobalt appointment_id. The appointment_id parameter should be the Cobalt appointment ID returned from API responses or GET endpoints, not the EHR appointment ID.
The note parameter accepts a structured object with separate fields for clinical documentation, along with optional ICD-10 and CPT codes. The note keys depend on the connected EHR: use the HPI format (hpi, exam, assessment, treatment) or the SOAP format (subjective, objective, assessment, plan), as the examples below show.

Example Request (HPI format)

Example Request (SOAP format)

Example Response

Webhook Notifications

When the note processing is complete, we will send a webhook to your registered endpoint. Here are examples of what those webhook payloads will look like: See the Webhook Events reference for the full field breakdown and error codes.

Success

Failure

Authorizations

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

Body

application/json
note
required

Clinical note content. A plain string for scribe/dictation, or a structured object for RPA upload.

Example:

"Chief complaint: headache. Assessment: tension headache. Plan: OTC analgesics."

icd_10_codes

ICD-10 diagnosis codes. An array of codes, or an object shaped { codes: [...] } / { selected_codes: { codes: [...] } }.

Example:
cpt_codes
string[]

CPT procedure codes.

Example:
mrn
string

Patient Medical Record Number. Provide mrn + appointment_date, or appointment_id, to identify the appointment.

Example:

"12345"

appointment_date
string

Appointment date (ISO 8601, YYYY-MM-DD). Used with mrn to identify the appointment.

Example:

"2026-06-15"

appointment_id
string

Cobalt appointment ID (UUID, with or without dashes). Alternative to mrn + appointment_date.

Example:

"a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4"

force
string

When "true", upload the note even if the appointment is already processed. One of: "true", "false".

Example:

"false"

callback_urls
string[]

URLs to receive the completion webhook for this note, in addition to the account webhook.

Example:

Response

Note queued for upload

success
boolean
required
message
string
required
job_id
required