v1

latestOpenAPI 3.1.02026-07-242470655.6 KB

Update Collection

Update an existing collection

put/sites/multiscreen/{site_name}/collection/{current_collection_name}

Path parameters

site_namestring required

A valid site name of an existing website

current_collection_namestring required

Name of the current collection

Request body

customer_lock'unlocked' | 'structure_locked' | 'locked'

The lock state of the collection. Must be one of unlocked, structure_locked or locked

namestring

The new name of the collection (must not start with $)

static_page_bindableboolean

Allows collection data to be connected to widgets on a non-dynamic page.

base_refresh_intervalstring

Update Frequency can control how often external collections refresh.

Response

204