layouts

Create a layout

Create a multi-zone layout with a name and optional resolution, zones, autoFullscreenForVideo, nodeId, and theme. Setting theme to { source: "brand", mode?, radius? } paints the layout using the workspace Brand Kit; omit it or set it to null for a plain canvas. Each zone can also carry a frame style (bare, card, accent, or glass), a corner radius in pixels, and a role of "logo" for a zone that shows the Brand Kit logo without needing its own content.

Notes.

  • The 201 body is the row as written, not re-read from the database, so columns the create does not set (for example lastSnapshotAt) are absent rather than null. GET returns every column.
  • The 201 body has no usedByScreenCount.
post/v1/layouts

Request

  • Base URL: https://api.brixsignage.com
  • URL: https://api.brixsignage.com/v1/layouts
  • Auth: HTTP bearer

Request body

namestring required
autoFullscreenForVideoboolean nullable
nodeIdstring nullable

Home location. Default: the caller's own location.

Response

Success.

Example response

{
  "data": {
    "id": "lay_5e6f7a8b9c0d1e2f"
  }
}

Changes

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