Skip to main content
API docs by Redocly

Wallboard API - Device Management (2.0)

API Support: [email protected]

Device management endpoints for the Wallboard digital signage platform.

Overview

Manage display devices (screens/players), device groups, device content types, and device installation rules.

Key Concepts

Concept Description
Device Physical or virtual display screen/player
Device Group Hierarchical folder structure for organizing devices
Device Content Base class for content types: Content (single layouts), Schedule (time-based playlists), SimpleLoop (basic playlists)
Device Install Rule Auto-provisioning rules for new devices

Device Status

Status Description
ONLINE Device is connected and active
OFFLINE Device is not connected

Device Platforms

Platform Description
ANDROID Android-based players
WINDOWS Windows players
BRIGHTSIGN BrightSign devices
SAMSUNG Samsung Smart Signage
LG LG webOS Signage
CHROME_OS Chrome OS devices
BROWSER Web browser client
UNKNOWN Platform not detected

Common Operations

  • List and filter devices
  • Assign/detach content to devices
  • Configure device settings (brightness, volume, rotation)
  • Manage device groups
  • Control device state (restart, snooze, wake up)
  • Emergency mode activation

Filtering

Use WBQL in the search parameter. Key fields for devices:

Filter Type Field Example
Folder (direct) deviceGroupId search=deviceGroupId=abc123
Folder (recursive) deviceGroupPath search=deviceGroupPath:abc123
Team teamAssignments.team.id search=teamAssignments.team.id=team1
Status deviceStatus search=deviceStatus=ONLINE
Platform platform search=platform=ANDROID

See Getting Started for full WBQL syntax, operators, and precedence rules.

device

Device CRUD and configuration

List devices

Retrieve a paginated list of devices with optional filtering.

Minimum role: VIEWER

Authorizations:
bearer
query Parameters
customerId
integer <int64>

Select a customer/tenant within the caller's access. When this parameter is optional, omitting it uses the caller's scope: global for ADMIN, owned member customers for a network owner, and the own customer for other callers. Use an explicit customerId for customer-specific operations. Requiredness is declared per endpoint.

page
integer >= 0
Default: 0

Page index (0-based)

size
integer >= 1
Default: 20

Requested page size; server limits and endpoint overrides apply.

sort
string
Example: sort=name,asc

Sort expression. Format: field,direction

  • Directions: asc, desc
  • Multiple sorts: sort=name,asc&sort=lastActivity,desc
  • Nested fields: sort=content.name,asc
search
string

WBQL filter expression. Operators: : (contains), = (equals), ≠, ∉, ^ (starts with), >, ≥, <, ≤, ∈ (in set). Logic: , (AND), | (OR). Special: NULL, !NULL. Example: name:lobby,deviceStatus=ONLINE

select
string

Field projection. * = all primitives, field,field = specific, relation(fields) = nested. Example: select=*,customer(id,name)

includeReadOnlyInfo
boolean
Default: false

Include readOnly attribute in response. Set to false for better performance when not needed.

Responses

Request samples 

curl -X GET 'https://{server}/api/v2/device?customerId=123&page=0&size=20&select=id,name,deviceStatus,lastActivity' \
  -H 'Authorization: Bearer YOUR_TOKEN'

Response samples

Content type
application/json
{
  • "first": true,
  • "last": true,
  • "number": 0,
  • "numberOfElements": 0,
  • "totalElements": 0,
  • "totalPages": 0,
  • "size": 0,
  • "content": [
    ]
}

Get devices and groups summary

Retrieve devices and device groups in a combined view. Useful for building folder-based navigation.

Minimum role: VIEWER

Authorizations:
bearer
query Parameters
customerId
integer <int64>

Select a customer/tenant within the caller's access. When this parameter is optional, omitting it uses the caller's scope: global for ADMIN, owned member customers for a network owner, and the own customer for other callers. Use an explicit customerId for customer-specific operations. Requiredness is declared per endpoint.

deviceSearch
string

WBQL search for devices

deviceGroupSearch
string

WBQL search for device groups

quickFilterId
string

Quick filter ID to apply

groupSelect
string

WBQL select expression for device groups

page
integer >= 0
Default: 0

Page index (0-based)

size
integer >= 1
Default: 20

Requested page size; server limits and endpoint overrides apply.

sort
string
Example: sort=name,asc

Sort expression. Format: field,direction

  • Directions: asc, desc
  • Multiple sorts: sort=name,asc&sort=lastActivity,desc
  • Nested fields: sort=content.name,asc
select
string

Field projection. * = all primitives, field,field = specific, relation(fields) = nested. Example: select=*,customer(id,name)

Responses

Response samples

Content type
application/json
{
  • "first": true,
  • "last": true,
  • "number": 0,
  • "numberOfElements": 0,
  • "totalElements": 0,
  • "totalPages": 0,
  • "size": 0,
  • "content": [
    ]
}

Get device group breadcrumb

Retrieve breadcrumb navigation path for a device group.

Minimum role: VIEWER

Authorizations:
bearer
query Parameters
customerId
integer <int64>

Select a customer/tenant within the caller's access. When this parameter is optional, omitting it uses the caller's scope: global for ADMIN, owned member customers for a network owner, and the own customer for other callers. Use an explicit customerId for customer-specific operations. Requiredness is declared per endpoint.

deviceGroupId
string

Device group ID to get breadcrumb for

Responses

Response samples

Content type
application/json
{
  • "groups": [
    ]
}

Get device dashboard status

Retrieve device status summary for dashboard display.

Minimum role: VIEWER

Authorizations:
bearer
query Parameters
customerId
integer <int64>

Select a customer/tenant within the caller's access. When this parameter is optional, omitting it uses the caller's scope: global for ADMIN, owned member customers for a network owner, and the own customer for other callers. Use an explicit customerId for customer-specific operations. Requiredness is declared per endpoint.

Responses

Response samples

Content type
application/json
{
  • "onlineCount": 0,
  • "offlineForLessThan30DaysCount": 0,
  • "offlineForLessThanADayCount": 0,
  • "offlineForLessThanAWeekCount": 0,
  • "offlineForMoreThan30DaysCount": 0
}

Get devices by location

Retrieve devices within a geographic rectangle for map display.

Minimum role: VIEWER

Authorizations:
bearer
query Parameters
customerId
integer <int64>

Select a customer/tenant within the caller's access. When this parameter is optional, omitting it uses the caller's scope: global for ADMIN, owned member customers for a network owner, and the own customer for other callers. Use an explicit customerId for customer-specific operations. Requiredness is declared per endpoint.

page
integer >= 0
Default: 0

Page index (0-based)

size
integer >= 1
Default: 20

Requested page size; server limits and endpoint overrides apply.

sort
string
Example: sort=name,asc

Sort expression. Format: field,direction

  • Directions: asc, desc
  • Multiple sorts: sort=name,asc&sort=lastActivity,desc
  • Nested fields: sort=content.name,asc
select
string

Field projection. * = all primitives, field,field = specific, relation(fields) = nested. Example: select=*,customer(id,name)

search
string

WBQL filter expression. Operators: : (contains), = (equals), ≠, ∉, ^ (starts with), >, ≥, <, ≤, ∈ (in set). Logic: , (AND), | (OR). Special: NULL, !NULL. Example: name:lobby,deviceStatus=ONLINE

includeRectangleNorthLat
number <double>

North latitude boundary

includeRectangleEastLon
number <double>

East longitude boundary

includeRectangleSouthLat
number <double>

South latitude boundary

includeRectangleWestLon
number <double>

West longitude boundary

Responses

Response samples

Content type
application/json
{
  • "first": true,
  • "last": true,
  • "number": 0,
  • "numberOfElements": 0,
  • "totalElements": 0,
  • "totalPages": 0,
  • "size": 0,
  • "content": [
    ]
}

Assign content to devices

Assign content to one or more devices.

Minimum role: APPROVER

Authorizations:
bearer
query Parameters
customerId
required
integer <int64>

Explicit customer/tenant ID required by this operation, within the caller's access.

applyOn
required
string
Enum: "DEVICE" "DEVICEGROUP" "ALL"

Select devices, device groups, or both. The search expression filters that selection; filter device tags through search.

search
string

WBQL filter expression. Operators: : (contains), = (equals), ≠, ∉, ^ (starts with), >, ≥, <, ≤, ∈ (in set). Logic: , (AND), | (OR). Special: NULL, !NULL. Example: name:lobby,deviceStatus=ONLINE

contentId
required
string

Content ID to assign

nextContentId
string

Next content ID (for scheduled transitions)

nextContentStartDate
string <date-time>

When to start next content

asAssigned
boolean
Default: true

Assign as primary content

asEmergency
boolean
Default: false

Assign as emergency content

Responses

Detach content from devices

Remove content assignment from one or more devices.

Minimum role: APPROVER

Authorizations:
bearer
query Parameters
customerId
required
integer <int64>

Explicit customer/tenant ID required by this operation, within the caller's access.

applyOn
required
string
Enum: "DEVICE" "DEVICEGROUP" "ALL"

Select devices, device groups, or both. The search expression filters that selection; filter device tags through search.

search
string

WBQL filter expression. Operators: : (contains), = (equals), ≠, ∉, ^ (starts with), >, ≥, <, ≤, ∈ (in set). Logic: , (AND), | (OR). Special: NULL, !NULL. Example: name:lobby,deviceStatus=ONLINE

detachNext
boolean
Default: true

Detach next scheduled content

detachAssigned
boolean
Default: true

Detach assigned content

detachEmergency
boolean
Default: false

Detach emergency content

Responses

Refresh content on devices

Force devices to reload their content.

Minimum role: APPROVER

Authorizations:
bearer
query Parameters
customerId
required
integer <int64>

Explicit customer/tenant ID required by this operation, within the caller's access.

applyOn
required
string
Enum: "DEVICE" "DEVICEGROUP" "ALL"

Select devices, device groups, or both. The search expression filters that selection; filter device tags through search.

search
string

WBQL filter expression. Operators: : (contains), = (equals), ≠, ∉, ^ (starts with), >, ≥, <, ≤, ∈ (in set). Logic: , (AND), | (OR). Special: NULL, !NULL. Example: name:lobby,deviceStatus=ONLINE

