Create a new session in a room
POST
/rooms/{id}/sessions
Request
Path Params
Body Params application/jsonRequired
Responses
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/rooms//sessions' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
"title": "string",
"description": "string",
"mode": "webcam",
"scheduled_start_time": "2019-08-24T14:15:22.123Z",
"preset_id": "8384f842-5f4b-4499-a68f-d027dfe5de2e"
}'Response Response Example
{
"success": true,
"data": {
"session": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"room_id": "05451321-18e1-4bfa-aa22-dfd0080cc120",
"room": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"host_id": "eb4e20fc-2b4a-4d0c-811f-48abcf12b89b",
"host": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"external_user_id": "24410722-0372-4ab1-bb0b-9795f8826466",
"organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
"email": "user@example.com",
"username": "string",
"role": "host",
"is_active": true,
"created_at": "2019-08-24T14:15:22.123Z"
},
"library_id": "21f784c9-c915-48d4-a805-f15b3e01b084",
"title": "string",
"description": "string",
"analytics": {
"google_tag_manager": {
"container_id": "GTM-XXXXXX",
"enabled": true
}
},
"active_session_id": "72e214e7-a772-4baa-93e7-db914aa978ef",
"created_at": "2019-08-24T14:15:22.123Z",
"updated_at": "2019-08-24T14:15:22.123Z"
},
"preset": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"library_id": "21f784c9-c915-48d4-a805-f15b3e01b084",
"name": "string",
"type": "whip",
"stage_enabled": true,
"max_join_limit": 0,
"chat_enabled": true,
"poll_enabled": true,
"viewer_count_visible": true,
"primary_color": "string",
"logo": "string",
"logo_destination_url": "string",
"host_add_co_host": true,
"host_camera_enabled": true,
"host_screen_share": true,
"host_chat_send_text": true,
"host_chat_send_file": true,
"host_chat_receive_message": true,
"host_poll_create": true,
"host_poll_vote": true,
"host_poll_view": true,
"onstage_camera_enabled": true,
"onstage_screen_share": true,
"onstage_viewer_view": true,
"audience_stage_join_request": true,
"audience_can_see_participants": true,
"audience_chat_send_text": true,
"audience_chat_send_file": true,
"audience_chat_receive_message": true,
"audience_poll_create": true,
"audience_poll_vote": true,
"audience_poll_view": true,
"moderator_manage_stage": true,
"moderator_manage_chat": true,
"moderator_manage_poll": true,
"recording_enabled": true,
"is_default": true,
"created_at": "2019-08-24T14:15:22.123Z",
"updated_at": "2019-08-24T14:15:22.123Z"
},
"title": "string",
"description": "string",
"status": "scheduled",
"mode": "webcam",
"started_at": "2019-08-24T14:15:22.123Z",
"ended_at": "2019-08-24T14:15:22.123Z",
"duration": 0,
"scheduled_start_time": "2019-08-24T14:15:22.123Z",
"viewer_count": 0,
"max_viewers": 0,
"recording_enabled": true,
"hls_url": "string",
"chat_enabled_override": true,
"stage_enabled_override": true,
"max_join_limit_override": 0,
"effective_chat_enabled": true,
"effective_stage_enabled": true,
"effective_max_join_limit": 0,
"created_at": "2019-08-24T14:15:22.123Z",
"updated_at": "2019-08-24T14:15:22.123Z"
},
"rtmp_url": "string",
"stream_key": "string"
},
"timestamp": 0
}Modified at 2026-02-10 08:32:56