applyBulkOperation

POST

/api/v1/screens/bulk/apply

curl --request POST \
  --url https://example.com/api/v1/screens/bulk/apply \
  --header 'Content-Type: application/json' \
  --data '{ "screenIds": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ], "action": "example", "playlistId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "layoutId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "enabled": true, "commandType": "example", "commandPayload": {}, "expectedChangeCount": 1 }'

Apply a fleet bulk operation, refusing with 409 when the fleet no longer matches the confirmed preview’s expected change count. Requires an Owner or Administrator with the write scope. Cookie-authenticated unsafe requests require X-CSRF-Token.

Parameters

Header Parameters

X-CSRF-Token

string

Cookie-backed browser requests only, and only on unsafe methods. Bearer grants never send it.

Request Body^required

Media typeapplication/json

object

screenIds

required

Array<string>

action

required

string

playlistId

string format: uuid

layoutId

string format: uuid

enabled

boolean

commandType

string

commandPayload

object

key

additional properties

any

expectedChangeCount

integer

Example^generated

{
  "screenIds": [
    "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
  ],
  "action": "example",
  "playlistId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "layoutId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "enabled": true,
  "commandType": "example",
  "commandPayload": {},
  "expectedChangeCount": 1
}

Responses

200

Bulk operation applied

Media typeapplication/json

object

data

required

object

id

required

string format: uuid

action

required

string

Allowed values: assign_playlist assign_layout clear_assignment set_enabled send_command

screenCount

required

integer

appliedCount

required

integer

skippedCount

required

integer

failedCount

required

integer

results

required

Array<object>

One screen inside a bulk preview or result. Current and Next are written for a person to read, not parsed.

object

screenId

required

string format: uuid

name

required

string

location

string

current

required

string

next

required

string

changes

required

boolean

blocked

string

fromGroup

string

selected

required

boolean

applied

boolean

error

string

reversible

required

boolean

undoExpiresAt

string format: date-time

undoneAt

string format: date-time

createdAt

required

string format: date-time

Example

{
  "data": {
    "action": "assign_playlist"
  }
}

400

Invalid request body

401

Dashboard authentication required

403

Insufficient role or screen scope

409

Fleet changed since the confirmed preview

422

Bulk operation invalid