Responses

Register/assign device to customer

Register an unregistered device or assign it to a customer account.

Registration methods:

Method Field Platforms Use Case
4-digit code activationCode All General registration
Serial number serial LG, Samsung, BrightSign, some Android Bulk deployment
Pre-registration serial + createDeviceIfSerialNotFound=true Same as serial Zero-touch deployment

License assignment: Most registrations use licenseStatus=LICENSED with licenseOrderId. The license tier comes from the order.

Minimum role: TECHNICIAN

Authorizations:
bearer
query Parameters
customerId
integer <int64>

Select a customer/tenant within the caller's access. When this parameter is optional, omitting it uses the caller's scope: global for ADMIN, owned member customers for a network owner, and the own customer for other callers. Use an explicit customerId for customer-specific operations. Requiredness is declared per endpoint.

Request Body schema: application/json
required
activationCode
string

4-digit code displayed on unregistered device screen. Works on all platforms. Code changes periodically.

serial
string

Hardware serial number (8+ characters). Supported platforms: LG, Samsung, BrightSign, some Android (Qbic). NOT available on standard Android devices.

createDeviceIfSerialNotFound
boolean
Default: false

Pre-registration mode. When true and serial not found, creates a placeholder device. Physical device auto-connects when powered on with matching serial.

deviceName
string

Display name for the device (shown in UI)

comment
string

Optional notes/description

deviceGroupId
string

Device folder ID to place device in

contentId
string

Base content to assign immediately

emergencyContentId
string

Emergency content (shown when emergency mode triggered)

licenseStatus
string (DeviceLicenseStatus)
Enum: "UN_LICENSED" "LICENSED" "FREE" "TRIAL"

Device license state. Determines if device can display content.

Status Content Display Tier Source
UN_LICENSED ❌ "License expired" screen N/A
LICENSED ✅ Yes From LicenseOrder
FREE ✅ Yes From licenseType field
TRIAL ✅ Yes (Currently unused)

Typical workflow:

  1. New devices start as UN_LICENSED
  2. Assign LICENSED + licenseOrderId for paid customers

FREE status: Limited availability, requires customer configuration.

licenseOrderId
integer <int64>

License order ID. Required when licenseStatus=LICENSED. The order's license type determines the device tier.

licenseType
string (LicenseType)
Enum: "BASIC" "PROFESSIONAL" "DBA" "ENTERPRISE" "VIDEO_WALL"

Device license tier. Higher tiers include all features of lower tiers.

API Value UI Name Features
BASIC Lite Basic content types (media, simple layouts)
PROFESSIONAL Professional + Complex/interactive content
DBA Broadcaster Legacy tier (not used for new orders)
ENTERPRISE Premium All features
VIDEO_WALL Video Wall Premium + video wall sync

When is this field used?

  • licenseStatus=FREE: Use this field to set the tier
  • licenseStatus=LICENSED: Ignored - tier comes from LicenseOrder
  • licenseStatus=UN_LICENSED: Ignored - no tier applies
tags
Array of strings

Tag names to assign to the device

timeZone
string

Required. IANA timezone identifier. Examples: Europe/Budapest, America/New_York, Asia/Tokyo. Full list: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones

volumeLevel
integer [ 0 .. 100 ]

Audio volume (0-100)

brightnessLevel
integer [ 0 .. 100 ]

Screen brightness (0-100)

object (DeviceRotation)

Device screen rotation settings

weatherLocation
string

Location string for weather widgets

datasourceId
string

Datasource ID to bind for data-driven content

dataRowId
string

Specific data row ID within the datasource

showName
boolean
Default: false

Display device name overlay on screen

showConsole
boolean
Default: false

Show debug console (for troubleshooting)

showDeviceInfo
boolean
Default: false

Show device info overlay

showStateIndicator
boolean
Default: true

Show connection state indicator

emergencyStatus
boolean
Default: false

Enable emergency mode immediately after registration

rebootTime
string

Daily scheduled reboot time (HH:mm format, 24h)

sensorConfig
string

Sensor configuration (JSON string, platform-specific)

updateVersionUpperLimit
string

Maximum app version device can update to (locks updates)

adminMetadata
any

JSON value.

advancedConfiguration
any

JSON value.

customerId
integer <int64>
deleteMigratedDevice
boolean
Default: false
dspId
string
migrateFromDeviceId
string
updateRule
any

JSON value.

venueId
string

Responses

Request samples

Content type
application/json
Example
{
  • "activationCode": "1234",
  • "deviceName": "Lobby Display",
  • "deviceGroupId": "folder-uuid",
  • "licenseStatus": "LICENSED",
  • "licenseOrderId": 12345,
  • "timeZone": "Europe/Budapest"
}

Move devices to a folder

Move one or more devices to a device group (folder).

Minimum role: TECHNICIAN

Authorizations:
bearer
query Parameters
customerId
required
integer <int64>

Explicit customer/tenant ID required by this operation, within the caller's access.

applyOn
required
string
Enum: "DEVICE" "DEVICEGROUP" "ALL"

Select devices, device groups, or both. The search expression filters that selection; filter device tags through search.

search
string

WBQL filter expression. Operators: : (contains), = (equals), ≠, ∉, ^ (starts with), >, ≥, <, ≤, ∈ (in set). Logic: , (AND), | (OR). Special: NULL, !NULL. Example: name:lobby,deviceStatus=ONLINE

deviceGroupId
required
string

Target device group/folder ID

Responses

Set device physical location

Set the physical location (GPS coordinates) for one or more devices. Used for map view functionality.

Minimum role: TECHNICIAN

Authorizations:
bearer
query Parameters
customerId
required
integer <int64>

Explicit customer/tenant ID required by this operation, within the caller's access.

applyOn
required
string
Enum: "DEVICE" "DEVICEGROUP" "ALL"

Select devices, device groups, or both. The search expression filters that selection; filter device tags through search.

search
string

WBQL filter expression. Operators: : (contains), = (equals), ≠, ∉, ^ (starts with), >, ≥, <, ≤, ∈ (in set). Logic: , (AND), | (OR). Special: NULL, !NULL. Example: name:lobby,deviceStatus=ONLINE

Request Body schema: application/json
required
lat
number <double>

Latitude coordinate

lon
number <double>

Longitude coordinate

address
string

Human-readable address

Responses

Request samples

Content type
application/json
{
  • "lat": 0.1,
  • "lon": 0.1,
  • "address": "string"
}

Update device license

Update the license type or status for one or more devices.

Minimum role: TECHNICIAN

Authorizations:
bearer
query Parameters
customerId
integer <int64>

Select a customer/tenant within the caller's access. When this parameter is optional, omitting it uses the caller's scope: global for ADMIN, owned member customers for a network owner, and the own customer for other callers. Use an explicit customerId for customer-specific operations. Requiredness is declared per endpoint.

applyOn
required
string
Enum: "DEVICE" "DEVICEGROUP" "ALL"

Select devices, device groups, or both. The search expression filters that selection; filter device tags through search.

search
string

WBQL filter expression. Operators: : (contains), = (equals), ≠, ∉, ^ (starts with), >, ≥, <, ≤, ∈ (in set). Logic: , (AND), | (OR). Special: NULL, !NULL. Example: name:lobby,deviceStatus=ONLINE

licenseType
string (LicenseType)
Enum: "BASIC" "PROFESSIONAL" "DBA" "ENTERPRISE" "VIDEO_WALL"

New license type

licenseStatus
string (DeviceLicenseStatus)
Enum: "UN_LICENSED" "LICENSED" "FREE" "TRIAL"

New license status

licenseOrderId
integer <int64>

License order ID

unassignContentOnDowngrade
boolean
Default: false

Remove content assignment when downgrading license

Responses

Set device brightness

Set brightness level for one or more devices.

Minimum role: TECHNICIAN

Authorizations:
bearer
query Parameters
customerId
required
integer <int64>

Explicit customer/tenant ID required by this operation, within the caller's access.

applyOn
required
string
Enum: "DEVICE" "DEVICEGROUP" "ALL"

Select devices, device groups, or both. The search expression filters that selection; filter device tags through search.

search
string

WBQL filter expression. Operators: : (contains), = (equals), ≠, ∉, ^ (starts with), >, ≥, <, ≤, ∈ (in set). Logic: , (AND), | (OR). Special: NULL, !NULL. Example: name:lobby,deviceStatus=ONLINE

level
required
integer [ 0 .. 100 ]

Brightness level (0-100)

Responses

Set device volume

Set volume level for one or more devices.

Minimum role: TECHNICIAN

Authorizations:
bearer
query Parameters
customerId
required
integer <int64>

Explicit customer/tenant ID required by this operation, within the caller's access.

applyOn
required
string
Enum: "DEVICE" "DEVICEGROUP" "ALL"

Select devices, device groups, or both. The search expression filters that selection; filter device tags through search.

search
string

WBQL filter expression. Operators: : (contains), = (equals), ≠, ∉, ^ (starts with), >, ≥, <, ≤, ∈ (in set). Logic: , (AND), | (OR). Special: NULL, !NULL. Example: name:lobby,deviceStatus=ONLINE

level
required
integer [ 0 .. 100 ]

Volume level (0-100)

Responses

Set device rotation

Set screen rotation for one or more devices.

Minimum role: TECHNICIAN

Rotation Types:

  • WEB_VIEW (default) - Rotates the web content view
  • DEVICE - Rotates at device/OS level
Authorizations:
bearer
query Parameters
customerId
required
integer <int64>

Explicit customer/tenant ID required by this operation, within the caller's access.

applyOn
required
string
Enum: "DEVICE" "DEVICEGROUP" "ALL"

Select devices, device groups, or both. The search expression filters that selection; filter device tags through search.

search
string

WBQL filter expression. Operators: : (contains), = (equals), ≠, ∉, ^ (starts with), >, ≥, <, ≤, ∈ (in set). Logic: , (AND), | (OR). Special: NULL, !NULL. Example: name:lobby,deviceStatus=ONLINE

angle
required
integer
Enum: 0 90 180 270

