The Request

This method allows the content and published status of a pin item to be updated. The only pin items that can be updated are host comments, guest comments, captions in images and any pin items created through the API. Any updates 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.

Response Formats:
HTTP Method(s):
API Rate Limited:
In addition to the parameters listed in the Request Parameters section, the pin/update method also includes the following parameters:

Parameter Description Required
event_code The event code for the event in which the pin item to be updated 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 updated. These ids are returned by the pin/create and pin/list API methods. yes
content This is the content which will replace the current item content. May include HTML markup. May not be > 5000 characters in length. no
author_name Update the name of the pin item author. Only applies to guest_comment pin items. no
published Indicates whether the pin item should be published or unpublished. Valid values include: "y", "n". Set to "y" to publish a currently unpublished pin item, and set to "n" to unpublish a currently published pin item. no

The Response

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

Example response to a successful pin/update request:

	"result": "success",
	"message": "true",
	"type": "pin",
	"action": "update",
	"version": 2

pin/update Error Responses

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

result response message response solution
invalid_content_param Exceeded maximum content length of: 5000 Ensure the content request parameter is does not exceed 5000 characters in length (including markup).
missing_pin_id_param Required parameter empty: pin_id Ensure the pin_id request parameter is present when making a pin/update 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_id.
invalid_pin_item The content of the specified pin item cannot be updated. Only certain types of pin items can be updated, including host comments, guest comments and image captions. Attempting to update any other pin item types will result in this error.
max_pin_items The maximum number of pin items have been published. If the published request parameter is set to "y", and there are already the maximum number of pin items published (3), then new pin items cannot be published. A currently published item must be unpublished first (can be achieved using the pin/update API request).

This website uses cookies to ensure that you receive the best experience. By clicking "Accept" or closing this window, you are agreeing to our cookies policy. You can change your cookie settings at any time and read about how we use them in our Cookie Policy