COVERITLIVE API - CONTENT/DELETE (V. 2.0)

The Request

This method allows you to delete any item in a live event. Similar to the Live Edit functionality available through the console, any item deletion made will immediately propagate to all readers of the live event in real time. Items in the event are identified by item ids, which are returned by the content/create and event/data API methods.

URL:
https://api.coveritlive.com/remote/2/content/delete
Response Formats:
JSON
HTTP Method(s):
POST
API Rate Limited:
false
In addition to the parameters listed in the Request Parameters section, the content/delete method also includes the following parameters:

Parameter Description Required
event_code The event code for the event in which the item to be deleted exists. Each CiL event that is created is assigned a unique event code that identifies it in the database - The event owner can find this value after creating a new event, by selecting the "altcast_code" which is found in their Viewer Window embed code (e.g. the event code is "46e6cd22b5" in "altcast_code=46e6cd22b5"). This value is also returned by the event/list API method. yes
item_id The id of the event item to be deleted. These ids are returned by the content/create and event/data API methods. no

The Response

There is no extra data returned from an content/delete request, so the response has the same fields as a general response.

Example response to a successful content/delete request:


{
	"result": "success",
	"message": "true",
	"type": "content",
	"action": "delete",
	"version": 2
}

content/delete Error Responses

A variety of error responses (in addition to the common error responses) to content/delete requests, and instructions on how to rectify them:

result response message response solution
missing_item_id_param Required parameter empty: item_id Ensure the item_id request parameter is present when making a content/delete request.
invalid_item_id The item_id request parameter did not contain a valid item id. When populating the item_id request parameter, ensure it contains a valid item_id.