Skip to main content
PATCH
Update Session

Path Parameters

session_id
string
required

Body

application/json
title
string
start_date
string<date-time>

Start of the session window.

end_date
string<date-time>

End of the session window.

state
State · object

Opaque, caller-defined session state.

restore
boolean
default:false

Set to true to restore the entity from the database.

Response

Successful Response

id
string
required
title
string
required
state
State · object
required

Opaque, caller-defined session state.

created_at
string<date-time>
required

The date and time when the entity was created in ISO format.

updated_at
string<date-time>
required

The date and time when the entity was last updated in ISO format.

created_by_user_id
string
required

The user who originally created the entity.

created_by_identity_type
enum<string>
required

The type of identity that created the entity.

Available options:
user,
service_account
account_id
string
required

The ID of the account that owns the given entity.

start_date
string<date-time>

Start of the session window.

end_date
string<date-time>

End of the session window.

archived_at
string<date-time>

The date and time when the entity was archived in ISO format.