v1

latestOpenAPI 3.0.3RingCentral API License Agreement2026-08-064871,2921.5 MB

Webinars and Sessions

Update Webinar Session

Updates a Webinar Session. The payload may contain certain attributes from the Session resource (it is a partial update). Changing the 'status' field usually invokes certain workflow actions. Updating a Session in 'Active' or 'Finished' status is prohibited. Some status transitions (for example, to 'Active" or 'Finished') may be prohibited.

patch/webinar/configuration/v1/webinars/{webinarId}/sessions/{sessionId}

Request body

scheduledStartTimestring date-time required

Session scheduled start time.

scheduledDurationinteger required

The duration of the Session in seconds.

timeZonestring required

IANA-compatible time zone name (see https://www.iana.org/time-zones).

localizedTimeZoneDescriptionstring

Localized time zone description.

panelJoinTimeOffsetinteger

The time offset (positive, in seconds) indicating how much in advance (comparing to "scheduledStartTime") panel members should join for the pre-webinar team sync

titlestring

Session title. Can be left blank - then Webinar title should be used for presentation.

descriptionstring

User-friendly description of the Session. Can be left blank - then Webinar title should be used for presentation.

status'Scheduled' | 'Active' | 'Finished'

Session status (for the purposes of Configuration service)

hostJoinUristring uri

The URI to join the webinar as a host

localeCodestring

Session locale code. Can't be blank or null

Example request

{
  "scheduledDuration": 1800,
  "timeZone": "America/New_York",
  "localizedTimeZoneDescription": "Eastern Time (America/New_York)",
  "panelJoinTimeOffset": 900,
  "title": "Live Broadcasting US",
  "description": "Live session for US-based participants",
  "status": "Scheduled",
  "hostJoinUri": "https://v.ringcentral.com/w/join/de7yd8ew7yfsdfjh899843rgj",
  "localeCode": "en-US"
}

Response

Successful response

idstring

Internal object ID

creationTimestring date-time required

Object creation time

lastModifiedTimestring date-time required

Object last modification time

scheduledStartTimestring date-time required

Session scheduled start time.

scheduledDurationinteger required

The duration of the Session in seconds.

timeZonestring required

IANA-compatible time zone name (see https://www.iana.org/time-zones).

localizedTimeZoneDescriptionstring

Localized time zone description.

panelJoinTimeOffsetinteger

The time offset (positive, in seconds) indicating how much in advance (comparing to "scheduledStartTime") panel members should join for the pre-webinar team sync

titlestring

Session title. Can be left blank - then Webinar title should be used for presentation.

descriptionstring

User-friendly description of the Session. Can be left blank - then Webinar title should be used for presentation.

status'Scheduled' | 'Active' | 'Finished'

Session status (for the purposes of Configuration service)

hostJoinUristring uri

The URI to join the webinar as a host

localeCodestring

Session locale code. Can't be blank or null

videoBridgeIdstring

The RCV bridge id

videoBridgePasswordstring password

The RCV bridge password. Returned only if requested by Host/Co-host/Panelist and a password for the bridge is set.

videoBridgePstnPasswordstring password

The RCV bridge PSTN password. Returned only if requested by Host/Co-host/Panelist and a PSTN password for the bridge is set.

attendeeJoinUristring uri

The URI for attendees to join the Webinar (if it is a public webinar)

hasUnsentInvitesboolean

Calculated attribute indicating if there are any unsent/deferred invites to session participants

Example response

{
  "id": "78654321",
  "scheduledDuration": 1800,
  "timeZone": "America/New_York",
  "localizedTimeZoneDescription": "Eastern Time (America/New_York)",
  "panelJoinTimeOffset": 900,
  "title": "Live Broadcasting US",
  "description": "Live session for US-based participants",
  "status": "Scheduled",
  "hostJoinUri": "https://v.ringcentral.com/w/join/de7yd8ew7yfsdfjh899843rgj",
  "localeCode": "en-US",
  "videoBridgeId": "839874770",
  "videoBridgePassword": "abc123",
  "videoBridgePstnPassword": "abc123",
  "attendeeJoinUri": "https://v.ringcentral.com/w/a/join/iuyef77fsj473wn10ashjfk34"
}