COVERITLIVE API - POLL/CREATE (V. 2.0)

The Request

This method allows users to create polls on the fly. The poll id is returned by the method if the poll is successfully created, allowing for further interactions through the API.

URL:
https://api.coveritlive.com/remote/2/poll/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 poll 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
question The poll question. May not be more than 500 characters in length. yes
answers A pipe delimited list of answers. There must be between 2 and 6 pipe delimited answers, and each answer may not be more than 200 characters in length. For example: "The first answer|The second answer|The third answer" yes

The Response

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


Example response to a successful poll/create request:


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

poll/create Error Responses

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

result response message response solution
missing_question_param Required parameter empty: question. Ensure the question request parameter is present.
invalid_question_param Exceeded maximum question length of: 500. Ensure the question request parameter does not exceed 500 characters in length
invalid_answers_params answers request parameter must contain between 2 and 6 pipe separated values. Ensure the answers request parameter contain no less than 2 and no more than 6 pipe delimited values.
invalid_answers_params One of the values included in the answers request parameter exceeded maximum length of: 200. Ensure each pipe delimited value in the answers request parameter does not exceed 200 characters in length.