Rotation angle in degrees

type
string
Default: "WEB_VIEW"
Enum: "WEB_VIEW" "DEVICE"

Type of rotation (default WEB_VIEW)

Responses

Set device timezone

Set timezone for one or more devices.

Minimum role: TECHNICIAN

Authorizations:
bearer
query Parameters
customerId
required
integer <int64>

Explicit customer/tenant ID required by this operation, within the caller's access.

applyOn
required
string
Enum: "DEVICE" "DEVICEGROUP" "ALL"

Select devices, device groups, or both. The search expression filters that selection; filter device tags through search.

search
string

WBQL filter expression. Operators: : (contains), = (equals), ≠, ∉, ^ (starts with), >, ≥, <, ≤, ∈ (in set). Logic: , (AND), | (OR). Special: NULL, !NULL. Example: name:lobby,deviceStatus=ONLINE

timeZone
required
string

Timezone identifier (e.g., Europe/Budapest)

Responses

Turn device display on/off

Turn display on or off for one or more devices.

Minimum role: TECHNICIAN

Authorizations:
bearer
query Parameters
customerId
required
integer <int64>

Explicit customer/tenant ID required by this operation, within the caller's access.

applyOn
required
string
Enum: "DEVICE" "DEVICEGROUP" "ALL"

Select devices, device groups, or both. The search expression filters that selection; filter device tags through search.

search
string

WBQL filter expression. Operators: : (contains), = (equals), ≠, ∉, ^ (starts with), >, ≥, <, ≤, ∈ (in set). Logic: , (AND), | (OR). Special: NULL, !NULL. Example: name:lobby,deviceStatus=ONLINE

enabled
required
boolean

Responses

Restart devices

Send restart command to one or more devices.

Minimum role: TECHNICIAN

Authorizations:
bearer
query Parameters
customerId
required
integer <int64>

Explicit customer/tenant ID required by this operation, within the caller's access.

applyOn
required
string
Enum: "DEVICE" "DEVICEGROUP" "ALL"

Select devices, device groups, or both. The search expression filters that selection; filter device tags through search.

search
string

WBQL filter expression. Operators: : (contains), = (equals), ≠, ∉, ^ (starts with), >, ≥, <, ≤, ∈ (in set). Logic: , (AND), | (OR). Special: NULL, !NULL. Example: name:lobby,deviceStatus=ONLINE

Responses

Snooze devices

Put devices into snooze/sleep mode.

Minimum role: TECHNICIAN

Authorizations:
bearer
query Parameters
customerId
required
integer <int64>

Explicit customer/tenant ID required by this operation, within the caller's access.

applyOn
required
string
Enum: "DEVICE" "DEVICEGROUP" "ALL"

Select devices, device groups, or both. The search expression filters that selection; filter device tags through search.

search
string

WBQL filter expression. Operators: : (contains), = (equals), ≠, ∉, ^ (starts with), >, ≥, <, ≤, ∈ (in set). Logic: , (AND), | (OR). Special: NULL, !NULL. Example: name:lobby,deviceStatus=ONLINE

Responses

Wake up devices

Wake up devices from snooze/sleep mode.

Minimum role: TECHNICIAN

Authorizations:
bearer
query Parameters
customerId
required
integer <int64>

Explicit customer/tenant ID required by this operation, within the caller's access.

applyOn
required
string
Enum: "DEVICE" "DEVICEGROUP" "ALL"

Select devices, device groups, or both. The search expression filters that selection; filter device tags through search.

search
string

WBQL filter expression. Operators: : (contains), = (equals), ≠, ∉, ^ (starts with), >, ≥, <, ≤, ∈ (in set). Logic: , (AND), | (OR). Special: NULL, !NULL. Example: name:lobby,deviceStatus=ONLINE

Responses

Update device software

Trigger software update on one or more devices.

Minimum role: TECHNICIAN

Authorizations:
bearer
query Parameters
customerId
required
integer <int64>

Explicit customer/tenant ID required by this operation, within the caller's access.

applyOn
required
string
Enum: "DEVICE" "DEVICEGROUP" "ALL"

Select devices, device groups, or both. The search expression filters that selection; filter device tags through search.

search
string

WBQL filter expression. Operators: : (contains), = (equals), ≠, ∉, ^ (starts with), >, ≥, <, ≤, ∈ (in set). Logic: , (AND), | (OR). Special: NULL, !NULL. Example: name:lobby,deviceStatus=ONLINE

version
string

Target version (optional, uses latest if not specified)

Responses

Set emergency mode

Enable or disable emergency mode for devices. In emergency mode, devices display emergency content.

Minimum role: APPROVER

Authorizations:
bearer
query Parameters
customerId
required
integer <int64>

Explicit customer/tenant ID required by this operation, within the caller's access.

applyOn
required
string
Enum: "DEVICE" "DEVICEGROUP" "ALL"

Select devices, device groups, or both. The search expression filters that selection; filter device tags through search.

search
string

WBQL filter expression. Operators: : (contains), = (equals), ≠, ∉, ^ (starts with), >, ≥, <, ≤, ∈ (in set). Logic: , (AND), | (OR). Special: NULL, !NULL. Example: name:lobby,deviceStatus=ONLINE

emergencyStatus
required
boolean

Responses

Lock/unlock devices

Lock or unlock one or more devices.

Minimum role: TECHNICIAN

Authorizations:
bearer
path Parameters
locked
required
boolean
query Parameters
customerId
required
integer <int64>

Explicit customer/tenant ID required by this operation, within the caller's access.

applyOn
required
string
Enum: "DEVICE" "DEVICEGROUP" "ALL"

Select devices, device groups, or both. The search expression filters that selection; filter device tags through search.

search
string

WBQL filter expression. Operators: : (contains), = (equals), ≠, ∉, ^ (starts with), >, ≥, <, ≤, ∈ (in set). Logic: , (AND), | (OR). Special: NULL, !NULL. Example: name:lobby,deviceStatus=ONLINE

Responses

Set scheduled reboot time

Set a daily scheduled reboot time for devices.

Minimum role: TECHNICIAN

Authorizations:
bearer
query Parameters
customerId
required
integer <int64>

Explicit customer/tenant ID required by this operation, within the caller's access.

applyOn
required
string
Enum: "DEVICE" "DEVICEGROUP" "ALL"

Select devices, device groups, or both. The search expression filters that selection; filter device tags through search.

search
string

WBQL filter expression. Operators: : (contains), = (equals), ≠, ∉, ^ (starts with), >, ≥, <, ≤, ∈ (in set). Logic: , (AND), | (OR). Special: NULL, !NULL. Example: name:lobby,deviceStatus=ONLINE

time
required
string

Reboot time (HH:mm:ss format)

Responses

Remove scheduled reboot time

Remove scheduled daily reboot time from devices.

Minimum role: TECHNICIAN

Authorizations:
bearer
query Parameters
customerId
required
integer <int64>

Explicit customer/tenant ID required by this operation, within the caller's access.

applyOn
required
string
Enum: "DEVICE" "DEVICEGROUP" "ALL"

Select devices, device groups, or both. The search expression filters that selection; filter device tags through search.

search
string

WBQL filter expression. Operators: : (contains), = (equals), ≠, ∉, ^ (starts with), >, ≥, <, ≤, ∈ (in set). Logic: , (AND), | (OR). Special: NULL, !NULL. Example: name:lobby,deviceStatus=ONLINE

Responses

Add tags to devices

Add tags to one or more devices.

Minimum role: APPROVER

Authorizations:
bearer
query Parameters
customerId
integer <int64>

Select a customer/tenant within the caller's access. When this parameter is optional, omitting it uses the caller's scope: global for ADMIN, owned member customers for a network owner, and the own customer for other callers. Use an explicit customerId for customer-specific operations. Requiredness is declared per endpoint.

applyOn
required
string
Enum: "DEVICE" "DEVICEGROUP" "ALL"

Select devices, device groups, or both. The search expression filters that selection; filter device tags through search.

search
string

WBQL filter expression. Operators: : (contains), = (equals), ≠, ∉, ^ (starts with), >, ≥, <, ≤, ∈ (in set). Logic: , (AND), | (OR). Special: NULL, !NULL. Example: name:lobby,deviceStatus=ONLINE

Request Body schema: application/json
required
Array
string

Responses

Request samples

Content type
application/json
[
  • "lobby",
  • "floor-1"
]

Set tags on devices

Replace all tags on one or more devices.

Minimum role: APPROVER

Authorizations:
bearer
query Parameters
customerId
integer <int64>

Select a customer/tenant within the caller's access. When this parameter is optional, omitting it uses the caller's scope: global for ADMIN, owned member customers for a network owner, and the own customer for other callers. Use an explicit customerId for customer-specific operations. Requiredness is declared per endpoint.

applyOn
required
string
Enum: "DEVICE" "DEVICEGROUP" "ALL"

Select devices, device groups, or both. The search expression filters that selection; filter device tags through search.

search
string

WBQL filter expression. Operators: : (contains), = (equals), ≠, ∉, ^ (starts with), >, ≥, <, ≤, ∈ (in set). Logic: , (AND), | (OR). Special: NULL, !NULL. Example: name:lobby,deviceStatus=ONLINE

Request Body schema: application/json
required
Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Remove tags from devices

Remove tags from one or more devices.

Minimum role: APPROVER

Authorizations:
bearer
query Parameters
customerId
integer <int64>

Select a customer/tenant within the caller's access. When this parameter is optional, omitting it uses the caller's scope: global for ADMIN, owned member customers for a network owner, and the own customer for other callers. Use an explicit customerId for customer-specific operations. Requiredness is declared per endpoint.

applyOn
required
string
Enum: "DEVICE" "DEVICEGROUP" "ALL"

Select devices, device groups, or both. The search expression filters that selection; filter device tags through search.

search
string

WBQL filter expression. Operators: : (contains), = (equals), ≠, ∉, ^ (starts with), >, ≥, <, ≤, ∈ (in set). Logic: , (AND), | (OR). Special: NULL, !NULL. Example: name:lobby,deviceStatus=ONLINE

Request Body schema: application/json
required
Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Show/hide device console

