# Add a new App Lock Homescreen payload configuration to an existing profile

To create App Lock Home Screen policy

## Endpoint

`POST /api/v1/mdm/profiles/{profile_id}/payloads/applockhomescreenpolicy`

## Request

### Request URL

`https://{server-hostname}:8383/api/v1/mdm/profiles/{profile_id}/payloads/applockhomescreenpolicy`

### Scope

`MDMDeviceMgmt.CREATE`

### Header

`Authorization: d92d4xxxxxxxxxxxxx15f52`

### Request Parameters

#### Request Headers

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

#### Path Parameters

- **profile_id** `string` — **Mandatory**
  - Unique identifier of the profile. Obtain from the [Create Profile](https://www.manageengine.com/products/desktop-central/help/api/onpremise/mdm-profiles-create-profile.html) or [Get Profiles](https://www.manageengine.com/products/desktop-central/help/api/onpremise/mdm-profiles-get-profile.html) response.

#### Request Body

`application/json`

- `JSON Object`
  - **idle_refresh_timeout** `integer` — Optional
    - Idle refresh timeout for web app kiosk in seconds. -1 means disabled. Default: -1
  - **clear_session_and_cookies** `boolean` — Optional
    - Clear Session And Cookies. Default: true
  - **webclippolicies** `JSON Array` — Optional
    - List of web clips configured for kiosk mode
  - **auto_distribute_webapp** `boolean` — Optional
    - Auto Distribute Webapp. Default: true
  - **app_name** `string` — Optional
    - App Name
  - **identifier** `string` — Optional
    - Identifier
  - **disable_touch** `boolean` — Optional
    - Disable Touch. Default: false
  - **disable_device_rotation** `boolean` — Optional
    - Disable Device Rotation. Default: false
  - **disable_volume_buttons** `boolean` — Optional
    - Disable Volume Buttons. Default: false
  - **disable_ringer_switch** `boolean` — Optional
    - Disable Ringer Switch. Default: false
  - **disable_sleep_button** `boolean` — Optional
    - Disable Sleep Button. Default: false
  - **disable_auto_lock** `boolean` — Optional
    - Disable Auto Lock. Default: true
  - **voice_over** `boolean` — Optional
    - Voice Over. Default: false
  - **zoom** `boolean` — Optional
    - Zoom. Default: false
  - **invert_colors** `boolean` — Optional
    - Invert Colors. Default: false
  - **asst_touch** `boolean` — Optional
    - Asst Touch. Default: false
  - **enable_speak_selection** `boolean` — Optional
    - Enable Speak Selection. Default: false
  - **enable_mono_audio** `boolean` — Optional
    - Enable Mono Audio. Default: false
  - **enable_voice_control** `boolean` — Optional
    - Enable Voice Control. Default: false
  - **show_me_mdm_app** `boolean` — Optional
    - Show Me Mdm App. Default: true
  - **kiosk_mode** `integer` — **Mandatory**
    - Kiosk mode type. Allowed values: 1=Single App Kiosk, 2=Multi App Kiosk, 3=Single Web App Kiosk
  - **allowed_apps** `JSON Array` — Optional
    - List of allowed kiosk apps
  - **autonomous_kiosk_apps** `JSON Array` — Optional
    - List of autonomous single app mode apps
  - **auto_distribute_apps** `boolean` — Optional
    - Auto Distribute Apps. Default: false
  - **screenlayoutsettings** `JSON Object` — Optional
    - Screenlayoutsettings
  - **screenlayout** `JSON Object` — Optional
    - Screenlayout

### Sample Request

```curl
curl --request POST \
  --url https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/applockhomescreenpolicy \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '{"app_name":"Zylker User","identifier":"value","disable_volume_buttons":false,"disable_ringer_switch":false,"idle_refresh_timeout":-1,"webclippolicies":[{"webclip_policy_id":9007199254741076,"webclip_name":"Zylker Web Clip"}],"clear_session_and_cookies":true,"disable_touch":false,"disable_device_rotation":false,"kiosk_mode":1,"auto_distribute_webapp":true}'
```

### Sample Request Body

Add App Lock Homescreen payload to the profile

```json
{
  "app_name": "Zylker User",
  "identifier": "value",
  "disable_volume_buttons": false,
  "disable_ringer_switch": false,
  "idle_refresh_timeout": -1,
  "webclippolicies": [
    {
      "webclip_policy_id": 9007199254741076,
      "webclip_name": "Zylker Web Clip"
    }
  ],
  "clear_session_and_cookies": true,
  "disable_touch": false,
  "disable_device_rotation": false,
  "kiosk_mode": 1,
  "auto_distribute_webapp": true
}
```

## Response

### HTTP Code 200

#### Response Body

`application/json`

- `JSON Object`
  - **payload_id** `long`
    - Unique identifier for the created payload item
  - **idle_refresh_timeout** `integer`
    - Idle refresh timeout for web app kiosk in seconds. -1 means disabled. Default: -1
  - **clear_session_and_cookies** `boolean`
    - Clear Session And Cookies. Default: true
  - **webclippolicies** `JSON Array`
    - List of web clips configured for kiosk mode
  - **auto_distribute_webapp** `boolean`
    - Auto Distribute Webapp. Default: true
  - **app_name** `string`
    - App Name
  - **identifier** `string`
    - Identifier
  - **disable_touch** `boolean`
    - Disable Touch. Default: false
  - **disable_device_rotation** `boolean`
    - Disable Device Rotation. Default: false
  - **disable_volume_buttons** `boolean`
    - Disable Volume Buttons. Default: false
  - **disable_ringer_switch** `boolean`
    - Disable Ringer Switch. Default: false
  - **disable_sleep_button** `boolean`
    - Disable Sleep Button. Default: false
  - **disable_auto_lock** `boolean`
    - Disable Auto Lock. Default: true
  - **voice_over** `boolean`
    - Voice Over. Default: false
  - **zoom** `boolean`
    - Zoom. Default: false
  - **invert_colors** `boolean`
    - Invert Colors. Default: false
  - **asst_touch** `boolean`
    - Asst Touch. Default: false
  - **enable_speak_selection** `boolean`
    - Enable Speak Selection. Default: false
  - **enable_mono_audio** `boolean`
    - Enable Mono Audio. Default: false
  - **enable_voice_control** `boolean`
    - Enable Voice Control. Default: false
  - **show_me_mdm_app** `boolean`
    - Show Me Mdm App. Default: true
  - **kiosk_mode** `integer`
    - Kiosk mode type. Allowed values: 1=Single App Kiosk, 2=Multi App Kiosk, 3=Single Web App Kiosk
  - **allowed_apps** `JSON Array`
    - List of allowed kiosk apps
  - **autonomous_kiosk_apps** `JSON Array`
    - List of autonomous single app mode apps
  - **auto_distribute_apps** `boolean`
    - Auto Distribute Apps. Default: false
  - **screenlayoutsettings** `JSON Object`
    - Screenlayoutsettings
  - **screenlayout** `JSON Object`
    - Screenlayout

### Possible Response Codes

- **200** `HTTP code`

### Sample Response: HTTP 200

App Lock Homescreen payload successfully added

```json
{
  "app_name": "Zylker User",
  "identifier": "value",
  "payload_id": 9007199254741000,
  "disable_volume_buttons": false,
  "disable_ringer_switch": false,
  "idle_refresh_timeout": -1,
  "webclippolicies": [
    {
      "webclip_policy_id": 9007199254741076,
      "webclip_name": "Zylker Web Clip"
    }
  ],
  "clear_session_and_cookies": true,
  "disable_touch": false,
  "disable_device_rotation": false,
  "kiosk_mode": 1,
  "auto_distribute_webapp": true
}
```

## Rate Limit

![Help icon](https://www.zohowebstatic.com/sites/zweb/images/people/ico-help.png)

**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.