layouts

Update a layout zone

Edit one zone's geometry, attached content, or, on a themed layout, its frame, radius, or role. Send null for any of those to clear it. Rejects a change that would create a loop back into the same layout.

patch/v1/layouts/{id}/zones/{zoneId}

Request

  • Base URL: https://api.brixsignage.com
  • URL: https://api.brixsignage.com/v1/layouts/{id}/zones/{zoneId}
  • Auth: HTTP bearer

Path parameters

idstring required

Layout id.

zoneIdstring required

Zone id.

Request body

namestring

Default Zone <n>.

xnumber

Default 0.

ynumber

Default 0.

wnumber

Default 480.

hnumber

Default 270.

lockedboolean
contentNamestring
ownerScope'workspace' | 'org_unit' | 'location'
ownerNodeIdstring nullable
frame'bare' | 'card' | 'accent' | 'glass' nullable

null removes it.

radiusnumber nullable

null removes it.

role'logo' nullable

null removes it.

Response

Success.

Changes

No recorded changes to this operation across all 2 revisions of this API.