v51

latestOpenAPI 3.0.0AGPLv3 or laterraw.githubusercontent.com2026-08-0126276829.1 KB
layout

Edit Region

Edit Region

put/region/{id}

Path parameters

idinteger required

The Region ID to Edit

Response

successful operation

regionIdinteger

The ID of this region

layoutIdinteger

The Layout ID this region belongs to

ownerIdinteger

The userId of the User that owns this Region

typestring

Region Type, zone, playlist, frame or canvas

namestring

The name of this Region

widthnumber double

Width of the region

heightnumber double

Height of the Region

topnumber double

The top coordinate of the Region

leftnumber double

The left coordinate of the Region

zIndexinteger

The z-index of the Region to control Layering

syncKeystring

The syncKey of this Region

durationinteger

A read-only estimate of this Regions's total duration in seconds. This is valid when the parent layout status is 1 or 2.

isDrawerinteger

Flag, whether this region is used as an interactive drawer attached to a layout.