COVERITLIVE API - NEWSFLASH/UPDATE (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 users to update currently existing newsflashes. The headline and body text of the newsflash can be updated.

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

Parameter Description Required
event_code The event code for the event in which the newsflash is being updated. 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 updated. Returned by the newsflash/list and newsflash/create API methods. yes
headline The headline text of the newsflash. May not be more than 120 characters in length. no
body The body text of the newsflash. May not be more than 450 characters in length. no

The Response

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


Example response to a successful newsflash/update request:


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

newsflash/update Error Responses

A variety of error responses (in addition to the common error responses) to newsflash/update 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/update 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 been deleted. Newsflashes that have been deleted cannot be updated.
invalid_headline_param Exceeded maximum headline length of: 120 Ensure the headline request parameter is does not exceed 120 characters in length.
invalid_body_param Exceeded maximum body length of: 450 Ensure the body request parameter is does not exceed 450 characters in length.