⏫Updating Sessions
This step shows how to update sessions through GroupsAPI
Important Note! Constructor Groups’ V1 API has been retired and is no longer available to new customers. Please use the Groups V2 API going forward. Link to V2 API documentation: https://developer.perculus.com/v2-en
The below list explains all the available parameters when updating a session.
name
string
Session name
description
string
Session description
tags
string
A comma separated list of tags
duration
integer(min: 5)
Session duration
allow_recording
bool
Flag to determine if the session will be recorded
inaccessible_replay
bool
Flag to determine if the session's replay should be inaccessible
You can update the session by passing SESSION_ID as a parameter after all parameters. Example:
curl --location --request PUT 'https://<DOMAIN>/xapi/session/<SESSION_ID>' \
--header 'Authorization: Bearer <ACCESS_TOKEN>' \
--header 'Content-Type: application/json' \
--data '{
"name": "test session ",
"start_date": "2024-09-27T14:00:25.699Z",
"duration": "6",
"options": {
"allow_rating": false,
"chat": {
"offMessageModule": true,
"offGeneralMsging": false
},
"duration": {
"allowExtendTime": false,
"useRemainingTime": true
},
"allow_users_stream_self_cam_mic": false,
}
}'
Example Response:
{
"session_id": "<SESSION_ID>",
"name": "test session",
"description": "",
"tags": "",
"start_date": "2024-09-27T14:00:25.699+03:00",
"timezone": "Europe/Istanbul",
"duration": 6,
"lang": "tr-TR",
"status": 1,
"replay_status": 0,
"options": {
"allow_rating": false,
"preparation_time": 15,
"session_duration": 60,
"chat": {
"offMessageModule": true,
"offGeneralMsging": false,
"offGeneralMsgLimitForUser": false,
"offSpecialMsging": false,
"offSpecialMsgToAdmin": false,
"offSpecialMsgToUser": false,
"offNewMsgSound": false,
"offClearForReplay": false,
"onNewMsgSoundInAll": false,
"onNewMsgNotifyInAll": false
},
"duration": {
"allowExtendTime": false,
"useRemainingTime": true
},
"allow_users_stream_self_cam_mic": false,
"hide_user_streams": false,
"enable_attendance_check": false,
"enable_simultaneous_interpretation": false,
"enable_simultaneous_interpretation_for_users": false,
"start_active": false,
"return_url": ""
},
"creation_date": "2024-08-01T22:53:46.5570837+00:00",
"updating_date": null
}
Last updated
Was this helpful?