FAfanhero
Billboards

Create a billboard

post/billboards

Request

  • Base URL
    https://api.fanheroapi.com
  • URL
    https://api.fanheroapi.com/billboards
  • Auth
    API key in header apiKey

Headers

channelstring required

Channel ID

organizationstring required

The URL of the end-user web application

Request body

target'LIVE' | 'HOME' required

Will the billboard be displayed on the Home screen or the Live screen?

titlestring required

Billboard title

descriptionstring required

Billboard description

sortnumber

Position in the carousel, when multiple billboards are displayed.

delaynumber

The number of seconds the billboard is displayed in the carousel.

actionsstring[]

IDs of the buttons on the billboard

deletedboolean

If True, the billboard has been deleted.

Example request

{
  "target": "LIVE",
  "title": "title",
  "description": "description",
  "sort": 1,
  "delay": 10000
}

Response

Billboard created.

Changes

No recorded changes to this operation across all 1 revision of this API.