Show or hide the debug console on devices.

Minimum role: TECHNICIAN

Authorizations:
bearer
query Parameters
customerId
required
integer <int64>

Explicit customer/tenant ID required by this operation, within the caller's access.

applyOn
required
string
Enum: "DEVICE" "DEVICEGROUP" "ALL"

Select devices, device groups, or both. The search expression filters that selection; filter device tags through search.

search
string

WBQL filter expression. Operators: : (contains), = (equals), ≠, ∉, ^ (starts with), >, ≥, <, ≤, ∈ (in set). Logic: , (AND), | (OR). Special: NULL, !NULL. Example: name:lobby,deviceStatus=ONLINE

enabled
required
boolean

Responses

Show/hide device name

Show or hide the device name overlay on devices.

Minimum role: TECHNICIAN

Authorizations:
bearer
query Parameters
customerId
required
integer <int64>

Explicit customer/tenant ID required by this operation, within the caller's access.

applyOn
required
string
Enum: "DEVICE" "DEVICEGROUP" "ALL"

Select devices, device groups, or both. The search expression filters that selection; filter device tags through search.

search
string

WBQL filter expression. Operators: : (contains), = (equals), ≠, ∉, ^ (starts with), >, ≥, <, ≤, ∈ (in set). Logic: , (AND), | (OR). Special: NULL, !NULL. Example: name:lobby,deviceStatus=ONLINE

enabled
required
boolean

Responses

Show/hide device info overlay

Show or hide device information overlay on devices.

Minimum role: TECHNICIAN

Authorizations:
bearer
query Parameters
customerId
required
integer <int64>

Explicit customer/tenant ID required by this operation, within the caller's access.

applyOn
required
string
Enum: "DEVICE" "DEVICEGROUP" "ALL"

Select devices, device groups, or both. The search expression filters that selection; filter device tags through search.

search
string

WBQL filter expression. Operators: : (contains), = (equals), ≠, ∉, ^ (starts with), >, ≥, <, ≤, ∈ (in set). Logic: , (AND), | (OR). Special: NULL, !NULL. Example: name:lobby,deviceStatus=ONLINE

enabled
required
boolean

Responses

Show/hide state indicator

Show or hide the state indicator on devices.

Minimum role: TECHNICIAN

Authorizations:
bearer
query Parameters
customerId
required
integer <int64>

Explicit customer/tenant ID required by this operation, within the caller's access.

applyOn
required
string
Enum: "DEVICE" "DEVICEGROUP" "ALL"

Select devices, device groups, or both. The search expression filters that selection; filter device tags through search.

search
string

WBQL filter expression. Operators: : (contains), = (equals), ≠, ∉, ^ (starts with), >, ≥, <, ≤, ∈ (in set). Logic: , (AND), | (OR). Special: NULL, !NULL. Example: name:lobby,deviceStatus=ONLINE

enabled
required
boolean

Responses

Show toast message on devices

Display a toast notification message on devices.

Minimum role: TECHNICIAN

Authorizations:
bearer
query Parameters
customerId
required
integer <int64>

Explicit customer/tenant ID required by this operation, within the caller's access.

applyOn
required
string
Enum: "DEVICE" "DEVICEGROUP" "ALL"

Select devices, device groups, or both. The search expression filters that selection; filter device tags through search.

search
string

WBQL filter expression. Operators: : (contains), = (equals), ≠, ∉, ^ (starts with), >, ≥, <, ≤, ∈ (in set). Logic: , (AND), | (OR). Special: NULL, !NULL. Example: name:lobby,deviceStatus=ONLINE

message
required
string

Responses

Send custom command to devices

Send a custom command to one or more devices.

Minimum role: TECHNICIAN

Authorizations:
bearer
query Parameters
customerId
required
integer <int64>

Explicit customer/tenant ID required by this operation, within the caller's access.

applyOn
required
string
Enum: "DEVICE" "DEVICEGROUP" "ALL"

Select devices, device groups, or both. The search expression filters that selection; filter device tags through search.

search
string

WBQL filter expression. Operators: : (contains), = (equals), ≠, ∉, ^ (starts with), >, ≥, <, ≤, ∈ (in set). Logic: , (AND), | (OR). Special: NULL, !NULL. Example: name:lobby,deviceStatus=ONLINE

command
required
string

Responses

Start device recovery mode

Start recovery mode on one or more devices.

Minimum role: TECHNICIAN

Authorizations:
bearer
query Parameters
customerId
required
integer <int64>

Explicit customer/tenant ID required by this operation, within the caller's access.

applyOn
required
string
Enum: "DEVICE" "DEVICEGROUP" "ALL"

Select devices, device groups, or both. The search expression filters that selection; filter device tags through search.

search
string

WBQL filter expression. Operators: : (contains), = (equals), ≠, ∉, ^ (starts with), >, ≥, <, ≤, ∈ (in set). Logic: , (AND), | (OR). Special: NULL, !NULL. Example: name:lobby,deviceStatus=ONLINE

Responses

Open device settings

Open settings menu on one or more devices.

Minimum role: TECHNICIAN

Authorizations:
bearer
query Parameters
customerId
required
integer <int64>

Explicit customer/tenant ID required by this operation, within the caller's access.

applyOn
required
string
Enum: "DEVICE" "DEVICEGROUP" "ALL"

Select devices, device groups, or both. The search expression filters that selection; filter device tags through search.

search
string

WBQL filter expression. Operators: : (contains), = (equals), ≠, ∉, ^ (starts with), >, ≥, <, ≤, ∈ (in set). Logic: , (AND), | (OR). Special: NULL, !NULL. Example: name:lobby,deviceStatus=ONLINE

Responses

Load URL on devices

Load a specific URL on one or more devices.

Minimum role: APPROVER

Authorizations:
bearer
query Parameters
customerId
required
integer <int64>

Explicit customer/tenant ID required by this operation, within the caller's access.

applyOn
required
string
Enum: "DEVICE" "DEVICEGROUP" "ALL"

Select devices, device groups, or both. The search expression filters that selection; filter device tags through search.

search
string

WBQL filter expression. Operators: : (contains), = (equals), ≠, ∉, ^ (starts with), >, ≥, <, ≤, ∈ (in set). Logic: , (AND), | (OR). Special: NULL, !NULL. Example: name:lobby,deviceStatus=ONLINE

url
required
string

Responses

Preview content on devices

Preview content on one or more devices without assigning it.

Minimum role: APPROVER

Authorizations:
bearer
query Parameters
customerId
required
integer <int64>

Explicit customer/tenant ID required by this operation, within the caller's access.

applyOn
required
string
Enum: "DEVICE" "DEVICEGROUP" "ALL"

Select devices, device groups, or both. The search expression filters that selection; filter device tags through search.

search
string

WBQL filter expression. Operators: : (contains), = (equals), ≠, ∉, ^ (starts with), >, ≥, <, ≤, ∈ (in set). Logic: , (AND), | (OR). Special: NULL, !NULL. Example: name:lobby,deviceStatus=ONLINE

contentId
required
string

Responses

Preview template on devices

Preview a template on one or more devices.

Minimum role: APPROVER

Authorizations:
bearer
query Parameters
customerId
required
integer <int64>

Explicit customer/tenant ID required by this operation, within the caller's access.

applyOn
required
string
Enum: "DEVICE" "DEVICEGROUP" "ALL"

Select devices, device groups, or both. The search expression filters that selection; filter device tags through search.

search
string

WBQL filter expression. Operators: : (contains), = (equals), ≠, ∉, ^ (starts with), >, ≥, <, ≤, ∈ (in set). Logic: , (AND), | (OR). Special: NULL, !NULL. Example: name:lobby,deviceStatus=ONLINE

templateId
required
string

Responses

Cache content on devices

Pre-cache content on one or more devices.

Minimum role: APPROVER

Authorizations:
bearer
query Parameters
customerId
required
integer <int64>

Explicit customer/tenant ID required by this operation, within the caller's access.

applyOn
required
string
Enum: "DEVICE" "DEVICEGROUP" "ALL"

Select devices, device groups, or both. The search expression filters that selection; filter device tags through search.

search
string

WBQL filter expression. Operators: : (contains), = (equals), ≠, ∉, ^ (starts with), >, ≥, <, ≤, ∈ (in set). Logic: , (AND), | (OR). Special: NULL, !NULL. Example: name:lobby,deviceStatus=ONLINE

contentId
required
string
cacheAt
string

Schedule cache operation

Responses

Cache files on devices

Pre-cache specific file URLs on one or more devices.

Minimum role: APPROVER

Authorizations:
bearer
query Parameters
customerId
required
integer <int64>

Explicit customer/tenant ID required by this operation, within the caller's access.

applyOn
required
string
Enum: "DEVICE" "DEVICEGROUP" "ALL"

Select devices, device groups, or both. The search expression filters that selection; filter device tags through search.

search
string

WBQL filter expression. Operators: : (contains), = (equals), ≠, ∉, ^ (starts with), >, ≥, <, ≤, ∈ (in set). Logic: , (AND), | (OR). Special: NULL, !NULL. Example: name:lobby,deviceStatus=ONLINE

cacheAt
string

Schedule cache operation

Request Body schema: application/json
required
Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Clear device cache

Clear cached content on one or more devices.

Minimum role: APPROVER

Authorizations:
bearer
query Parameters
customerId
required
integer <int64>

Explicit customer/tenant ID required by this operation, within the caller's access.

applyOn
required
string
Enum: "DEVICE" "DEVICEGROUP" "ALL"

Select devices, device groups, or both. The search expression filters that selection; filter device tags through search.

search
string

WBQL filter expression. Operators: : (contains), = (equals), ≠, ∉, ^ (starts with), >, ≥, <, ≤, ∈ (in set). Logic: , (AND), | (OR). Special: NULL, !NULL. Example: name:lobby,deviceStatus=ONLINE

Request Body schema: application/json
optional

Omit the body, or send an empty object, to clear without size or extension constraints.

limit
integer <int32>
Default: 0

Size threshold in MB; delete cached resources smaller than this. Zero means no size constraint.

fileExtensions
Array of strings

