COVERITLIVE API - COMMENT/CREATE (V. 2.0)

The Request

The comment creation method allows a 3rd party application to submit comments to a CoveritLive event. Comments are not inserted directly into the event stream, rather they are placed into the comment stream, requiring approval prior to being published.

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

Parameter Description Required
event_code The event code for the event which the comments will be added to. 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
comment The text of the comment itself. May not include markup. Max length - 500 chars. yes
guest_name The author name of the comment, it will appear along with the comment itself. (e.g. guest_name=Alejandro). If not provided, this value defaults to "Guest". no
tag A free-form text field which you can use to tag this comment. Max length: 255 chars. comment/list requests for this event will return this tag. no
avatar_uri The URI of the users avatar image (JPG/GIF/PNG). Will be displayed at 48x48 pixels (e.g. avatar_uri=http://yourdomain.com/user/343894.png). no

The Response

The id of a successfully created comment is returned in the data field of a general response. This field will consist of a comment_id field, which contains the comment id.

Example response to a successful comment/create request:


{
	"result": "success",
	"message": "true",
	"type": "comment",
	"action": "create",
	"version": 2,
	"data":{
		"comment_id" : "22185041"
	}
}

comment/create Error Responses

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

result response message response solution
missing_comment_param Required parameter empty: comment Ensure the comment request parameter is present when making a comment/create request.
invalid_comment_param Exceeded maximum comment length of: 500 Ensure the comment request parameter is does not exceed 500 characters in length.