Enable lost mode

Tool Name: airdroid_business_enable_lost_mode

Risk Level: 🟠 Medium Risk

Execution Mode: ⏳ Asynchronous

Category: Remote Commands

Quick Start (Copy & Use)

One-liner: Enable lost mode on a device — locks the screen and displays a custom message

What you need: DeviceId (device ID), Pwd (4-digit unlock PIN), CustomMessage (optional, lock screen message)

Success criteria: StatusCode = 200 and ErrorMessage is an empty string; returns Pid for tracking

What to do next: Use Get an Activity Log with the Pid to poll execution status

Minimal request example:

{
  "DeviceId": "fa6edcff65ab444e8b5e0eb08df4175d",
  "Pwd": "1234"
}

Full request example:

{
  "DeviceId": "fa6edcff65ab444e8b5e0eb08df4175d",
  "CustomMessage": "This device is lost. Please contact admin.",
  "Pwd": "1234"
}

Minimal response example:

{
  "Pid": "1770854462319857000",
  "StatusCode": 200,
  "ErrorMessage": ""
}

Recipes (Common Recipes)

Recipe 1: Emergency lock for a lost device

Scenario: Device is lost; immediately lock and display contact information

{
  "DeviceId": "fa6edcff65ab444e8b5e0eb08df4175d",
  "CustomMessage": "This device is lost. Please contact admin@company.com or call +1-xxx-xxxx",
  "Pwd": "1234"
}

Recipe 2: Use default message

Scenario: Quick lock using the default lost mode message

{
  "DeviceId": "fa6edcff65ab444e8b5e0eb08df4175d",
  "Pwd": "5678"
}

Default message: "The device is in lost mode"

Recipe 3: Track lost mode status with Pid

Scenario: After enabling lost mode, confirm whether it was successful

1. Call Enable Lost Mode to get the Pid
2. Use the Get an Activity Log tool to query status:

{
  "Pid": "1770854462319857000"
}

Polling logic:

• Progress = "Executing" → continue polling (interval 5-10 seconds)
• Progress = "Success" → lost mode enabled successfully
• Progress = "Failure" → check the FailReason field

1. Overview

1.1 Description

Enable lost mode on a device managed by AirDroid Business. The device will be immediately locked, the screen will display a custom message (e.g. contact information), and a 4-digit PIN is required to unlock.

1.2 When to Use

• Device lost: Device is lost or stolen; immediate protection required
• Asset recovery: Display contact information to help recover the device
• Security protection: Prevent unauthorized access to device data
• Temporary lockdown: Temporarily disable the device and display a notification message

1.3 Execution Mode & Response

This operation is asynchronous — after the command is sent, the device typically responds within seconds.

• Return value: Pid (activity log ID)
• Tracking method: Use the Get an Activity Log tool with the Pid to query execution status
• Prerequisite: The device must be online to receive the command
• Typical duration: Usually completes within 3-10 seconds

1.4 Prerequisites

1.5 Prerequisite Tools

1.6 Comparison with Similar Tools

2. Inputs

2.1 Parameter List

2.2 Parameter Details

`DeviceId`

Device unique identifier.

• Type: string
• Format: Non-empty string
• Source:
  1. Obtained via the Get All Devices tool; use the device_id field from the response
  2. Obtained via the Get a Device by Name tool for exact name lookup
• How to fill in a GI node:
  • Constant: Enter the device ID string directly, e.g. fa6edcff65ab444e8b5e0eb08df4175d
  • Upstream reference: Map from the Get All Devices node's Devices[0].device_id field
• Example:

  "fa6edcff65ab444e8b5e0eb08df4175d"

`Pwd`

4-digit numeric unlock PIN.

• Type: string
• Format: Must be exactly 4 digits (regex: ^\d{4}$)
• Purpose: Used to unlock lost mode on the device
• How to fill in a GI node:
  • Constant: e.g. "1234"
• Example:

  "1234"

⚠️ Important: Keep this PIN safe — it is required to unlock the device.

`CustomMessage`

Custom message displayed on the lock screen.

• Type: string
• Format: Max 150 characters
• Default: "The device is in lost mode"
• Purpose: Information displayed on the lock screen, typically including contact details
• How to fill in a GI node:
  • Constant: e.g. "This device is lost. Please contact admin@company.com"
  • Upstream reference: Obtain from user input or a configuration system
• Example:

  "This device is lost. Please contact admin@company.com"

Tip: Include valid contact details (phone/email) in the message to facilitate device recovery.

