Create/Copy a Webinar
Creates a new Webinar or Forum. When an existing event id is provided in query parameter eventsource, a copy of that event is created instead.
- When an existing event id is provided in query parameter eventsource, the new event created by this Endpoint will copy all the other fields from this existing event except the liveStart and liveDuration.
- Any of the parameters can be overridden, all parameters in the Event Creation are accepted.
- Required form parameters: liveDuration and liveStart.
- The copy process will copy the event source's tags (funnel, campaign, sales) and resources uploaded to it (PDF,mp4, etc)
- liveDuration parameter conditions:
- When copying a webinar, users are able to provide a liveDuration value in 15 minute increments (e.g. 15, 30, 45, 60, etc.) up to 120 minutes.
- Above 120 minutes, increments will be 30 minutes up to 480 minutes.
- The maximum allowed liveDuration is 480 minutes.
- liveStart accepted date/time formats:
- MM/DD/YYYY hh:mm a (08/26/2016 09:00 AM)
- YYYY-MM-DDThh:mm:ss Default timezone will be Pacific Time. (2016-08-26T09:00:00)
- YYYY-MM-DDThh:mm:ss±zz:zz where ±zz:zz is timezone's offset (2016-08-26T09:00:00-07:00)
- JavaScript Date.toString() format is also supported (Wed Apr 04 2018 16:12:41 GMT+0200 (CEST) )
- tagCampaign parameter conditions:
- When copying a webinar users are allowed to add up to 10 custom tags via the tagCampaign parameter.
- Every tag that is associated with the webinar should be available in the tags array field in the response.
- The following characters can not be used and will result in an error: £$!%&*()}{@#~?><',"|=_+¬
- customAccountTag parameter conditions:
- Supported only for client accounts with enabled custom account tags.
- When copying a webinar for an account with enabled custom account tags, users are allowed to add up to 3 tag IDs
- Provided values must match configured client account values.
- languageCd / countryCd parameters conditions:
- Following are allowed pairs of language/country values when copying an event:
- Chinese (Simplified): languageCd="zh", countryCd="CN"
- Chinese (Traditional): languageCd="zh", countryCd="TW"
- English (UK): languageCd="en", countryCd="UK"
- For other languages, No countryCd is allowed.
- Following are allowed pairs of language/country values when copying an event:
- When copying a webinar, the following features will be copied from the source event unless their values are overriden:
- Title. In the following format: 'Copy of' + [source event name]
- Event Type
- Duration
- Language
- Funnel Tags
- Campaign Tags
- Custom Account Tags
- Registration page:
- Banner
- Registration fields
- Page design
- Email notifications configuration
- Videos and Slides
- Console customization
- Elements that are not copied:
- Start time
- Archive configuration
- Security configuration
Conditions & Restrictions
When creating a webinar, certain conditions must be met.
Webinar Type and Account Type are the primary data our REST API uses to determine whether you can create a webinar or not.
The following list shows which Account Types can create specific webinars.
Elite Pro Accounts
| Field Name | Platform Name |
|---|---|
| fav | Live Video and Audio (screen share) |
Elite Accounts
| Field Name | Platform Name |
|---|---|
| fav | Live Video and Audio (screen share) |
| Ondemand | On Demand Recording |
| Simulive | Simu-live |
| sim2live | Sim-2-live |
| encodeonsite | Broadcast Video |
| forum | Forum |
Kollective
For accounts using Kollective streaming, when the Kollective Delivery Setting is set to Kollective Only or Kollective with CDN failover, here are the webinars that are allowed to be created:
| Field Name | Platform Name |
|---|---|
| fav | Live Video and Audio (screen share) |
| encodeonsite | Broadcast Video |
Request
- Base URL: https://api.on24.com/wcc/api/v2
- URL: https://api.on24.com/wcc/api/v2/client/{clientId}/event
- Auth: one of:
- API key in header AccessTokenKey
- API key in header AccessTokenSecret
Path parameters
The event will be created under this client id
Query parameters
The id of an existing event from which fields for the new event will be copied
Headers
client access token key
client access token secret
Possible values: "application/x-www-form-urlencoded" or "multipart/formdata"
Response
Event Created. | Event Copied.
Changes
No recorded changes to this operation across all 1 revision of this API.