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

Bulk Delete Webcasts

This endpoint deletes all events for a given date range or custom field. The response returns a job id and a count of webcasts to be deleted. Use the job id to check the status of the deletion. At least one query parameter should be passed (startDate, endDate, customFields) or a Bad Request error is returned.

DELETE
/api/v2/scheduled-events

 

Request Parameters

Name Type Description Required
startDate string

YYYY-MM-DD of the start date to begin the bulk delete.

startDate should always be less than or equal to the endDate or a Bad Request is returned.

If StartDate is not specified but EndDate is, StartDate assumes a value of EndDate – 365.

 Yes, if endDate and/or customFields not used
endDate string

YYYY-MM-DD of the end date to stop the bulk delete.

The maximum date range that can be set is 365 days.

If StartDate is specified but EndDate is not, EndDate assumes a value of TODAY.

If StartDate and EndDate are not specified, EndDate assumes a value of TODAY, StartDate = EndDate – 365.

 Yes, if startDate and/or customFields not used
customFields [array(of customFields)]
  • id (string) Rev validates if its exists in Rev as a Webcast custom field. Rev returns a Bad Request if it’s not in the system.
  • value (string) cannot be NULL and should always exist in the request. Rev returns a Bad Request if value is NULL or not part of the request.  Value is case-insensitive.
  • name (string) Rev validates if its exists in Rev as a Webcast custom field. Rev returns a Bad Request if it’s not in the system.
 Yes, if startDate and/or endDate not used

Example Request

{ 
  "startDate": "2021-02-01T20:30:58.201Z", 
  "endDate": "2021-02-01T20:30:58.202Z", 
  "customFields": [ 
    { 
      "name": "string", 
      "value": "string" 
    } 
  ] 
}

Example Response

{ 
  "jobId": "string", 
  "count": 0, 
  "statusUrl": "string" 
}

Response Codes

Code Description
200 Successful response
401 Unauthorized error
500 Internal server error