COVERITLIVE API - NEWSFLASH/CREATE (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 create newsflashes on the fly. The newsflash id is returned by the method if the newsflash is successfully created, allowing for further interactions through the API.

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

Parameter Description Required
event_code The event code for the event in which the newsflash is being created. 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
headline The headline text of the newsflash. May not be more than 120 characters in length.

yes*

* Note: At least one of the headline and body request parameters must be included

body The body text of the newsflash. May not be more than 450 characters in length.

yes*

* Note: At least one of the headline and body request parameters must be included

The Response

The newsflash id of a successfully created newsflash is returned in the data field of a general response. This field will consist of a newsflash_id field, which will contain the newsflash id.


Example response to a successful newsflash/create request:


{
	"result":"success",
	"message":"true",
	"type":"newsflash",
	"action":"create",
	"version":2,
	"data":{
		"newsflash_id" : "123456"
	}
}

newsflash/create Error Responses

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

result response message response solution
missing_headline_or_body_param One of the 'headline' or 'body' request parameters are required. Ensure one of the headline or body request parameters are included.
invalid_headline_param Exceeded maximum headline length of: 120 Ensure the headline request parameter does not exceed 120 characters in length.
invalid_body_param Exceeded maximum body length of: 450 Ensure the body request parameter does not exceed 450 characters in length.