Update an ambient session

PATCH /ambient-sessions/{correlationId}?api-version=2

Enables the caller to update the context of an ambient recording session or to specify the context of a session separately from its creation.

Parameters

Type	Name	Required	Description	Schema
Path	correlationId	Yes	The correlation ID of an existing ambient session. Allowed characters: letters, numbers, underscore (_), hyphen (-) and pipe (|).	String
Query	api-version	Yes	The supported API version. Must be set to 2.	Integer (int32)

HTTP headers

Name	Value
Content-Type	application/json
Authorization	Bearer <access token issued by your identity solution>
Accept	application/json

Request body

At least one of externalUserId and data must be provided.

Name	Required	Description	Schema
externalUserId	No	The partner-defined identifier of the user for whom the session is to be updated.	String
data	No	An optional JSON string containing context for the session.	Stringified JSON

Sample request

PATCH /ambient-sessions/3fa85f64-5717-4562-b3fc-2c963f66afa6?api-version=2
{
    "externalUserId": "aaa2b4d6-0a18-45ad-bd11-c2bc16597eee",
    "data": "{\"data\":\"test\"}"
}

Response codes

Code	Description	Links
200	Success. The ambient session is updated and returned.	No links
400	Bad request. Required validations aren't passed.	No links
401	Not authorized. The access token is missing or invalid.	No links
403	Forbidden. The caller isn't authorized to update the ambient session.	No links
404	Not found. The specified ambient session wasn't found.	No links
500	Internal server error. Any other exceptional scenario where the application isn't able to complete the request.	No links
5xx	The HTTP status is propagated from the handler application to the caller application for transparency of the problem.	No links

Response body

{
    "message": "OK"
}

Response body properties

Name	Description	Schema
message	Success message.	String