# Remotely lock the managed device

sends device lock command to device

## Endpoints

**POST** `/api/v1/mdm/devices/{device_id}/actions/lock`

## Request URL

`https://[{serverurl}](https://www.manageengine.com/mobile-device-management/help/api/cloud/oauth-authentication-endpoint-domain.html)/api/v1/mdm/devices/{device_id}/actions/lock`

## Scope

`MDMOnDemand.MDMInventory.CREATE`

## Header

`Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52`

## Request Parameters

### Request Headers

- **Content-Type** `string` **Mandatory**: `application/json`
- **Accept** `string` **Mandatory**: `application/json`

### Path Parameters

- **device_id** `string` **Mandatory**

  Unique identifier of the device. Obtain from the [Get Device List](https://www.manageengine.com/mobile-device-management/help/api/cloud/devices-get-device-list.html) response

### Request Body

`application/json`

- `JSON object`
  - **lock_message** `string` Optional

    Message displayed on the device lock screen

  - **phone_number** `string` Optional

    Phone number to display on the device during lock

  - **unlock_pin** `string` Optional

    Unlock PIN for the device

  - **email_sent_to_user** `boolean` Optional

    Whether email is sent to the user

## Sample Request

```curl
curl --request POST \
  --url https://appdomain/api/v1/mdm/devices/{device_id}/actions/lock \
  --header 'Accept: application/json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '{}'
```

## Sample Request Body

Lock device with a lock screen message

```json
{
  "unlock_pin": "1234.",
  "lock_message": "This device has been locked by the administrator.",
  "email_sent_to_user": "true.",
  "phone_number": "000000000000."
}
```

## Possible Response Codes

- **202** `HTTP code`

## Sample Response: HTTP 202

```text
202 Accepted
```

**Duration:** 1 minute | **Threshold:** 30 | **Lock period:** 5 minutes

Duration - Time window for the threshold.
Threshold - Number of API calls allowed within the specified duration.
Lock Period - Wait time before consecutive API requests.