Page optimized for desktop experience. Please use a desktop browser for best compatibility.

Patch Webcast Data

The Patch Webcast Data endpoint partially edits the details of a webcast. Use this endpoint to update specific webcast fields you designate. You do not need to provide the fields that you are not changing.

PATCH
/api/v2/scheduled-events/{eventId}

Usage Notes

Webcast status determines which fields are modifiable. Only fields that are able to be modified by the PUT endpoint are allowed to be modified.

Request Body

application/jsonpatch

Refer to http://jsonpatch.com/ for the format of the request body.

Operations supported:

  • add
  • remove
  • copy
  • replace
  • test
  • move

Body Examples

If the webcast pre-production or main event is in progress, only fields available for inline editing may be patched/edited. This includes the following fields:

{
"title": "nostrud ea velit qui",
"description": "minim laborum proident",
"eventAdminIds": [
"nulla Ut",
"laborum ea"
],
"eventAdminEmails": [
"id in sint",
"pariatur adipisicing laborum"
],
"eventAdmins": [
{
"email": "laboris ut incididunt Duis",
"firstName": "exercitation adipisicing nisi incididu",
"lastName": "in velit",
"isPrimary": false
},
{
"email": "exercitation elit nostrud tempor esse",
"firstName": "mollit culpa",
"lastName": "ea ipsum",
"isPrimary": true
}
],
"pollsEnabled": false,
"chatEnabled": true,
"questionAndAnswerEnabled": true,
"userIds": [
"sed enim veniam qui",
"quis exercitat"
],
"groupIds": [
"ut ipsum dolor",
"anim id"
],
"moderatorIds": [
"tempor occaecat",
"laborum Lorem exercitation"
],
"moderators": [
{
"email": "elit esse dolor",
"firstName": "elit aliquip sint eu",
"lastName": "in laborum deserunt fugiat"
},
{
"email": "quis commodo deserunt sit ea",
"firstName": "id reprehenderit",
"lastName": "aute ea incididunt"
}
],
"password": "commodo",
"questionOption": "do quis exercitation voluptate",
"presentationFileDownloadAllowed": false,
"categories": [
"ullamco q",
"voluptate non fugiat mollit"
],
"tags": [
"reprehenderit sunt consectetur aliqua",
"Duis id in proident"
],
"unlisted": true,
"estimatedAttendees": 35104635,
"LinkedVideoId": "elit labore cillum",
"AutoAssociateVod": false,
"RedirectVod": true,
"RegistrationFieldIds": [
"do dolor ipsum",
"Ut Duis"
],
"CustomFields": [
{
"id": "deserunt cillum l",
"value": "dolor enim ex officia pariatur",
"name": "laboris eu proident"
},
{
"id": "Duis pro",
"value": "anim in",
"name": "eiusmod tempor veniam"
}
],
"hideShareUrl": true
}

If the webcast main event has been run once, only fields available after the webcast has ended are available for editing. That includes all fields with the exception of the following:

{
"startDate": "1962-07-04T05:07:34.321Z",
"endDate": "2005-02-02T06:18:20.773Z",
"lobbyTimeMinutes": 69713713,
"preProduction": {
"duration": "nostrud",
"userIds": [
"ea consectetur sed in",
"proident in laboris do"
],
"groupIds": [
"voluptate mollit",
"veniam sit"
]
}

If the webcast end time has passed and is Completed, only edits to linked VOD and redirect attendees are allowed.

"LinkedVideoId": "elit labore cillum",
"RedirectVod": true,

Response Messages

Successful response

Unauthorized error

Webcast does not exit

Conflict error

Internal server error