Skip to main content
PATCH
cURL

Path Parameters

sessionId
string<uuid>
required

The ID of the session.

Body

application/json
label
string | null

The new label for the session, up to 128 characters, without line breaks, tabs, or invisible characters. Send null or an empty string to remove the label. Leave it out to keep the current label. You can't change the label once the session's owner, or the user it was started on behalf of, is deleted.

Maximum string length: 128
metadata
object

The session's new metadata. It replaces every existing entry, so send the full set you want to keep, or an empty object to remove them all. Leave it out to keep the current metadata. Up to 20 entries, with the same rules as at creation, so a value can't be empty and a key can't contain =. You can't change the metadata once the session's owner, or the user it was started on behalf of, is deleted.

Response

Default Response

session
object
required