COVERITLIVE API - PIN/DELETE (V. 2.0)

The Request

This method allows you to delete any pin item. Any item deletion made will immediately propagate to all readers of the live event in real time. Pin items are identified by a pin item id, which is returned by the pin/create and pin/list API methods.

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

Parameter Description Required
event_code The event code for the event in which the pin item to be deleted exists. 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
pin_id The id of the pin item to be deleted. These ids are returned by the pin/create and pin/list API methods. yes

The Response

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

Example response to a successful pin/delete request:


{
	"result": "success",
	"message": "true",
	"type": "pin",
	"action": "delete",
	"version": 2
}

pin/delete Error Responses

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

result response message response solution
missing_pin_id_param Required parameter empty: pin_id Ensure the pin_id request parameter is present when making a pin/delete request.
invalid_pin_id_param The pin_id request parameter did not contain a valid pin item id. When populating the pin_id request parameter, ensure it contains a valid pin item id.