POST /v1/organizations/:organizationId/mdm/android/enterprise/devices/commands

Create emmCommand Bulk

Request

Add parameter in header authorization

Example: Authorization: Bearer <token>

organizationId string

required

Entity Id or Slug

Match pattern: ^(([a-fA-F0-9]{24})|([a-zA-Z0-9\\-]{3,}))$

Body Params application/json

deviceIds array [string] optional

command object optional

type string required

LOCK RESET_PASSWORD REBOOT START_LOST_MODE STOP_LOST_MODE RELINQUISH_OWNERSHIP ADD_ESIM REMOVE_ESIM CLEAR_APP_DATA

duration string optional

≤ 256 characters

newPassword string optional

≤ 256 characters

resetPasswordFlags array [string] optional

startLostModeParams object optional

clearAppsDataParams object optional

stopLostModeParams object optional

addEsimParams object optional

removeEsimParams object optional

{
    "deviceIds": [
        "string"
    ],
    "command": {
        "type": "LOCK",
        "duration": "string",
        "newPassword": "string",
        "resetPasswordFlags": [
            "REQUIRE_ENTRY"
        ],
        "startLostModeParams": {},
        "clearAppsDataParams": {},
        "stopLostModeParams": {},
        "addEsimParams": {},
        "removeEsimParams": {}
    }
}

Responses

200 Response application/json

status boolean optional

data array [object] optional

id string optional

Entity Id

Match pattern: ^[a-fA-F0-9]{24}$

organization string optional

Entity Id

Match pattern: ^[a-fA-F0-9]{24}$

emmEnterprise string optional

Entity Id

Match pattern: ^[a-fA-F0-9]{24}$

mdmUser string optional

Entity Id

Match pattern: ^[a-fA-F0-9]{24}$

status string optional

DONE PENDING CANCEL

config object optional

metadata object optional

@type string optional

≤ 256 characters

type string optional

LOCK RESET_PASSWORD REBOOT START_LOST_MODE STOP_LOST_MODE RELINQUISH_OWNERSHIP ADD_ESIM REMOVE_ESIM CLEAR_APP_DATA

createTime string optional

Format: date-time

duration string optional

≤ 128 characters

userName string optional

≤ 256 characters

done boolean optional

_config object optional

Only available for platform admin users

updatedAt string optional

Format: date-time

createdAt string optional

Format: date-time

{
    "status": true,
    "data": [
        {
            "id": "string",
            "organization": "string",
            "emmEnterprise": "string",
            "mdmUser": "string",
            "status": "DONE",
            "config": {
                "metadata": {
                    "@type": "string",
                    "type": "LOCK",
                    "createTime": "2024-01-01T00: 00:00Z",
                    "duration": "string",
                    "userName": "string"
                },
                "done": true
            },
            "_config": {},
            "updatedAt": "2024-01-01T00: 00:00Z",
            "createdAt": "2024-01-01T00: 00:00Z"
        }
    ]
}

400 Response application/json

status boolean optional

false

error object optional

code number optional

5095

message string optional

Error From Emm Android Library

{
    "status": false,
    "error": {
        "code": 5050,
        "message": "Feature not allowed for you billing plan"
    }
}

401 Response application/json

status boolean optional

false

error object optional

code number optional

4004

message string optional

Invalid Token

{
    "status": false,
    "error": {
        "code": 4002,
        "message": "No auth token"
    }
}

404 Response application/json

status boolean optional

false

error object optional

code number optional

3001

message string optional

Entity not found

{
    "status": false,
    "error": {
        "code": 3001,
        "message": "Entity not found"
    }
}