Extensions to delete, for example .js and .css. Omitted/null/empty means no extension constraint; blank entries are discarded. Combines with limit using AND.

Responses

Request samples

Content type
application/json
{
  • "limit": 10,
  • "fileExtensions": [
    ]
}

Request device logs

Request log files from one or more devices for troubleshooting.

Minimum role: TECHNICIAN

Authorizations:
bearer
query Parameters
customerId
integer <int64>

Select a customer/tenant within the caller's access. When this parameter is optional, omitting it uses the caller's scope: global for ADMIN, owned member customers for a network owner, and the own customer for other callers. Use an explicit customerId for customer-specific operations. Requiredness is declared per endpoint.

applyOn
required
string
Enum: "DEVICE" "DEVICEGROUP" "ALL"

Select devices, device groups, or both. The search expression filters that selection; filter device tags through search.

search
string

WBQL filter expression. Operators: : (contains), = (equals), ≠, ∉, ^ (starts with), >, ≥, <, ≤, ∈ (in set). Logic: , (AND), | (OR). Special: NULL, !NULL. Example: name:lobby,deviceStatus=ONLINE

systemLog
boolean
Default: false

Include system logs

systemReport
boolean
Default: false

Include system report

logcat
boolean
Default: false

Request Android logcat output.

bugreport
boolean
Default: false

Request an Android bug report.

Responses

Capture high-res preview

Request a high resolution preview screenshot from devices.

Minimum role: VIEWER

Authorizations:
bearer
query Parameters
customerId
integer <int64>

Select a customer/tenant within the caller's access. When this parameter is optional, omitting it uses the caller's scope: global for ADMIN, owned member customers for a network owner, and the own customer for other callers. Use an explicit customerId for customer-specific operations. Requiredness is declared per endpoint.

applyOn
required
string
Enum: "DEVICE" "DEVICEGROUP" "ALL"

Select devices, device groups, or both. The search expression filters that selection; filter device tags through search.

search
string

WBQL filter expression. Operators: : (contains), = (equals), ≠, ∉, ^ (starts with), >, ≥, <, ≤, ∈ (in set). Logic: , (AND), | (OR). Special: NULL, !NULL. Example: name:lobby,deviceStatus=ONLINE

Responses

Enable rapid preview mode

Enable rapid preview mode for frequent screenshot updates.

Minimum role: TECHNICIAN

Authorizations:
bearer
query Parameters
customerId
integer <int64>

Select a customer/tenant within the caller's access. When this parameter is optional, omitting it uses the caller's scope: global for ADMIN, owned member customers for a network owner, and the own customer for other callers. Use an explicit customerId for customer-specific operations. Requiredness is declared per endpoint.

applyOn
required
string
Enum: "DEVICE" "DEVICEGROUP" "ALL"

Select devices, device groups, or both. The search expression filters that selection; filter device tags through search.

search
string

WBQL filter expression. Operators: : (contains), = (equals), ≠, ∉, ^ (starts with), >, ≥, <, ≤, ∈ (in set). Logic: , (AND), | (OR). Special: NULL, !NULL. Example: name:lobby,deviceStatus=ONLINE

duration
required
integer <int64>

Duration in seconds

minimumDelayBetweenPreviews
required
integer <int64>

Minimum delay between previews in seconds

Responses

Set device working hours

Set working hours schedule for one or more devices. Devices automatically turn display on/off based on the schedule.

Minimum role: APPROVER

Authorizations:
bearer
query Parameters
customerId
integer <int64>

Select a customer/tenant within the caller's access. When this parameter is optional, omitting it uses the caller's scope: global for ADMIN, owned member customers for a network owner, and the own customer for other callers. Use an explicit customerId for customer-specific operations. Requiredness is declared per endpoint.

applyOn
required
string
Enum: "DEVICE" "DEVICEGROUP" "ALL"

Select devices, device groups, or both. The search expression filters that selection; filter device tags through search.

search
string

WBQL filter expression. Operators: : (contains), = (equals), ≠, ∉, ^ (starts with), >, ≥, <, ≤, ∈ (in set). Logic: , (AND), | (OR). Special: NULL, !NULL. Example: name:lobby,deviceStatus=ONLINE

Request Body schema: application/json
required
object

Map of day definitions. Keys are MON, TUE, WED, THU, FRI, SAT, SUN

mode
string
Enum: "SCREEN" "DEVICE"

Working hours mode - SCREEN (turn display off) or DEVICE (turn device off)

Responses

Request samples

Content type
application/json
{
  • "days": {
    },
  • "mode": "SCREEN"
}

Set device weather location

Set weather location for devices. Used for weather widgets in content.

Minimum role: TECHNICIAN

Authorizations:
bearer
query Parameters
customerId
required
integer <int64>

Explicit customer/tenant ID required by this operation, within the caller's access.

applyOn
required
string
Enum: "DEVICE" "DEVICEGROUP" "ALL"

Select devices, device groups, or both. The search expression filters that selection; filter device tags through search.

search
string

WBQL filter expression. Operators: : (contains), = (equals), ≠, ∉, ^ (starts with), >, ≥, <, ≤, ∈ (in set). Logic: , (AND), | (OR). Special: NULL, !NULL. Example: name:lobby,deviceStatus=ONLINE

weatherLocation
required
string

Responses

Set max update version

Set maximum version for automatic updates on devices.

Minimum role: TECHNICIAN

Authorizations:
bearer
query Parameters
customerId
required
integer <int64>

Explicit customer/tenant ID required by this operation, within the caller's access.

applyOn
required
string
Enum: "DEVICE" "DEVICEGROUP" "ALL"

Select devices, device groups, or both. The search expression filters that selection; filter device tags through search.

search
string

WBQL filter expression. Operators: : (contains), = (equals), ≠, ∉, ^ (starts with), >, ≥, <, ≤, ∈ (in set). Logic: , (AND), | (OR). Special: NULL, !NULL. Example: name:lobby,deviceStatus=ONLINE

version
required
string

Responses

Bind datasource to devices

Bind a datasource to one or more devices.

Minimum role: TECHNICIAN

Authorizations:
bearer
query Parameters
customerId
integer <int64>

Select a customer/tenant within the caller's access. When this parameter is optional, omitting it uses the caller's scope: global for ADMIN, owned member customers for a network owner, and the own customer for other callers. Use an explicit customerId for customer-specific operations. Requiredness is declared per endpoint.

applyOn
required
string
Enum: "DEVICE" "DEVICEGROUP" "ALL"

Select devices, device groups, or both. The search expression filters that selection; filter device tags through search.

search
string

WBQL filter expression. Operators: : (contains), = (equals), ≠, ∉, ^ (starts with), >, ≥, <, ≤, ∈ (in set). Logic: , (AND), | (OR). Special: NULL, !NULL. Example: name:lobby,deviceStatus=ONLINE

datasourceId
string

Datasource ID (omit to unbind)

Responses

Unbind datasource from devices

Remove datasource binding from one or more devices.

Minimum role: TECHNICIAN

Authorizations:
bearer
query Parameters
customerId
integer <int64>

Select a customer/tenant within the caller's access. When this parameter is optional, omitting it uses the caller's scope: global for ADMIN, owned member customers for a network owner, and the own customer for other callers. Use an explicit customerId for customer-specific operations. Requiredness is declared per endpoint.

applyOn
required
string
Enum: "DEVICE" "DEVICEGROUP" "ALL"

Select devices, device groups, or both. The search expression filters that selection; filter device tags through search.

search
string

WBQL filter expression. Operators: : (contains), = (equals), ≠, ∉, ^ (starts with), >, ≥, <, ≤, ∈ (in set). Logic: , (AND), | (OR). Special: NULL, !NULL. Example: name:lobby,deviceStatus=ONLINE

Responses

Set device data row ID

Set data row ID for one or more devices.

Minimum role: TECHNICIAN

Authorizations:
bearer
query Parameters
customerId
integer <int64>

Select a customer/tenant within the caller's access. When this parameter is optional, omitting it uses the caller's scope: global for ADMIN, owned member customers for a network owner, and the own customer for other callers. Use an explicit customerId for customer-specific operations. Requiredness is declared per endpoint.

applyOn
required
string
Enum: "DEVICE" "DEVICEGROUP" "ALL"

Select devices, device groups, or both. The search expression filters that selection; filter device tags through search.

search
string

WBQL filter expression. Operators: : (contains), = (equals), ≠, ∉, ^ (starts with), >, ≥, <, ≤, ∈ (in set). Logic: , (AND), | (OR). Special: NULL, !NULL. Example: name:lobby,deviceStatus=ONLINE

dataRowId
string

Data row ID (omit to clear)

Responses

Remove device data row ID

Remove data row ID from one or more devices.

Minimum role: TECHNICIAN

Authorizations:
bearer
query Parameters
customerId
integer <int64>

Select a customer/tenant within the caller's access. When this parameter is optional, omitting it uses the caller's scope: global for ADMIN, owned member customers for a network owner, and the own customer for other callers. Use an explicit customerId for customer-specific operations. Requiredness is declared per endpoint.

applyOn
required
string
Enum: "DEVICE" "DEVICEGROUP" "ALL"

Select devices, device groups, or both. The search expression filters that selection; filter device tags through search.

search
string

WBQL filter expression. Operators: : (contains), = (equals), ≠, ∉, ^ (starts with), >, ≥, <, ≤, ∈ (in set). Logic: , (AND), | (OR). Special: NULL, !NULL. Example: name:lobby,deviceStatus=ONLINE

Responses

Set device sensor configuration

Set sensor configuration for one or more devices.

Minimum role: TECHNICIAN

Authorizations:
bearer
query Parameters
customerId
required
integer <int64>

Explicit customer/tenant ID required by this operation, within the caller's access.

applyOn
required
string
Enum: "DEVICE" "DEVICEGROUP" "ALL"

Select devices, device groups, or both. The search expression filters that selection; filter device tags through search.

search
string

WBQL filter expression. Operators: : (contains), = (equals), ≠, ∉, ^ (starts with), >, ≥, <, ≤, ∈ (in set). Logic: , (AND), | (OR). Special: NULL, !NULL. Example: name:lobby,deviceStatus=ONLINE

