Overview

Billboard objects describe billboards created by channel owners to feature content on the channel's page.

To learn about using billboards in your channels, read Home Screen, Billboard Section.

When multiple billboards are created for the same page, they are displayed in a carousel. Their display order and delay are determined by the sort and the delay properties.

Properties

Name	Type	Description
`organization`	String	The organization ID
`channel`	String	The ID of the channel where the billboard is displayed
`target`	String	Possible values: "LIVE", "HOME".
`title`	String	Billboard title
`description`	String	Billboard description
`sort`	Number	Position in the carousel, when multiple billboards are displayed.
`delay`	Number	The number of seconds the billboard is displayed in the carousel.
`customization`	Object	Object containing custom properties.
`actions`	Object Array	A custom set of buttons displayed on the billboard. The buttons take the viewer to a specified page.
`deleted`	Boolean	If True, the billboard has been deleted. This will be the case in a successful response of the Delete a billboard endpoint.
`createdAt`	DateTime String	Date and time when the billboard was created.
`updatedAt`	DateTime String	Date and time when the billboard was last edited.