2.3 Parameter Combination Logic

• DeviceId and Pwd are required
• CustomMessage is optional; defaults to the standard message if not provided
• PIN must be exactly 4 digits

3. Outputs

3.1 Response Examples

Success response:

{
  "Pid": "1770854462319857000",
  "StatusCode": 200,
  "ErrorMessage": ""
}

Parameter error response:

{
  "Pid": "",
  "StatusCode": 200,
  "ErrorMessage": "Invalid pwd."
}

Network error response:

{
  "Pid": "",
  "StatusCode": 500,
  "ErrorMessage": "Request timeout after 60 seconds."
}

3.2 Field Descriptions

3.3 Pid Tracking

Use the returned Pid with the Get an Activity Log tool to track execution status:

4. Examples

4.1 Basic Example: Enable lost mode

Request:

{
  "DeviceId": "fa6edcff65ab444e8b5e0eb08df4175d",
  "Pwd": "1234"
}

Response:

{
  "Pid": "789012",
  "StatusCode": 200,
  "ErrorMessage": ""
}

4.2 Advanced Example: With custom message

Request:

{
  "DeviceId": "fa6edcff65ab444e8b5e0eb08df4175d",
  "CustomMessage": "This device belongs to ABC Company. If found, please contact IT at +1-xxx-xxxx or email it@abc.com. Reward offered.",
  "Pwd": "5678"
}

Response:

{
  "Pid": "789013",
  "StatusCode": 200,
  "ErrorMessage": ""
}

4.3 Error Example: Invalid PIN format

Request:

{
  "DeviceId": "fa6edcff65ab444e8b5e0eb08df4175d",
  "Pwd": "123"
}

Response:

{
  "Pid": "",
  "StatusCode": 200,
  "ErrorMessage": "Invalid pwd."
}

Note: The PIN must be exactly 4 digits.

5. Error Handling

5.1 AB Three-Layer Error Codes

Core principle: AB uses a three-layer error code strategy. The agent should decide how to handle based on StatusCode.

5.2 Common Errors

5.3 Agent Self-Healing Decision Table

6. Best Practices

6.1 Performance Tips

• Confirm device is online: Check device status before the operation
• Act quickly: Enable lost mode as soon as possible when a device is lost

6.2 Security Considerations

⚠️ Medium Risk Warning: This operation immediately locks the device screen. The device holder will need to enter the PIN to unlock.

Side effects:

• Device screen is locked immediately
• Custom message is displayed on the lock screen
• A 4-digit PIN is required to unlock

Pre-execution checklist:

1. ☐ Confirm the device is online
2. ☐ Confirm the correct target device
3. ☐ Record the unlock PIN
4. ☐ Prepare valid contact information for the message

6.3 Idempotency

Idempotency: Conditionally idempotent.

• Re-calling on a device already in lost mode will update the message and PIN
• With identical parameters, multiple calls produce the same result

6.4 Async Operation Tracking

Use the returned Pid with Get an Activity Log to track execution status:

Polling recommendations:

• Interval: 5-10 seconds
• Max polling attempts: 6 (approx. 30-60 seconds)
• On timeout: Prompt the user to manually check device status

7. Related Tools

7.1 Prerequisite Tools

7.2 Follow-up Tools

7.3 Similar Tools Comparison

8. Tool Chains

8.1 Lost Device Emergency Response

Scenario: Device is lost; immediate protection and contact info display needed

Tool chain:

Get a Device by Name → Enable Lost Mode → Get an Activity Log

Steps:

1. Call Get a Device by Name to query the lost device's device_id
2. Call Enable Lost Mode to enable lost mode with a PIN and contact information
3. Use Get an Activity Log with the Pid to confirm the operation succeeded

8.2 Device Recovery Flow

Scenario: After recovering the device, disable lost mode

Tool chain:

Enable Lost Mode → (device recovered) → Disable Lost Mode

Steps:

1. Enable lost mode with Enable Lost Mode when the device is lost
2. After recovery, call Disable Lost Mode to exit lost mode
3. Alternatively, enter the 4-digit PIN directly on the device to unlock

8.3 Graduated Protection Pattern

Scenario: Gradually escalate protection measures based on the situation

Tool chain:

Lock a Device → (still not recovered) → Enable Lost Mode → (confirmed lost) → [consider wiping]

Steps:

1. First call Lock a Device for a simple screen lock
2. If the device is still not recovered, escalate to Enable Lost Mode to display contact information
3. If the device is confirmed unrecoverable, consider remote data wipe