---
title: "Create Webinar"
method: POST
path: "/webinar/configuration/v1/webinars"
tags: ["Webinars and Sessions"]
---

# Create Webinar

`POST /webinar/configuration/v1/webinars`

Creates a new webinar.

If "host" parameter is NOT passed then the current authorized user will become a Host.
If "host" parameter is passed then the caller must be a company administrator and have "WebinarSettings" permission.
"host.linkedUser.accountId" must be the same as authorized user's account ID.

The webinar settings which are not mandated at account level or are unlocked can be
specified. All other settings are defaulted according to account policy.

## Request body

- WebinarCreationRequest
  - `title` string, required — Webinar title
  - `description` string — User-friendly description of the Webinar
  - `settings` WcsWebinarSettingsModel — Various settings which define behavior of this Webinar's Sessions
    - `recordingEnabled` boolean — Indicates if recording is enabled (if false all other recording settings cannot be enabled)
    - `autoRecord` boolean — Indicates if recording should start automatically when a Webinar goes live
    - `recordingSharingEnabled` boolean — Indicates if recording can be shared (this setting is read-only at webinar level)
    - `recordingDownloadEnabled` boolean — Indicates if recording can be downloaded (this setting is read-only at webinar level)
    - `recordingDeletionEnabled` boolean — DEPRECATED AND REPLACED BY 'pastSessionDeletionEnabled' setting. Indicates if recording can be deleted (this setting is read-only at webinar level)
    - `pastSessionDeletionEnabled` boolean — Indicates if deletion of past session along with its artifacts is enabled for Host. This setting is read-only at webinar level
    - `panelistWaitingRoom` boolean — Indicates if Panelists should be places to waiting room after joining
    - `panelistVideoEnabled` boolean — Indicates if Panelists' video should be 'on' by default
    - `panelistScreenSharingEnabled` boolean — Indicates if Panelists' screen sharing should be 'on' by default
    - `panelistMuteControlEnabled` boolean — Indicates if Panelists can mute/unmute themselves by default
    - `panelistAuthentication` 'Guest' | 'AuthenticatedUser' | 'AuthenticatedCoworker' — Indicates if Panelists have to be authenticated users
    - `attendeeAuthentication` 'Guest' | 'AuthenticatedUser' | 'AuthenticatedCoworker' — Indicates if attendees have to be authenticated users
    - `artifactsAccessAuthentication` 'Guest' | 'AuthenticatedUser' | 'AuthenticatedCoworker' — Indicates who can access webinar artifacts. Applies to recordings at present. Applicable to other artifacts such as Q&A, Polls in the future.
    - `pstnEnabled` boolean — Indicates if dial-in PSTN audio option is enabled for Panelists
    - `password` string — Webinar password. If company-level "passwordEnabled" is true and "password" is null / omitted, the backend generates the password
    - `qnaEnabled` boolean — Indicates if Q&A is enabled for the webinar (if false all other Q&A settings cannot be enabled)
    - `qnaAnonymousEnabled` boolean — Indicates if anonymous Q&A is enabled for the webinar
    - `pollsEnabled` boolean — Indicates if polls are enabled for the webinar (if false all other polls settings cannot be enabled)
    - `pollsAnonymousEnabled` boolean — Indicates if anonymous poll answers are enabled for the webinar
    - `registrationEnabled` boolean — Indicates if a registration is enabled for the webinar (if false all other registration settings are ignored)
    - `postWebinarRedirectUri` string, uri — URI to redirect users after the webinar
    - `externalLivestreamEnabled` boolean — Indicates if livestreaming to external streaming provider is enabled
    - `moderatedQnaEnabled` boolean — Indicate if the moderated Q&A enabled for webinar
  - `host` RcwLinkedUserModel — The internal IDs of RC-authenticated users.
    - `linkedUser` RcwDomainUserModel
      - `userId` string, required — User ID
      - `accountId` string, required — Account ID
      - `domain` 'pbx' | 'ilm', required — Identity domain

## Response `201`

Successful response, new Webinar is created

