layouts

Update a layout

Edit a layout's name, resolution, zones, autoFullscreenForVideo, node, or theme. Setting theme to { source: "brand", mode?, radius? } turns the Brand Kit look on, and null turns it off. Zones accept a frame style (bare, card, accent, or glass), a radius, and a role of "logo". An invalid theme, or an unrecognized frame or role, returns 422.

Notes.

  • The response is the stored row: it has no usedByScreenCount or requiresApproval (GET has them).
patch/v1/layouts/{id}

Request

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

Path parameters

idstring required

Layout id.

Request body

namestring
autoFullscreenForVideoboolean nullable
nodeIdstring nullable

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

baseUpdatedAtstring

Optimistic concurrency: the updatedAt you read. A stale value is refused with 409 conflict and the current row.

Response

Success.

Example response

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

Changes

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