Create a Webcast

POST
/api/v1/scheduled-events

Request Parameters

Name Type Description Required
title string Webcast title Yes
description string Webcast description
startDate string Start date and time.

Must match this format:
2017-07-12T13:00:00Z

Yes
endDate string End date and time.

Must match this format:
2017-07-12T14:00:00Z

Yes
eventAdminId string User GUID for the webcast admin. Yes
presentationProfileId string GUID for the presentation profile Yes
automatedWebcast string true / false
accessControl string Public / AllUsers / Private Yes
isPublic string true / false Set to false by default.
password string Optional, but only used with isPublic set to true.
pollsEnabled string true / false
chatEnabled string true / false
questionAndAnswerEnabled string true / false
QuestionOption string IDENTIFIED = Anonymous questions not enabled
SELFSELECT = Users can optionally choose to make their questions anonymous
ANONYMOUS = All questions will be submitted anonymously
moderatorIds string GUIDs for users that will serve as webcast moderators.
userIds [] string GUIDs for users on the access control list. Only used with Private events.
groupIds string GUID’s for groups on the access control list. Only used with Private events.

Example Request

{
  "title": "CEO Townhall",
  "description": "Join us for a company update",
  "startDate": "2017-07-12T13:00:00Z",
  "endDate": "2017-07-12T14:00:00Z",
  "eventAdminId": "796629d3-d0e5-4d06-b923-f983ca47433c",
  "presentationProfileId": "a19546d4-9810-46cd-87ee-f8b1859fb5cb",
  "automatedWebcast": false,
  "accessControl": "Public",
  "isPublic": true,
  "password": "12345",
  "pollsEnabled": true,
  "chatEnabled": true,
  "questionAndAnswerEnabled": true,
  "QuestionOption": "SELFSELECT",
  "moderatorIds": [
    "addb047d-8076-459f-b0df-a8cdb7d168ec"
  ],
  "userIds": [
    "681831e6-5ec7-459d-a4a7-406f31f9a26c"
  ],

  "groupIds": [
    "4f492be4-1b36-49ea-8000-4ea52ae6c7fe"
  ]
}

Example Response

{
  "eventId": "sdfdf2be4-ffgf-22ea-3dd0-52345wafraw4"
}

Response Codes

Code Description
200 ok
401 Unauthorized error
500 Internal server error

Edit a Webcast

PUT
/api/v1/scheduled-events/{eventId}

Request Parameters

Name Type Description Required
eventId path Webcast GUID Yes
title string Webcast title Yes
description string Webcast description
startDate string Start date and time.

Must match this format:
2017-07-12T13:00:00Z

Yes
endDate string End date and time.

Must match this format:
2017-07-12T14:00:00Z

Yes
eventAdminId string User GUID for the webcast admin. Yes
presentationProfileId string GUID for the presentation profile Yes
automatedWebcast string true / false
accessControl string Public / AllUsers / Private Yes
isPublic true / false Set to false by default.
password string Optional, but only used with isPublic set to true.
pollsEnabled string true / false
chatEnabled string true / false
questionAndAnswerEnabled string true / false
QuestionOption string IDENTIFIED = Not enabled
SELFSELECT = Users can optionally choose to make their questions anonymous
ANONYMOUS = All questions will be submitted anonymously
moderatorIds string GUIDs for users that will serve as webcast moderators.
userIds [] string GUIDs for users on the access control list. Only used with Private events.
groupIds string GUID’s for groups on the access control list. Only used with Private events.

Example Request

{
  "title": "CEO Townhall",
  "description": "Join us for a company update",
  "startDate": "2017-07-12T13:00:00Z",
  "endDate": "2017-07-12T14:00:00Z",
  "eventAdminId": "796629d3-d0e5-4d06-b923-f983ca47433c",
  "presentationProfileId": "a19546d4-9810-46cd-87ee-f8b1859fb5cb",
  "automatedWebcast": false,
  "accessControl": "Public",
  "isPublic": true,
  "password": "12345",
  "pollsEnabled": true,
  "chatEnabled": true,
  "questionAndAnswerEnabled": true,
  "QuestionOption": SELFSELECT,
  "moderatorIds": [
    "addb047d-8076-459f-b0df-a8cdb7d168ec"
  ],
  "userIds": [
    "681831e6-5ec7-459d-a4a7-406f31f9a26c"
  ],

  "groupIds": [
    "4f492be4-1b36-49ea-8000-4ea52ae6c7fe"
  ]
}

Response Codes

Code Description
200 ok
401 Unauthorized error
500 Internal server error

Update Webcast Access Control

These settings are used with Private webcasts. Useful to dynamically add users or groups with custom integrations to webcast events.

PUT
/api/v1/scheduled-events/{eventId}/access-control

Request Parameters

Name Type Description Required
eventId string Webcast GUID Yes
userIds [] string GUIDs for users on the access control list.
usernames[] string Usernames for users on the access control list.
groupIds string GUID’s for groups on the access control list.

Example Request

{
  "userIds": [
    "796629d3-d0e5-4d06-b923-f983ca47433c",
    "addb047d-8076-459f-b0df-a8cdb7d168ec"
  ],
  "usernames": [
    "user5",
    "user55",
    "admin"
  ],
  "groupIds": [
    "452329d3-d0e5-4d06-b923-f983ca47433c"
  ]
}

Response Codes

Code Description
200 ok
401 Unauthorized error
500 Internal server error