- WcsWebinarResource
  - `id` string — Internal object ID
  - `creationTime` string, date-time, required — Object creation time
  - `lastModifiedTime` string, date-time, required — Object last modification time
  - `title` string — Webinar title
  - `description` string — User-friendly description of the Webinar
  - `settings` WcsWebinarSettingsModel — Various settings which define behavior of this Webinar's Sessions
    - `recordingEnabled` boolean — Indicates if recording is enabled (if false all other recording settings cannot be enabled)
    - `autoRecord` boolean — Indicates if recording should start automatically when a Webinar goes live
    - `recordingSharingEnabled` boolean — Indicates if recording can be shared (this setting is read-only at webinar level)
    - `recordingDownloadEnabled` boolean — Indicates if recording can be downloaded (this setting is read-only at webinar level)
    - `recordingDeletionEnabled` boolean — DEPRECATED AND REPLACED BY 'pastSessionDeletionEnabled' setting. Indicates if recording can be deleted (this setting is read-only at webinar level)
    - `pastSessionDeletionEnabled` boolean — Indicates if deletion of past session along with its artifacts is enabled for Host. This setting is read-only at webinar level
    - `panelistWaitingRoom` boolean — Indicates if Panelists should be places to waiting room after joining
    - `panelistVideoEnabled` boolean — Indicates if Panelists' video should be 'on' by default
    - `panelistScreenSharingEnabled` boolean — Indicates if Panelists' screen sharing should be 'on' by default
    - `panelistMuteControlEnabled` boolean — Indicates if Panelists can mute/unmute themselves by default
    - `panelistAuthentication` 'Guest' | 'AuthenticatedUser' | 'AuthenticatedCoworker' — Indicates if Panelists have to be authenticated users
    - `attendeeAuthentication` 'Guest' | 'AuthenticatedUser' | 'AuthenticatedCoworker' — Indicates if attendees have to be authenticated users
    - `artifactsAccessAuthentication` 'Guest' | 'AuthenticatedUser' | 'AuthenticatedCoworker' — Indicates who can access webinar artifacts. Applies to recordings at present. Applicable to other artifacts such as Q&A, Polls in the future.
    - `pstnEnabled` boolean — Indicates if dial-in PSTN audio option is enabled for Panelists
    - `password` string — Webinar password. If company-level "passwordEnabled" is true and "password" is null / omitted, the backend generates the password
    - `qnaEnabled` boolean — Indicates if Q&A is enabled for the webinar (if false all other Q&A settings cannot be enabled)
    - `qnaAnonymousEnabled` boolean — Indicates if anonymous Q&A is enabled for the webinar
    - `pollsEnabled` boolean — Indicates if polls are enabled for the webinar (if false all other polls settings cannot be enabled)
    - `pollsAnonymousEnabled` boolean — Indicates if anonymous poll answers are enabled for the webinar
    - `registrationEnabled` boolean — Indicates if a registration is enabled for the webinar (if false all other registration settings are ignored)
    - `postWebinarRedirectUri` string, uri — URI to redirect users after the webinar
    - `externalLivestreamEnabled` boolean — Indicates if livestreaming to external streaming provider is enabled
    - `moderatedQnaEnabled` boolean — Indicate if the moderated Q&A enabled for webinar
  - `host` WcsHostModel, required — The internal IDs of RC-authenticated users.
    - `entitled` boolean, required — Describes host's license, 'true' - license is active
    - `userId` string, required — User ID
    - `accountId` string, required — Account ID
    - `linkedUser` RcwDomainUserModel
      - `userId` string, required — User ID
      - `accountId` string, required — Account ID
      - `domain` 'pbx' | 'ilm', required — Identity domain

## Other responses

- `400` — General response with **HTTP 400 "Bad request"** status.<br> Reasons: unparsable request, path, query or body parameters are invalid. The error description may contain reference to particular parameter(s) which haven't passed the validation.
- `403` — General response with **HTTP 403 "Forbidden"** status.<br> Reasons: the requested operation is forbidden because of certain resource state, lack of permissions, feature unavailability, etc.
- `500` — General response with **HTTP 500 "Internal Server Error"** status.<br> Reasons: general server-side error.

---

[API](https://skmtc.net/ringcentral/apis/ringcentral-api.md) · [All operations](https://skmtc.net/ringcentral/apis/ringcentral-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ringcentral/ringcentral-api/revisions/8d602198ec97/schema)