Send Batch Command

Authorizations

Authorization

string

header

required

API key based authentication where <encoded-value> is the Base64 encoding of API_KEY_ID:API_KEY_SECRET

Username: The API Key ID.
Password: The API Key Secret.

Path Parameters

orgId

string

required

The ID of the organization. Locate the orgId under Organization Settings > API Keys.

Body

application/json

deviceIds

string[]

List of unique identifiers (serial numbers) of devices

action

enum<string>

Launch an application on the devices

Available options:

LAUNCH_APP

Example:

"LAUNCH_APP"

data

object

data.packageName

string

The package name of the app to be launched

Example:

"com.myapp.quest"

data.launchParams

object

(Optional) Additional custom launch parameters

e.g., { userId: 'ABC123', booleanValue: true, arrayValue: [1.23, 4.56], mapValue: { key: 'more stuff' }}

Example:

{
  "userId": "ABC123",
  "booleanValue": true,
  "floatValue": 100.29,
  "arrayValue": [1.23, 4.56],
  "mapValue": { "key": "more stuff" }
}

deviceIds

string[]

List of unique identifiers (serial numbers) of devices

action

enum<string>

Launch an application on the devices

Available options:

LAUNCH_APP

Example:

"LAUNCH_APP"

data

object

data.packageName

string

The package name of the app to be launched

Example:

"com.myapp.quest"

data.launchParams

object

(Optional) Additional custom launch parameters

e.g., { userId: 'ABC123', booleanValue: true, arrayValue: [1.23, 4.56], mapValue: { key: 'more stuff' }}

Example:

{
  "userId": "ABC123",
  "booleanValue": true,
  "floatValue": 100.29,
  "arrayValue": [1.23, 4.56],
  "mapValue": { "key": "more stuff" }
}

deviceIds

string[]

List of unique identifiers (serial numbers) of devices

action

enum<string>

Play or pause video on the devices

Available options:

PLAY_VIDEO,

PAUSE_VIDEO

Example:

"PLAY_VIDEO"

data

object

deviceIds

string[]

List of unique identifiers (serial numbers) of devices

action

enum<string>

Launch a specific WebXR link on the devices. Requires the data field to be populated (see below)

Available options:

LAUNCH_WEB_URL

Example:

"LAUNCH_WEB_URL"

data

object

deviceIds

string[]

List of unique identifiers (serial numbers) of devices

action

enum<string>

Override the device experience set on the Configuration.

DISABLE_KIOSK - Disable Kiosk Mode / ManageXR Home Screen on the devices. Grants users full access to the default system menus. Sets kioskModeOverride flag on devices to true.

ENABLE_KIOSK - Re-Enable Kiosk Mode / ManageXR Home Screen on the devices. Sets kioskModeOverride flag on devices to false.

Note, if the Configuration applied to a device uses Default Device Menus, the kioskModeOverride flag is a no-op.

Available options:

DISABLE_KIOSK,

ENABLE_KIOSK

Example:

"DISABLE_KIOSK"

deviceIds

string[]

List of unique identifiers (serial numbers) of devices

action

enum<string>

Reboot the devices

Available options:

RESTART

Example:

"RESTART"

deviceIds

string[]

List of unique identifiers (serial numbers) of devices

action

enum<string>

Remotely turn off devices. Supported on Pico Neo 3s PUI 5+ and Pico 4 Ultra Enterprise devices.

Available options:

POWER_OFF

Example:

"POWER_OFF"

deviceIds

string[]

List of unique identifiers (serial numbers) of devices

action

enum<string>

Set volume on device. Supply a level between 0 and 100.

Available options:

SET_VOLUME

Example:

"SET_VOLUME"

data

object

deviceIds

string[]

List of unique identifiers (serial numbers) of devices

action

enum<string>

Set brightness on device. Supply a level between 0 and 100.

Available options:

SET_BRIGHTNESS

Example:

"SET_BRIGHTNESS"

data

object

deviceIds

string[]

List of unique identifiers (serial numbers) of devices

action

enum<string>

Uninstall an application on the devices.

Cannot uninstall system apps. If you uninstall an app that is still on a devices's configuration, it will automatically re-download the next time the device syncs.

Available options:

UNINSTALL_APP

Example:

"LAUNCH_APP"

data

object

deviceIds

string[]

List of unique identifiers (serial numbers) of devices

action

enum<string>

Restart an app

Available options:

RESTART_APP

Example:

"RESTART_APP"

data

object

deviceIds

string[]

List of unique identifiers (serial numbers) of devices

action

enum<string>

Force devices to check in with ManageXR. Online devices sync every 15 minutes or immediately when configuration changes are made.

Available options:

SYNC

Example:

"SYNC"

deviceIds

string[]

List of unique identifiers (serial numbers) of devices

action

enum<string>

When Tutorial Mode in enabled, the devices launch into their tutorial app on boot. Set the tutorial app in Configuration > Device Settings.

Available options:

ENABLE_TUTORIAL_MODE,

DISABLE_TUTORIAL_MODE

Example:

"ENABLE_TUTORIAL_MODE"

Response

200

Success

API Reference

Devices

Configurations

Organizations

Authorizations

Path Parameters

Body

Response