COVERITLIVE API - NEWSFLASH/DELETE (V. 2.0)

NOTE: newsflash/* methods are deprecated and will return HTTP Status Code 410 (Gone) when called. Please use pin/* methods instead to highlight featured content.

The Request

This method allows for a newsflash to be deleted. Deleted newsflashes will be removed from all consoles and viewer windows.

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

Parameter Description Required
event_code The event code for the event in which the newsflash is being deleted. 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
newsflash_id The id of the newsflash to be deleted. Returned by the newsflash/list and newsflash/create API methods. yes

The Response

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


Example response to a successful newsflash/delete request:


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

newsflash/delete Error Responses

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

result response message response solution
missing_newsflash_id_param Required parameter empty: newsflash_id. Ensure the newsflash_id request parameter is present when making a newsflash/delete request.
invalid_newsflash_id_param The newsflash_id request parameter did not contain a valid newsflash id. When populating the newsflash_id request parameter, ensure it contains a valid newsflash id. Newsflash ids are returned by newsflash/list and newsflash/create requests.
newsflash_deleted The newsflash specified by newsflash_id has already been deleted. Newsflashes that have already been deleted cannot be deleted again.