Skip to main content
PATCH
cURL
Updated:You can now update the ambient session context with new EMR context and medication orders.
Use this endpoint to update the for an . The API applies a field mask so you can send only the parts of the context you want to change. This is a PATCH operation that allows partial updates to the session context.

Comparison with POST Context

Authorizations

sdp_suki_token
string
header
required

Suki access token for the authenticated provider. Obtain this by calling Login or Register with a valid partner_token. Pass the suki_token value from the JSON response as the sdp_suki_token header on REST requests and non-browser WebSocket upgrades. Browser WebSocket clients pass the token in Sec-WebSocket-Protocol instead. Tokens expire after one hour; call Login again to refresh.

Headers

sdp_provider_id
string

Optional - Stable identifier for the active provider. Omit for standard partners whose partner_token identifies the user. Required for Bearer partners and Single Auth Token authentication where multiple providers share one partner_token. Use the same provider_id you sent on Login or Register.

Example:

"provider-123"

Path Parameters

ambient_session_id
string
required

UUID for the ambient session. Use the ambient_session_id returned from Create Ambient Session, or the UUID you supplied in that request.

Body

application/json

Partial ambient session context update. Include only the fields you want to add or change.

diagnoses
object

Optional - Diagnoses to add or update.

emr
object

Optional - EMR context to add or update.

orders
object

Optional - Medication orders to add or update.

patient
object

Optional - Patient demographics to add or update.

provider
object

Optional - Provider details to add or update.

sections
object[]

Optional - Information about the sections to be generated. If not provided, all supported note-sections will be generated.

visit
object

Optional - Visit details to add or update.

Response

Request succeeded.

Updated ambient session context after a successful PATCH.

context
object

Updated context for the session

Last modified on May 22, 2026