Request Body schema: application/json
required
string

Sensor configuration JSON

Responses

Request samples

Content type
application/json
"string"

Reset device sensor

Reset sensor on one or more devices.

Minimum role: TECHNICIAN

Authorizations:
bearer
query Parameters
customerId
required
integer <int64>

Explicit customer/tenant ID required by this operation, within the caller's access.

applyOn
required
string
Enum: "DEVICE" "DEVICEGROUP" "ALL"

Select devices, device groups, or both. The search expression filters that selection; filter device tags through search.

search
string

WBQL filter expression. Operators: : (contains), = (equals), ≠, ∉, ^ (starts with), >, ≥, <, ≤, ∈ (in set). Logic: , (AND), | (OR). Special: NULL, !NULL. Example: name:lobby,deviceStatus=ONLINE

Responses

Set advanced configuration

Set advanced configuration for one or more devices. Advanced configuration is a JSON object with device-specific settings.

Minimum role: TECHNICIAN

Authorizations:
bearer
query Parameters
customerId
integer <int64>

Select a customer/tenant within the caller's access. When this parameter is optional, omitting it uses the caller's scope: global for ADMIN, owned member customers for a network owner, and the own customer for other callers. Use an explicit customerId for customer-specific operations. Requiredness is declared per endpoint.

applyOn
required
string
Enum: "DEVICE" "DEVICEGROUP" "ALL"

Select devices, device groups, or both. The search expression filters that selection; filter device tags through search.

search
string

WBQL filter expression. Operators: : (contains), = (equals), ≠, ∉, ^ (starts with), >, ≥, <, ≤, ∈ (in set). Logic: , (AND), | (OR). Special: NULL, !NULL. Example: name:lobby,deviceStatus=ONLINE

updateMethod
string
Default: "SET"
Enum: "SET" "MERGE"

How to apply the configuration

Request Body schema: application/json
required
object

Advanced configuration JSON

Responses

Request samples

Content type
application/json
{ }

Set device update rule

Set update rule for one or more devices. Controls when and how software updates are applied.

Minimum role: TECHNICIAN

Authorizations:
bearer
query Parameters
customerId
integer <int64>

Select a customer/tenant within the caller's access. When this parameter is optional, omitting it uses the caller's scope: global for ADMIN, owned member customers for a network owner, and the own customer for other callers. Use an explicit customerId for customer-specific operations. Requiredness is declared per endpoint.

applyOn
required
string
Enum: "DEVICE" "DEVICEGROUP" "ALL"

Select devices, device groups, or both. The search expression filters that selection; filter device tags through search.

search
string

WBQL filter expression. Operators: : (contains), = (equals), ≠, ∉, ^ (starts with), >, ≥, <, ≤, ∈ (in set). Logic: , (AND), | (OR). Special: NULL, !NULL. Example: name:lobby,deviceStatus=ONLINE

Request Body schema: application/json
required
object

Update rule configuration

Responses

Request samples

Content type
application/json
{ }

Install application on devices

Install an application on one or more devices.

Minimum role: TECHNICIAN

Authorizations:
bearer
query Parameters
customerId
integer <int64>

Select a customer/tenant within the caller's access. When this parameter is optional, omitting it uses the caller's scope: global for ADMIN, owned member customers for a network owner, and the own customer for other callers. Use an explicit customerId for customer-specific operations. Requiredness is declared per endpoint.

applyOn
required
string
Enum: "DEVICE" "DEVICEGROUP" "ALL"

Select devices, device groups, or both. The search expression filters that selection; filter device tags through search.

search
string

WBQL filter expression. Operators: : (contains), = (equals), ≠, ∉, ^ (starts with), >, ≥, <, ≤, ∈ (in set). Logic: , (AND), | (OR). Special: NULL, !NULL. Example: name:lobby,deviceStatus=ONLINE

url
required
string

Application download URL

Request Body schema: application/json
required
property name*
additional property
string

Responses

Request samples

Content type
application/json
{
  • "property1": "string",
  • "property2": "string"
}

Move devices and groups

Move multiple devices and device groups to a new parent.

Minimum role: TECHNICIAN

Authorizations:
bearer
Request Body schema: application/json
required
deviceIds
Array of strings

Device IDs to move

groupIds
Array of strings

Device group IDs to move

targetGroupId
string

Target device group ID

Responses

Request samples

Content type
application/json
{
  • "deviceIds": [
    ],
  • "groupIds": [
    ],
  • "targetGroupId": "string"
}

Get device preview images (screenshots)

Retrieves historical preview images (screenshots) for a device.

Devices periodically upload screenshots showing their current display. Up to 20 historical preview images are stored per device.

Use case for AI: These preview images can be analyzed to verify content is displaying correctly, detect issues, or perform visual QA.

Minimum role: VIEWER

Image access: Use the apiPath in the response to retrieve the actual image via /api/storage/{path}.

Authorizations:
bearer
path Parameters
deviceId
required
string

Device ID

Responses

Response samples

Content type
application/json
{
  • "content": [
    ]
}

Get device location images

Get location images for a device.

Minimum role: VIEWER

Authorizations:
bearer
path Parameters
deviceId
required
string

Responses

Response samples

Content type
application/json
{
  • "content": [
    ]
}

Upload device location image

Upload a location image for a device.

Minimum role: TECHNICIAN

Authorizations:
bearer
path Parameters
deviceId
required
string
Request Body schema: multipart/form-data
file
string <binary>

Responses

Response samples

Content type
application/json
{
  • "content": [
    ]
}

Delete device location image

Delete a location image from a device.

Minimum role: TECHNICIAN

Authorizations:
bearer
path Parameters
deviceId
required
string
query Parameters
fileName
required
string

Responses

Response samples

Content type
application/json
{
  • "content": [
    ]
}

Get device logs

Get stored logs for a device.

Minimum role: TECHNICIAN

Authorizations:
bearer
path Parameters
deviceId
required
string

Responses

Response samples

Content type
application/json
{
  • "logs": [
    ]
}

Update device

Update a device.

Minimum role: TECHNICIAN

Authorizations:
bearer
path Parameters
deviceId
required
string
Request Body schema: application/json
required
name
string
comment
string
emergencyStatus
boolean
enabledConsole
boolean
enabledName
boolean
showDeviceInfo
boolean
showStateIndicator
boolean
adminMetadata
object

Custom admin metadata (JSON)

integer or string (DateInput)

Date input accepts Unix milliseconds or an ISO 8601 date-time string. Date responses use Unix milliseconds.

resetCommissioningDate
boolean
integer or string (DateInput)

Date input accepts Unix milliseconds or an ISO 8601 date-time string. Date responses use Unix milliseconds.

resetReplacementDate
boolean
dataRowId
string
resetDataRowId
boolean
sensorConfig
string
resetSensorConfig
boolean
updateVersionUpperLimit
string
resetUpdateVersionUpperLimit
boolean
rebootTime
string
resetRebootTime
boolean
weatherLocation
string
resetWeatherLocation
boolean
volumeLevel
integer [ 0 .. 100 ]
brightnessLevel
integer [ 0 .. 100 ]
displayStatus
string
Enum: "ON" "OFF"
locked
boolean
timeZone
string
resetTimeZone
boolean
longitude
number <double>
latitude
number <double>
zoom
number <float>
locationMetaData
object

Location metadata (JSON)

resetLocationMetaData
boolean
object (DeviceRotation)

Device screen rotation settings

object (DeviceWorkingHours)

Device working hours schedule. Days is a map where keys are MON, TUE, WED, THU, FRI, SAT, SUN

resetWorkingHours
boolean
advancedConfiguration
object

Advanced configuration (JSON)

resetAdvancedConfiguration
boolean
updateRule
object

Update rule configuration (JSON)

resetUpdateRule
boolean
venueId
string
resetVenueId
boolean
dspId
string
resetDspId
boolean
dspAttributes
object

DSP attributes (JSON)

resetDspAttributes
boolean
contentLanguage
string
resetContentLanguage
boolean
resetViewerCount
boolean
viewerCount
any

JSON value.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "comment": "string",
  • "emergencyStatus": true,
  • "enabledConsole": true,
  • "enabledName": true,
  • "showDeviceInfo": true,
  • "showStateIndicator": true,
  • "adminMetadata": { },
  • "commissioningDate": 1704067200000,
  • "resetCommissioningDate": true,
  • "replacementDate": 1704067200000,
  • "resetReplacementDate": true,
  • "dataRowId": "string",
  • "resetDataRowId": true,
  • "sensorConfig": "string",
  • "resetSensorConfig": true,
  • "updateVersionUpperLimit": "string",
  • "resetUpdateVersionUpperLimit": true,
  • "rebootTime": "string",
  • "resetRebootTime": true,
  • "weatherLocation": "string",
  • "resetWeatherLocation": true,
  • "volumeLevel": 100,
  • "brightnessLevel": 100,
  • "displayStatus": "ON",
  • "locked": true,
  • "timeZone": "string",
  • "resetTimeZone": true,
  • "longitude": 0.1,
  • "latitude": 0.1,
  • "zoom": 0.1,
  • "locationMetaData": { },
  • "resetLocationMetaData": true,
  • "rotation": {
    },
  • "workingHours": {
    },
  • "resetWorkingHours": true,
  • "advancedConfiguration": { },
  • "resetAdvancedConfiguration": true,
  • "updateRule": { },
  • "resetUpdateRule": true,
  • "venueId": "string",
  • "resetVenueId": true,
  • "dspId": "string",
  • "resetDspId": true,
  • "dspAttributes": { },
  • "resetDspAttributes": true,
  • "contentLanguage": "string",
  • "resetContentLanguage": true,
  • "resetViewerCount": true,
  • "viewerCount": null
}

Delete device

Delete a device.

Minimum role: TECHNICIAN

Authorizations:
bearer
path Parameters
deviceId
required
string

Responses

Export devices to CSV

Export devices to CSV format.

Minimum role: TECHNICIAN

Authorizations:
bearer
query Parameters
customerId
integer <int64>

