Event Management

Update a Webinar

Updates a webinar.

  • 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.

Conditions & Restrictions

In order to update a webinar, certain contitions must be met.

  • title, languageCd, countryCd and campaignCode can be modified at any time

  • liveStart, liveDuration and eventType can be modified 2 or more hours before the event starts.

  • liveStart can not be modified to a time within the next 2 hours

  • Supported event types:

    • screenshare
    • webcam
    • microphone
    • ondemand
    • simulive
    • encodeonsite
    • sim2live
    • fav
    • FABNoScreenShare
  • eventType can not be changed for ondemand events

  • simulive events can be only changed into sim2live

  • sim2live events can be only changed into simulive

  • eventType can not be modified to ondemand, simulive and sim2live

  • liveDuration can not be changed for ondemand and simulive events

  • For events with associated countryCd, if the provided languageCd does not support countryCd and no countryCd is provided in the request, the country code is set as empty.

  • countryCd is validated against the provided or existent languageCd. (Example. if the languageCd is 'zh' the possible values are: CN|TW)

put/client/{clientId}/event/{eventId}

Request

  • Base URL: https://api.on24.com/wcc/api/v2
  • URL: https://api.on24.com/wcc/api/v2/client/{clientId}/event/{eventId}
  • Auth: one of:
    • API key in header AccessTokenKey
    • API key in header AccessTokenSecret

Path parameters

clientIdnumber required

The client id

eventIdnumber required

The event id

Headers

accessTokenKeystring required

client access token key

accessTokenSecretstring required

client access token secret

content-typestring required

Possible values: "application/x-www-form-urlencoded" or "multipart/formdata"

Response

OK

Changes

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