RIringcentral
Registration Management

Update Registration Session

Updates a Session by ID.

This is a PARTIAL update (PATCH), client may call it providing only attributes which are to be changed.

A caller must be an authorized user: either a host of the webinar or an IT Admin: a user from host's account with "WebinarSettings" permission.

If a session record with given ID doesn't exist on Registration Service side the API should return HTTP 404.

patch/webinar/registration/v1/sessions/{sessionId}

Request

Path parameters

sessionIdstring required

Identifier of the Session.

Request body

idstring required

ID of the session

registrationStatus'Open' | 'Closed' required

Status of the registration

registrationPageUristring uri

The URI of the registration landing page

brandingDescriptorUristring uri

The URI of the branding descriptor

registrantCountinteger required

The current number of registrants

hasRealRegistrantsboolean required

Indicates that there are non-test registrants

icalendarSequenceinteger

Sequence number for iCalendar email attachments

Example request

{
  "id": "123456789",
  "registrationStatus": "Open",
  "registrationPageUri": "https://abcde12345.webinar.ringcentral.com/register",
  "brandingDescriptorUri": "https://abcde12345.webinar.ringcentral.com/branding",
  "registrantCount": 10,
  "hasRealRegistrants": true
}

Response

Successful response

idstring required

ID of the session

registrationStatus'Open' | 'Closed' required

Status of the registration

registrationPageUristring uri

The URI of the registration landing page

brandingDescriptorUristring uri

The URI of the branding descriptor

registrantCountinteger required

The current number of registrants

hasRealRegistrantsboolean required

Indicates that there are non-test registrants

icalendarSequenceinteger

Sequence number for iCalendar email attachments

Example response

{
  "id": "123456789",
  "registrationStatus": "Open",
  "registrationPageUri": "https://abcde12345.webinar.ringcentral.com/register",
  "brandingDescriptorUri": "https://abcde12345.webinar.ringcentral.com/branding",
  "registrantCount": 10,
  "hasRealRegistrants": true
}

Changes

No recorded changes to this operation across all 1 revision of this API.