Select a customer/tenant within the caller's access. When this parameter is optional, omitting it uses the caller's scope: global for ADMIN, owned member customers for a network owner, and the own customer for other callers. Use an explicit customerId for customer-specific operations. Requiredness is declared per endpoint.

search
string

WBQL filter expression. Operators: : (contains), = (equals), ≠, ∉, ^ (starts with), >, ≥, <, ≤, ∈ (in set). Logic: , (AND), | (OR). Special: NULL, !NULL. Example: name:lobby,deviceStatus=ONLINE

Responses

Rename device

Rename a device.

Minimum role: TECHNICIAN

Authorizations:
bearer
path Parameters
deviceId
required
string
query Parameters
deviceName
required
string

Responses

Update device team assignments

Update team assignments for a device.

Minimum role: OWNER

Authorizations:
bearer
query Parameters
customerId
integer <int64>

Select a customer/tenant within the caller's access. When this parameter is optional, omitting it uses the caller's scope: global for ADMIN, owned member customers for a network owner, and the own customer for other callers. Use an explicit customerId for customer-specific operations. Requiredness is declared per endpoint.

deviceId
required
string
Request Body schema: application/json
required
Array of objects

Teams to assign the resource to

removeFromTeamIds
Array of strings

Team IDs to remove the resource from

Responses

Request samples

Content type
application/json
{
  • "assignToTeams": [
    ],
  • "removeFromTeamIds": [
    ]
}

device group

Device grouping and hierarchy

List device groups

Retrieve device groups (folders).

Minimum role: VIEWER

Authorizations:
bearer
query Parameters
customerId
integer <int64>

Select a customer/tenant within the caller's access. When this parameter is optional, omitting it uses the caller's scope: global for ADMIN, owned member customers for a network owner, and the own customer for other callers. Use an explicit customerId for customer-specific operations. Requiredness is declared per endpoint.

search
string

WBQL filter expression. Operators: : (contains), = (equals), ≠, ∉, ^ (starts with), >, ≥, <, ≤, ∈ (in set). Logic: , (AND), | (OR). Special: NULL, !NULL. Example: name:lobby,deviceStatus=ONLINE

page
integer >= 0
Default: 0

Page index (0-based)

size
integer >= 1
Default: 20

Requested page size; server limits and endpoint overrides apply.

sort
string
Example: sort=name,asc

Sort expression. Format: field,direction

  • Directions: asc, desc
  • Multiple sorts: sort=name,asc&sort=lastActivity,desc
  • Nested fields: sort=content.name,asc
select
string

Field projection. * = all primitives, field,field = specific, relation(fields) = nested. Example: select=*,customer(id,name)

includeReadOnlyInfo
boolean
Default: false

Include readOnly attribute in response. Set to false for better performance when not needed.

Responses

Response samples

Content type
application/json
{
  • "first": true,
  • "last": true,
  • "number": 0,
  • "numberOfElements": 0,
  • "totalElements": 0,
  • "totalPages": 0,
  • "size": 0,
  • "content": [
    ]
}

Create device group

Create a new device group (folder) under a parent group. The deviceGroupId path parameter is the parent group ID.

Minimum role: TECHNICIAN

Authorizations:
bearer
path Parameters
deviceGroupId
required
string

Parent group ID to create the new group under

Request Body schema: application/json
required
name
string
comment
string
location
string
longitude
number <double>
latitude
number <double>
zoom
number <float>
locationMetaData
object

Location metadata (JSON)

resetLocationMetaData
boolean
tags
Array of strings
inheritTagsToDevices
boolean
resetVideoWallMetaData
boolean
type
string
Enum: "NORMAL" "VIDEO_WALL"
videoWallMetaData
any

JSON value.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "comment": "string",
  • "location": "string",
  • "longitude": 0.1,
  • "latitude": 0.1,
  • "zoom": 0.1,
  • "locationMetaData": { },
  • "resetLocationMetaData": true,
  • "tags": [
    ],
  • "inheritTagsToDevices": true,
  • "resetVideoWallMetaData": true,
  • "type": "NORMAL",
  • "videoWallMetaData": null
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "comment": "string",
  • "customerId": 0,
  • "parentId": "string",
  • "readOnly": true,
  • "alertCount": 0,
  • "deviceGroupPath": "string",
  • "inheritTagsToDevices": true,
  • "lastSavedAt": 0,
  • "lastSavedByEmail": "string",
  • "latitude": 0.1,
  • "location": "string",
  • "locationMetaData": null,
  • "longitude": 0.1,
  • "tags": [
    ],
  • "type": "NORMAL",
  • "updateVersionUpperLimit": "string",
  • "videoWallMetaData": null,
  • "zoom": 0.1
}

Update device group

Update a device group (folder) properties like name.

Minimum role: TECHNICIAN

Authorizations:
bearer
path Parameters
deviceGroupId
required
string
Request Body schema: application/json
required
name
string
comment
string
location
string
longitude
number <double>
latitude
number <double>
zoom
number <float>
locationMetaData
object

Location metadata (JSON)

resetLocationMetaData
boolean
tags
Array of strings
inheritTagsToDevices
boolean
resetVideoWallMetaData
boolean
type
string
Enum: "NORMAL" "VIDEO_WALL"
videoWallMetaData
any

JSON value.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "comment": "string",
  • "location": "string",
  • "longitude": 0.1,
  • "latitude": 0.1,
  • "zoom": 0.1,
  • "locationMetaData": { },
  • "resetLocationMetaData": true,
  • "tags": [
    ],
  • "inheritTagsToDevices": true,
  • "resetVideoWallMetaData": true,
  • "type": "NORMAL",
  • "videoWallMetaData": null
}

Delete device group

Delete a device group (folder). Child devices can optionally be moved to another group using targetGroupId parameter. If not specified, devices are moved to the parent group.

Minimum role: TECHNICIAN

Authorizations:
bearer
path Parameters
deviceGroupId
required
string
query Parameters
targetGroupId
string

Target group for child devices (optional, defaults to parent)

Responses

Get device group hierarchy

Get the full device group (folder) hierarchy tree. Returns nested structure suitable for tree navigation components.

Minimum role: VIEWER

Authorizations:
bearer
query Parameters
customerId
integer <int64>

Select a customer/tenant within the caller's access. When this parameter is optional, omitting it uses the caller's scope: global for ADMIN, owned member customers for a network owner, and the own customer for other callers. Use an explicit customerId for customer-specific operations. Requiredness is declared per endpoint.

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "children": [
    ],
  • "deviceGroupId": "string",
  • "parentId": "string",
  • "readOnly": true,
  • "type": "NORMAL"
}

Get device online/offline ratio

Get online/offline device counts per group (folder). Useful for displaying health indicators on folder tree items.

Minimum role: VIEWER

Authorizations:
bearer
query Parameters
customerId
integer <int64>

Select a customer/tenant within the caller's access. When this parameter is optional, omitting it uses the caller's scope: global for ADMIN, owned member customers for a network owner, and the own customer for other callers. Use an explicit customerId for customer-specific operations. Requiredness is declared per endpoint.

search
string

WBQL filter expression. Operators: : (contains), = (equals), ≠, ∉, ^ (starts with), >, ≥, <, ≤, ∈ (in set). Logic: , (AND), | (OR). Special: NULL, !NULL. Example: name:lobby,deviceStatus=ONLINE

deviceSearch
string

WBQL search for devices

page
integer >= 0
Default: 0

Page index (0-based)

size
integer >= 1
Default: 20

Requested page size; server limits and endpoint overrides apply.

Responses

Response samples

Content type
application/json
{
  • "property1": {
    },
  • "property2": {
    }
}

Move device group to new parent

Move a device group (folder) to a different parent folder. Maintains all devices and subfolders within the moved folder.

Minimum role: TECHNICIAN

Authorizations:
bearer
path Parameters
deviceGroupId
required
string
targetGroupId
required
string

Responses

Update device group team assignments

Update team assignments for a device group (folder). Controls which teams can view and manage devices in this folder.

Minimum role: OWNER

Authorizations:
bearer
query Parameters
customerId
integer <int64>

Select a customer/tenant within the caller's access. When this parameter is optional, omitting it uses the caller's scope: global for ADMIN, owned member customers for a network owner, and the own customer for other callers. Use an explicit customerId for customer-specific operations. Requiredness is declared per endpoint.

deviceGroupId
required
string
Request Body schema: application/json
required
Array of objects

Teams to assign the resource to

removeFromTeamIds
Array of strings

Team IDs to remove the resource from

Responses

Request samples

Content type
application/json
{
  • "assignToTeams": [
    ],
  • "removeFromTeamIds": [
    ]
}

device install rule

Device auto-provisioning rules

List device install rules

Retrieve device installation rules for auto-provisioning.

Minimum role: TECHNICIAN

Authorizations:
bearer
query Parameters
customerId
integer <int64>

Select a customer/tenant within the caller's access. When this parameter is optional, omitting it uses the caller's scope: global for ADMIN, owned member customers for a network owner, and the own customer for other callers. Use an explicit customerId for customer-specific operations. Requiredness is declared per endpoint.

search
string

WBQL filter expression. Operators: : (contains), = (equals), ≠, ∉, ^ (starts with), >, ≥, <, ≤, ∈ (in set). Logic: , (AND), | (OR). Special: NULL, !NULL. Example: name:lobby,deviceStatus=ONLINE

page
integer >= 0
Default: 0

Page index (0-based)

size
integer >= 1
Default: 20

Requested page size; server limits and endpoint overrides apply.

includeDetails
boolean
Default: false

Include full details (device group, content, etc.)

Responses

Response samples

Content type
application/json
{
  • "first": true,
  • "last": true,
  • "number": 0,
  • "numberOfElements": 0,
  • "totalElements": 0,
  • "totalPages": 0,
  • "size": 0,
  • "content": [
    ]
}

Create device install rule

Create a new device installation rule.

Minimum role: TECHNICIAN

Authorizations:
bearer
query Parameters
customerId
integer <int64>

Select a customer/tenant within the caller's access. When this parameter is optional, omitting it uses the caller's scope: global for ADMIN, owned member customers for a network owner, and the own customer for other callers. Use an explicit customerId for customer-specific operations. Requiredness is declared per endpoint.

