Skip to main content
PATCH
Update a telephone encounter
Use the encounter’s id from GET /telephone-encounters. Send status, assigned_to_id, or both.

Request Parameters

  • status (string, optional): "addressed" marks the encounter Addressed, which also locks it in the EHR.
  • assigned_to_id (string, optional): Staff ehr_id from GET /staff to reassign the encounter to.

Example Request

Example Response

Webhook Events

You’ll receive a telephone_encounter.updated webhook with the updated encounter (the same object as GET /telephone-encounters) plus updated_fields, or telephone_encounter.update_failed if the update can’t be applied. See Operation Events.

Authorizations

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

Path Parameters

id
string
required

Cobalt telephone encounter ID (the id from GET /v1/telephone-encounters).

Example:

"encounter-123"

Body

application/json
status
enum<string>

Set to "addressed" to mark the encounter Addressed (this also locks it in the EHR).

Available options:
addressed
Example:

"addressed"

assigned_to_id
string

Reassign the encounter to this staff member: a staff ehr_id from GET /v1/staff.

Example:

"staff-123"

callback_urls
string[]

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

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

Telephone encounter update queued

success
boolean
required
Example:

true

message
string
required
Example:

"Telephone encounter update processing. A webhook event will be sent upon completion."

telephone_encounter_id
string
required
Example:

"encounter-123"

job_id
required
Example:

1234