Send Command

curl --request POST \
  --url https://managexrapi.com/organizations/{orgId}/devices/{deviceId}/command \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "action": "SYNC"
}
'

POST

organizations

{orgId}

devices

{deviceId}

command

curl --request POST \
  --url https://managexrapi.com/organizations/{orgId}/devices/{deviceId}/command \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "action": "SYNC"
}
'

Authorizations

Authorization

string

header

required

API key based authentication where 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.

deviceId

string

required

The ID (serial number) of the device.

Body

application/json

Launch App
Play / Pause Video
Launch Web Url
Disable / Enable Kiosk Mode
Restart
Power OFF
Set Volume
Set Brightness
Uninstall App
Restart App
Sync
Enable / Disable Tutorial Mode

action

enum<string>

Launch an application on the device.

Available options:

LAUNCH_APP

Example:

"LAUNCH_APP"

data

object

Show child attributes

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" }
}

Response

200

Success

Edit Device Send Batch Command

⌘I

Getting Started

Devices

Configurations

Organizations

Authorizations

Path Parameters

Body

Response