Request Body schema: application/json
required
name
required
string
deviceGroupId
string

Device folder ID to place new devices in

contentId
string

Base content to assign

emergencyContentId
string

Emergency content

datasourceId
string

Datasource ID to bind

brightnessLevel
integer [ 0 .. 100 ]
volumeLevel
integer [ 0 .. 100 ]
showName
boolean

Display device name overlay

showConsole
boolean

Show debug console

showDeviceInfo
boolean

Show device info overlay

showStateIndicator
boolean

Show connection state indicator

timeZone
string

IANA timezone identifier

object (DeviceRotation)

Device screen rotation settings

object (DeviceWorkingHours)

Device working hours schedule. Days is a map where keys are MON, TUE, WED, THU, FRI, SAT, SUN

tags
string

Comma-separated tag names

updateVersionUpperLimit
string

Maximum app version device can update to

rebootTime
string

Daily scheduled reboot time (HH:mm format)

dataRowId
string

Specific data row ID within the datasource

sensorConfig
string

Sensor configuration (JSON string)

weatherLocation
string

Location string for weather widgets

licenseType
string (LicenseType)
Enum: "BASIC" "PROFESSIONAL" "DBA" "ENTERPRISE" "VIDEO_WALL"

Device license tier. Higher tiers include all features of lower tiers.

API Value UI Name Features
BASIC Lite Basic content types (media, simple layouts)
PROFESSIONAL Professional + Complex/interactive content
DBA Broadcaster Legacy tier (not used for new orders)
ENTERPRISE Premium All features
VIDEO_WALL Video Wall Premium + video wall sync

When is this field used?

  • licenseStatus=FREE: Use this field to set the tier
  • licenseStatus=LICENSED: Ignored - tier comes from LicenseOrder
  • licenseStatus=UN_LICENSED: Ignored - no tier applies
licenseStatus
string (DeviceLicenseStatus)
Enum: "UN_LICENSED" "LICENSED" "FREE" "TRIAL"

Device license state. Determines if device can display content.

Status Content Display Tier Source
UN_LICENSED ❌ "License expired" screen N/A
LICENSED ✅ Yes From LicenseOrder
FREE ✅ Yes From licenseType field
TRIAL ✅ Yes (Currently unused)

Typical workflow:

  1. New devices start as UN_LICENSED
  2. Assign LICENSED + licenseOrderId for paid customers

FREE status: Limited availability, requires customer configuration.

licenseOrderId
integer <int64>

License order ID

teamIds
Array of strings

Team IDs to assign access

advancedConfiguration
object

Advanced configuration (JSON)

updateRule
object

Update rule configuration (JSON)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "deviceGroupId": "string",
  • "contentId": "string",
  • "emergencyContentId": "string",
  • "datasourceId": "string",
  • "brightnessLevel": 100,
  • "volumeLevel": 100,
  • "showName": true,
  • "showConsole": true,
  • "showDeviceInfo": true,
  • "showStateIndicator": true,
  • "timeZone": "string",
  • "rotation": {
    },
  • "workingHours": {
    },
  • "tags": "string",
  • "updateVersionUpperLimit": "string",
  • "rebootTime": "string",
  • "dataRowId": "string",
  • "sensorConfig": "string",
  • "weatherLocation": "string",
  • "licenseType": "BASIC",
  • "licenseStatus": "UN_LICENSED",
  • "licenseOrderId": 0,
  • "teamIds": [
    ],
  • "advancedConfiguration": { },
  • "updateRule": { }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "installKey": "string",
  • "readOnly": true,
  • "advancedConfiguration": null,
  • "brightnessLevel": 0,
  • "contentId": "string",
  • "contentName": "string",
  • "dataRowId": "string",
  • "datasourceId": "string",
  • "datasourceName": "string",
  • "deviceGroupId": "string",
  • "deviceGroupName": "string",
  • "emergencyContentId": "string",
  • "emergencyContentName": "string",
  • "licenseOrderId": 0,
  • "licenseStatus": "UN_LICENSED",
  • "licenseType": "BASIC",
  • "rebootTime": "string",
  • "sensorConfig": "string",
  • "showConsole": true,
  • "showDeviceInfo": true,
  • "showName": true,
  • "showStateIndicator": true,
  • "tags": "string",
  • "timeZone": "string",
  • "updateRule": null,
  • "updateVersionUpperLimit": "string",
  • "volumeLevel": 0,
  • "weatherLocation": "string"
}

Update device install rule

Update a device installation rule.

Minimum role: TECHNICIAN

Authorizations:
bearer
query Parameters
deviceInstallRuleId
required
integer <int64>
Request Body schema: application/json
required
name
required
string
deviceGroupId
string

Device folder ID to place new devices in

contentId
string

Base content to assign

emergencyContentId
string

Emergency content

datasourceId
string

Datasource ID to bind

brightnessLevel
integer [ 0 .. 100 ]
volumeLevel
integer [ 0 .. 100 ]
showName
boolean

Display device name overlay

showConsole
boolean

Show debug console

showDeviceInfo
boolean

Show device info overlay

showStateIndicator
boolean

Show connection state indicator

timeZone
string

IANA timezone identifier

object (DeviceRotation)

Device screen rotation settings

object (DeviceWorkingHours)

Device working hours schedule. Days is a map where keys are MON, TUE, WED, THU, FRI, SAT, SUN

tags
string

Comma-separated tag names

updateVersionUpperLimit
string

Maximum app version device can update to

rebootTime
string

Daily scheduled reboot time (HH:mm format)

dataRowId
string

Specific data row ID within the datasource

sensorConfig
string

Sensor configuration (JSON string)

weatherLocation
string

Location string for weather widgets

licenseType
string (LicenseType)
Enum: "BASIC" "PROFESSIONAL" "DBA" "ENTERPRISE" "VIDEO_WALL"

Device license tier. Higher tiers include all features of lower tiers.

API Value UI Name Features
BASIC Lite Basic content types (media, simple layouts)
PROFESSIONAL Professional + Complex/interactive content
DBA Broadcaster Legacy tier (not used for new orders)
ENTERPRISE Premium All features
VIDEO_WALL Video Wall Premium + video wall sync

When is this field used?

  • licenseStatus=FREE: Use this field to set the tier
  • licenseStatus=LICENSED: Ignored - tier comes from LicenseOrder
  • licenseStatus=UN_LICENSED: Ignored - no tier applies
licenseStatus
string (DeviceLicenseStatus)
Enum: "UN_LICENSED" "LICENSED" "FREE" "TRIAL"

Device license state. Determines if device can display content.

Status Content Display Tier Source
UN_LICENSED ❌ "License expired" screen N/A
LICENSED ✅ Yes From LicenseOrder
FREE ✅ Yes From licenseType field
TRIAL ✅ Yes (Currently unused)

Typical workflow:

  1. New devices start as UN_LICENSED
  2. Assign LICENSED + licenseOrderId for paid customers

FREE status: Limited availability, requires customer configuration.

licenseOrderId
integer <int64>

License order ID

teamIds
Array of strings

Team IDs to assign access

advancedConfiguration
object

Advanced configuration (JSON)

updateRule
object

Update rule configuration (JSON)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "deviceGroupId": "string",
  • "contentId": "string",
  • "emergencyContentId": "string",
  • "datasourceId": "string",
  • "brightnessLevel": 100,
  • "volumeLevel": 100,
  • "showName": true,
  • "showConsole": true,
  • "showDeviceInfo": true,
  • "showStateIndicator": true,
  • "timeZone": "string",
  • "rotation": {
    },
  • "workingHours": {
    },
  • "tags": "string",
  • "updateVersionUpperLimit": "string",
  • "rebootTime": "string",
  • "dataRowId": "string",
  • "sensorConfig": "string",
  • "weatherLocation": "string",
  • "licenseType": "BASIC",
  • "licenseStatus": "UN_LICENSED",
  • "licenseOrderId": 0,
  • "teamIds": [
    ],
  • "advancedConfiguration": { },
  • "updateRule": { }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "installKey": "string",
  • "readOnly": true,
  • "advancedConfiguration": null,
  • "brightnessLevel": 0,
  • "contentId": "string",
  • "contentName": "string",
  • "dataRowId": "string",
  • "datasourceId": "string",
  • "datasourceName": "string",
  • "deviceGroupId": "string",
  • "deviceGroupName": "string",
  • "emergencyContentId": "string",
  • "emergencyContentName": "string",
  • "licenseOrderId": 0,
  • "licenseStatus": "UN_LICENSED",
  • "licenseType": "BASIC",
  • "rebootTime": "string",
  • "sensorConfig": "string",
  • "showConsole": true,
  • "showDeviceInfo": true,
  • "showName": true,
  • "showStateIndicator": true,
  • "tags": "string",
  • "timeZone": "string",
  • "updateRule": null,
  • "updateVersionUpperLimit": "string",
  • "volumeLevel": 0,
  • "weatherLocation": "string"
}

Delete device install rule

Delete a device installation rule.

Minimum role: TECHNICIAN

Authorizations:
bearer
path Parameters
deviceInstallRuleId
required
integer <int64>

Responses

Regenerate install key

Regenerate the install key for a device install rule.

Minimum role: TECHNICIAN

Authorizations:
bearer
query Parameters
deviceInstallRuleId
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "newInstallKey": "string"
}

Update install rule team assignments

Update team assignments for a device install rule.

Minimum role: OWNER

Authorizations:
bearer
query Parameters
customerId
integer <int64>

Select a customer/tenant within the caller's access. When this parameter is optional, omitting it uses the caller's scope: global for ADMIN, owned member customers for a network owner, and the own customer for other callers. Use an explicit customerId for customer-specific operations. Requiredness is declared per endpoint.

deviceInstallRuleId
required
integer <int64>
Request Body schema: application/json
required
Array of objects

Teams to assign the resource to

removeFromTeamIds
Array of strings

Team IDs to remove the resource from

Responses

Request samples

Content type
application/json
{
  • "assignToTeams": [
    ],
  • "removeFromTeamIds": [
    ]
}