COVERITLIVE API - REPLY/CREATE (V. 2.0)

The Request

Replies to items in an event can be created using this method. Any item that is within the event stream (such as Writer comments, reader comments, image posts, Tweets, etc.) can be replied to any number of times. The reply id is returned by this method if the reply is successfully created, allowing for further interactions through the API.

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

Parameter Description Required
event_code The event code for the event which the reply 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
item_id The id of the event item to which the reply will be attached. Event item ids can be retrieved using the event/data API method yes
comment This is the textual comment of the reply. May include HTML markup. May not be > 5000 characters in length. yes
author_name If provided AND the target event has Display Names enabled, the parameter provided here will be used for that display name. no
author_avatar If provided AND the target event has Writer Avatars enabled, the URI of an image that will be used as the avatar for the reply being created. Images are displayed at 48x48 pixels. If image provided does not match these dimensions it will be auto-resized in the Viewer Window. no
Usage Notes:
  • By default, API provided replies will be styled to appear exactly like a regular reply. To customize the content design please include HTML styling and/or images.
  • After setting up your custom application we strongly recommend testing the API provided content in a Test event to ensure your content and all styling appears as intended.
  • If including images in your content, it is recommended that you explicitly set their CSS height property. This allows CoveritLive to properly calculate viewer window scrolling positions to help provide the optimal reading experience for your users.

The Response

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

Example response to a successful reply/create request:


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

reply/create Error Responses

A variety of error responses (in addition to the common error responses) to reply/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 reply/create request.
invalid_comment_param Exceeded maximum comment length of: 5000 Ensure the comment request parameter is does not exceed 5000 characters in length (including markup).
missing_item_id_param Required parameter empty: item_id Ensure the item_id request parameter is present when making a reply/create request.
invalid_item_id The item_id request parameter did not contain a valid item id. When populating the item_id request parameter, ensure it contains a valid item_id. The item_id must correspond to an item that exists in the event in which you are creating the reply.