v1

latestOpenAPI 3.0.02026-07-24212113249.1 KB
Billboards

Update a billboard

patch/billboards/{id}

Headers

channelstring required

Channel ID

organizationstring required

The URL of the end-user web application

Request body

target'LIVE' | 'HOME'
titlestring

Billboard title

descriptionstring

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 updated.