Skip to main content
PATCH
Update Session
Update session metadata — patient_details, templates, language_hint, etc. Send only the fields you want to change.
session_mode and model can only be changed before End Session — afterwards the call returns 409.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

session_id
string
required

Session ID returned by Create Session

Example:

"ses_abc123def456"

Body

application/json
patient_details
object

Patient demographic / identifier metadata. The oid key is promoted to patient_oid for indexing.

templates
string[]

Replace the requested template IDs (up to 2).

language_hint
string[]

ISO 639-1 code(s) hinting the spoken language(s).

additional_data
object

Arbitrary pass-through metadata merged into the session.

session_mode
enum<string>

Updatable only before the session is committed (End Session).

Available options:
consultation,
dictation
model
enum<string>

Updatable only before the session is committed (End Session).

Available options:
pro,
lite
user_status
string

Client-side session status marker.

processing_status
string

Processing status override (advanced use).

Response

Session updated

session_id
string
status
string
Example:

"success"

message
string
Example:

"Session updated successfully"