screens

Update a screen's settings

Update a screen's own fields, including name, location, tags, orientation, organization node, and player settings. This endpoint does not assign content; use POST /v1/screens/:id/assign to change what a screen plays.

Partial update. To change what a screen plays use POST /v1/screens/{id}/assign — this route refuses contentKind/contentId with a 400.

Notes.

  • The PATCH response does not merge the live socket facts (linkFlaps10m, a socket-fresh lastSeenAt) that GET adds.
patch/v1/screens/{id}

Request

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

Path parameters

idstring required

Screen id.

Request body

namestring
nodeIdstring nullable

Move to another location (you need screen.edit there too).

billingGroupIdstring nullable

Needs billing.edit.

status'online' | 'offline' | 'pairing'
tagsstring[]
timezonestring nullable

IANA time zone; null to inherit.

operatingHoursstring
displayPowerMode'always-on' | 'follow-schedule' | 'os-default'
powerPolicyIdstring nullable
playbackMode'sync' | 'unsync' | 'device-time'
deactivatedboolean

True deactivates the screen (nothing plays); false reactivates it.

playerSettingsobject nullable

Merged into the current settings; null resets them.

customFieldsobject nullable
kioskPinMode'workspace' | 'custom'
kioskGraceSecondsnumber
kioskPinstring nullable

4-8 digits; null clears the custom PIN.

kioskEnabledboolean

Response

Success.

Example response

{
  "data": {
    "id": "scr_1a2b3c4d5e6f7a8b"
  }
}

Changes

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