# Modify the configuration of a Kiosk Homescreen payload item within a profile

Modify Android Kiosk Homescreen policy payload

## Endpoint

`PUT /api/v1/mdm/profiles/{profile_id}/payloads/androidkioskhomescreenpolicy/payloaditems/{payload_id}`

## Request URL

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

## Scope

`MDMDeviceMgmt.UPDATE`

## 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.
- **payload_id** (`string`, Mandatory): Unique identifier of the payload item. Obtain from the [Get Payload Item IDs](https://www.manageengine.com/products/desktop-central/help/api/onpremise/android-get-kiosk-homescreen-payload.html) response.

### Request Body

`application/json`

- **sub_config** (`string`, Optional): Sub-configuration type identifier.
- **kiosk_mode** (`integer`, Optional): Kiosk mode. `0` = Single App, `1` = Multi App, `3` = Single Web App (COSU). Default: `0`.
- **launcher_type** (`integer`, Optional): Launcher type. `1` = Default device launcher, `2` = ME MDM custom launcher. Default: `2`.
- **allowed_apps** (`JSON Array`, Optional): List of apps allowed in kiosk mode.
- **background_apps** (`JSON Array`, Optional): List of apps that run in the background during kiosk mode.
- **enable_default_app** (`boolean`, Optional): Whether a default app is launched automatically in kiosk mode. Default: `false`.
- **default_kiosk_app** (`JSON Array`, Optional): The default app launched automatically when kiosk mode starts (single app).
- **default_app_launch_mode** (`integer`, Optional): Default app launch behavior. Default: `0`.
- **default_app_launch_timeout** (`integer`, Optional): Seconds of idle time before the default app is relaunched. Default: `20`.
- **wallpaper** (`long`, Optional): Wallpaper image file ID.
- **is_wallpaper_removed** (`boolean`, Optional): Whether the kiosk wallpaper image has been removed. Default: `false`.
- **show_me_mdm_app** (`boolean`, Optional): Whether the ME MDM app is visible on the kiosk launcher. Default: `true`.
- **allow_notification_badge** (`boolean`, Optional): Whether notification badges are shown on app icons in kiosk mode. Default: `false`.
- **allow_task_manager** (`boolean`, Optional): Whether the task manager is accessible in kiosk mode. Default: `true`.
- **allow_system_bar** (`boolean`, Optional): Whether the system bar is visible in kiosk mode. Default: `true`.
- **allow_navigation_bar** (`boolean`, Optional): Whether the navigation bar is visible in kiosk mode. Default: `true`.
- **allow_status_bar** (`boolean`, Optional): Whether the status bar is visible in kiosk mode. Default: `true`.
- **allow_status_bar_expansion** (`boolean`, Optional): Whether the status bar can be expanded in kiosk mode. Default: `true`.
- **allow_home_button** (`boolean`, Optional): Whether the home button is functional in kiosk mode. Default: `true`.
- **allow_power_button** (`boolean`, Optional): Whether the power button is functional in kiosk mode. Default: `true`.
- **allow_back_button** (`boolean`, Optional): Whether the back button is functional in kiosk mode. Default: `true`.
- **allow_shutdown** (`boolean`, Optional): Whether the device can be shut down in kiosk mode. Default: `true`.
- **allow_key_guard** (`boolean`, Optional): Whether the key guard (lock screen) is enabled in kiosk mode. Default: `true`.
- **allow_notification** (`boolean`, Optional): Whether notifications are shown in kiosk mode. Default: `true`.
- **allow_system_error_dialog** (`boolean`, Optional): Whether app crash dialogs are displayed in kiosk mode. Default: `false`.
- **allow_recent_apps** (`boolean`, Optional): Whether the recent apps view is accessible in kiosk mode. Default: `true`.
- **allow_custom_settings** (`boolean`, Optional): Whether the custom settings app is enabled in kiosk mode. Default: `true`.
- **is_stay_awake_on_charging** (`boolean`, Optional): Whether the device stays awake while charging in kiosk mode. Default: `true`.
- **allow_simunlock** (`boolean`, Optional): Whether SIM unlock is allowed in kiosk mode. Default: `true`.
- **allow_multiwindow** (`boolean`, Optional): Whether multi-window (split screen) mode is allowed in kiosk mode. Default: `true`.
- **kiosk_custom_settings** (`JSON Object`, Optional): Advanced kiosk device feature controls configuration.
- **auto_distribute_apps** (`boolean`, Optional): Whether kiosk apps are automatically distributed to the device. Default: `true`.
- **webclippolicies** (`JSON Array`, Optional): List of web shortcuts displayed on the kiosk home screen.
- **auto_distribute_webapp** (`boolean`, Optional): Whether kiosk web shortcuts are automatically distributed. Default: `true`.
- **exit_kiosk_password** (`string`, Optional): Password required to exit kiosk mode (write-only).
- **idle_refresh_timeout** (`integer`, Optional): Seconds of idle time before web shortcuts are refreshed. `-1` = Disabled. Default: `-1`.
- **clear_cookies_on_idle_timeout** (`boolean`, Optional): Whether cookies are cleared when the idle refresh timeout triggers. Default: `true`.
- **clear_cache_on_idle_timeout** (`boolean`, Optional): Whether cache is cleared when the idle refresh timeout triggers. Default: `false`.
- **screenlayoutsettings** (`JSON Object`, Optional): Home screen layout appearance settings (orientation, icon size, text color).
- **screenlayout** (`JSON Object`, Optional): Kiosk home screen page layout structure containing pages, apps, web shortcuts, and folders.

## Sample Request

```curl
curl --request PUT \
  --url https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/androidkioskhomescreenpolicy/payloaditems/{payload_id} \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '{"enable_default_app":false,"launcher_type":2,"default_kiosk_app":[],"wallpaper":"value","sub_config":"KIOSK_CUSTOM_SETTINGS","default_app_launch_timeout":20,"allowed_apps":[],"default_app_launch_mode":0,"kiosk_mode":0,"background_apps":[]}'
```

## Sample Request Body

Modify Kiosk Homescreen payload item

```json
{
  "enable_default_app": false,
  "launcher_type": 2,
  "default_kiosk_app": [],
  "wallpaper": "value",
  "sub_config": "KIOSK_CUSTOM_SETTINGS",
  "default_app_launch_timeout": 20,
  "allowed_apps": [],
  "default_app_launch_mode": 0,
  "kiosk_mode": 0,
  "background_apps": []
}
```

## Response Parameters

### HTTP Code 200

Response Body — `application/json`

- **payload_id** (`long`): Unique identifier of the payload item.
- **sub_config** (`string`): Sub-configuration type identifier.
- **kiosk_mode** (`integer`): Kiosk mode. `0` = Single App, `1` = Multi App, `3` = Single Web App (COSU). Default: `0`.
- **launcher_type** (`integer`): Launcher type. `1` = Default device launcher, `2` = ME MDM custom launcher. Default: `2`.
- **allowed_apps** (`JSON Array`): List of apps allowed in kiosk mode.
- **background_apps** (`JSON Array`): List of apps that run in the background during kiosk mode.
- **enable_default_app** (`boolean`): Whether a default app is launched automatically in kiosk mode. Default: `false`.
- **default_kiosk_app** (`JSON Array`): The default app launched automatically when kiosk mode starts (single app).
- **default_app_launch_mode** (`integer`): Default app launch behavior. Default: `0`.
- **default_app_launch_timeout** (`integer`): Seconds of idle time before the default app is relaunched. Default: `20`.
- **wallpaper** (`long`): Wallpaper image file ID.
- **is_wallpaper_removed** (`boolean`): Whether the kiosk wallpaper image has been removed. Default: `false`.
- **show_me_mdm_app** (`boolean`): Whether the ME MDM app is visible on the kiosk launcher. Default: `true`.
- **allow_notification_badge** (`boolean`): Whether notification badges are shown on app icons in kiosk mode. Default: `false`.
- **allow_task_manager** (`boolean`): Whether the task manager is accessible in kiosk mode. Default: `true`.
- **allow_system_bar** (`boolean`): Whether the system bar is visible in kiosk mode. Default: `true`.
- **allow_navigation_bar** (`boolean`): Whether the navigation bar is visible in kiosk mode. Default: `true`.
- **allow_status_bar** (`boolean`): Whether the status bar is visible in kiosk mode. Default: `true`.
- **allow_status_bar_expansion** (`boolean`): Whether the status bar can be expanded in kiosk mode. Default: `true`.
- **allow_home_button** (`boolean`): Whether the home button is functional in kiosk mode. Default: `true`.
- **allow_power_button** (`boolean`): Whether the power button is functional in kiosk mode. Default: `true`.
- **allow_back_button** (`boolean`): Whether the back button is functional in kiosk mode. Default: `true`.
- **allow_shutdown** (`boolean`): Whether the device can be shut down in kiosk mode. Default: `true`.
- **allow_key_guard** (`boolean`): Whether the key guard (lock screen) is enabled in kiosk mode. Default: `true`.
- **allow_notification** (`boolean`): Whether notifications are shown in kiosk mode. Default: `true`.
- **allow_system_error_dialog** (`boolean`): Whether app crash dialogs are displayed in kiosk mode. Default: `false`.
- **allow_recent_apps** (`boolean`): Whether the recent apps view is accessible in kiosk mode. Default: `true`.
- **allow_custom_settings** (`boolean`): Whether the custom settings app is enabled in kiosk mode. Default: `true`.
- **is_stay_awake_on_charging** (`boolean`): Whether the device stays awake while charging in kiosk mode. Default: `true`.
- **allow_simunlock** (`boolean`): Whether SIM unlock is allowed in kiosk mode. Default: `true`.
- **allow_multiwindow** (`boolean`): Whether multi-window (split screen) mode is allowed in kiosk mode. Default: `true`.
- **kiosk_custom_settings** (`JSON Object`): Advanced kiosk device feature controls configuration.
- **auto_distribute_apps** (`boolean`): Whether kiosk apps are automatically distributed to the device. Default: `true`.
- **webclippolicies** (`JSON Array`): List of web shortcuts displayed on the kiosk home screen.
- **auto_distribute_webapp** (`boolean`): Whether kiosk web shortcuts are automatically distributed. Default: `true`.
- **exit_kiosk_password** (`string`): Password required to exit kiosk mode (write-only).
- **idle_refresh_timeout** (`integer`): Seconds of idle time before web shortcuts are refreshed. `-1` = Disabled. Default: `-1`.
- **clear_cookies_on_idle_timeout** (`boolean`): Whether cookies are cleared when the idle refresh timeout triggers. Default: `true`.
- **clear_cache_on_idle_timeout** (`boolean`): Whether cache is cleared when the idle refresh timeout triggers. Default: `false`.
- **screenlayoutsettings** (`JSON Object`): Home screen layout appearance settings (orientation, icon size, text color).
- **screenlayout** (`JSON Object`): Kiosk home screen page layout structure containing pages, apps, web shortcuts, and folders.

## Possible Response Codes

- **200**: HTTP code

## Sample Response: HTTP 200

Kiosk Homescreen payload item successfully modified

```json
{
  "enable_default_app": false,
  "payload_id": 9007199254741000,
  "launcher_type": 2,
  "default_kiosk_app": [],
  "wallpaper": "value",
  "sub_config": "KIOSK_CUSTOM_SETTINGS",
  "default_app_launch_timeout": 20,
  "allowed_apps": [],
  "default_app_launch_mode": 0,
  "kiosk_mode": 0,
  "background_apps": []
}
```

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

**Duration:** 1 minute | **Threshold:** 60 | **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.