# Add a new Kiosk Homescreen payload configuration to an existing profile

Create Android Kiosk payload with Home screen layout

## Endpoint

**POST** `/api/v1/mdm/profiles/{profile_id}/payloads/androidkioskhomescreenpolicy`

## Request URL

```
https://{serverurl}/api/v1/mdm/profiles/{profile_id}/payloads/androidkioskhomescreenpolicy
```

> `{serverurl}` – See the OAuth authentication endpoint domain: https://www.manageengine.com/mobile-device-management/help/api/cloud/oauth-authentication-endpoint-domain.html

## Scope

```
MDMOnDemand.MDMDeviceMgmt.CREATE
```

## Header

```
Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
```

## Request Parameters

### Path Parameters

- **profile_id** (string, Mandatory)  
  Unique identifier of the profile. Obtain from the [Create Profile](https://www.manageengine.com/mobile-device-management/help/api/cloud/profiles-create-profile.html) or [Get Profiles](https://www.manageengine.com/mobile-device-management/help/api/cloud/profiles-get-profile.html) response.

### Query Parameters

- **t** (long, Optional)
- **ignoreHeader** (boolean, Optional)
- **qlt** (long, Optional)
- **previousTab** (string, Optional)
- **service** (string, Optional)
- **search** (string, Optional)  
  Free-text search string applied to the default searchable fields of the resource
- **all** (boolean, Optional)
- **dc_customerid** (long, Optional)
- **mdm_instance** (string, Optional)
- **signupsrc** (string, Optional)
- **zaaid** (string, Optional)
- **command** (string, Optional)
- **orderby** (string, Optional)
- **sortorder** (string, Optional)
- **select_all** (boolean, Optional)  
  When true, applies the operation to every record matching the current filter rather than to specific IDs. Default: false
- **zoho-internal** (boolean, Optional)
- **dc_instance** (string, Optional)
- **SUBREQUEST** (string, Optional)
- **source** (string, Optional)
- **nocache** (long, Optional)  
  param to avoid being served from cache
- **wms_csrparam** (string, Optional)  
  CSRF Token

## Request Body

**Content-Type:** `application/json`  
**Type:** JSON object

### Attributes

- **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** (array, Optional)  
  List of apps allowed in kiosk mode  
  - **group_display_name** (string) – Display name of the app or app group  
  - **app_id** (long) – Unique identifier of the app group

- **background_apps** (array, Optional)  
  List of apps that run in the background during kiosk mode  
  - **group_display_name** (string)  
  - **app_id** (long)

- **enable_default_app** (boolean, Optional)  
  Whether a default app is launched automatically in kiosk mode. Default: false

- **default_kiosk_app** (array, Optional)  
  The default app launched automatically when kiosk mode starts (single app)  
  - **group_display_name** (string)  
  - **app_id** (long)

- **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** (object, Optional)  
  Advanced kiosk device feature controls configuration  
  - **allow_wifi** (boolean) – Whether the user can access Wi-Fi settings. Default: true  
  - **screen_orientation** (string) – Values: PORTRAIT, LANDSCAPE, AUTO  
  - **allow_brightness** (boolean) – Default: true  
  - **screen_timeout** (string) – 0 = User controlled, 15000 = 15 sec, 30000 = 30 sec, 60000 = 1 min, 300000 = 5 min, 1800000 = 30 min, 2147483647 = Always on  
  - **allow_flash_light** (boolean) – Default: true  
  - **allow_mobile_network** (boolean) – Default: true  
  - **allow_mobile_hotspot_settings** (boolean) – Default: true  
  - **hotspot_settings_timeout** (integer) – Default: 30  
  - **allow_bluetooth_settings** (boolean) – Default: true  
  - **bluetooth_settings_timeout** (integer) – Default: 30  
  - **allow_apn_settings** (boolean) – Default: true  
  - **apn_settings_timeout** (integer) – Default: 30  
  - **settings_timeout** (integer) – Default: 30  
  - **allow_wifi_network_configuration** (boolean) – Default: true  
  - **allow_battery_optimization** (boolean) – Default: true  
  - **allow_locale_settings** (boolean) – Default: true  
  - **allow_device_passcode_change_settings** (boolean) – Default: true  
  - **allow_display_settings** (boolean) – Default: true  
  - **battery_optimized_apps** (array)  
    - **group_display_name** (string)  
    - **app_id** (long)  
  - **mobile_data_usage** (boolean) – Default: true  
  - **default_keyboard** (boolean) – Default: true  
  - **allow_location_settings** (boolean) – Default: true  
  - **allow_airplane_mode** (boolean) – Default: true  
  - **allow_location** (boolean) – Default: true  
  - **allow_nfc_settings** (boolean) – Default: true  
  - **allow_datetime_settings** (boolean) – Default: true  
  - **allow_accessibility_settings** (boolean) – Default: true  

- **auto_distribute_apps** (boolean, Optional)  
  Whether kiosk apps are automatically distributed to the device. Default: true

- **webclippolicies** (array, Optional)  
  List of web shortcuts displayed on the kiosk home screen  
  - **webclip_policy_id** (long)  
  - **webclip_name** (string)

- **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** (object, Optional)  
  Home screen layout appearance settings  
  - **orientation_type** (integer) – 0 = User Controlled, 1 = Portrait, 2 = Landscape  
  - **allow_change_app_position** (boolean)  
  - **text_colour** (string) – Hex color code (e.g., #FFFFFF)  
  - **text_size** (integer) – Font size in sp  
  - **icon_size** (integer) – Icon size in dp  
  - **model_type** (integer)

- **screenlayout** (object, Optional)  
  Kiosk home screen layout structure  
  - **pages** (array)  
    - **page_no** (integer)  
    - **page_type** (integer) – 1 = Home screen page, 2 = Dock page  
    - **screenpagelayout** (array)  
      - **page_layout_row** (integer)  
      - **page_layout_column** (integer)  
      - **page_layout_type** (integer) – 1 = App, 2 = Web shortcut, 3 = Folder  
      - **app_id** (long)  
      - **app_name** (string)  
      - **icon_file_name** (string)  
      - **display_image_loc** (string)  
      - **webclip_name** (string)  
      - **webclip_policy_id** (long)  
      - **folder_name** (string)  
      - **folderpages** (array)  
        - **page_no** (integer)  
        - **page_type** (integer)  
        - **folderpagelayout** (array)  
          - **page_layout_row** (integer)  
          - **page_layout_column** (integer)  
          - **page_layout_type** (integer) – 1 = App, 2 = Web shortcut  
          - **app_id** (long)  
          - **app_name** (string)  
          - **webclip_name** (string)  
          - **display_image_loc** (string)  
          - **icon_file_name** (string)  
          - **webclip_policy_id** (long)

## Sample Request

### Curl

```bash
curl --request POST \
  --url https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/androidkioskhomescreenpolicy \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52' \
  --header 'content-type: application/json' \
  --data '{}'
```

### Java

```java
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Main {
  public static void main(String[] args) throws Exception {

    HttpRequest request = HttpRequest.newBuilder()
        .uri(URI.create("https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/androidkioskhomescreenpolicy"))
        .header("content-type", "application/json")
        .header("Authorization", "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52")
        .method("POST", HttpRequest.BodyPublishers.ofString("{}"))
        .build();

    HttpResponse<String> response = HttpClient.newHttpClient()
        .send(request, HttpResponse.BodyHandlers.ofString());

    System.out.println(response.body());
  }
}
```

### Python

```python
import http.client

conn = http.client.HTTPSConnection("appdomain")

payload = "{}"

headers = {
    'content-type': "application/json",
    'Authorization': "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52"
}

conn.request("POST", "/api/v1/mdm/profiles/{profile_id}/payloads/androidkioskhomescreenpolicy", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))
```

### Deluge

```javascript
headersMap = Map();
headersMap.put("Content-Type", "application/json");
headersMap.put("Accept", "application/json");

data = Map();

response = invokeUrl
[
    url: "https://appDomain/api/v1/mdm/profiles/{profile_id}/payloads/androidkioskhomescreenpolicy"
    type: POST
    headers: headersMap
    body: data
    connection: connection_name
]

info response;
```

### PowerShell

```powershell
$headers=@{}
$headers.Add("content-type", "application/json")
$headers.Add("Authorization", "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52")
$response = Invoke-WebRequest -Uri 'https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/androidkioskhomescreenpolicy' -Method POST -Headers $headers -ContentType 'application/json' -Body '{}'
```

## Sample Request Body

```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 200

**Response Body:** `application/json`

- **payload_id** (long) – Unique identifier for the created payload item  
- **sub_config** (string)  
- **kiosk_mode** (integer)  
- **launcher_type** (integer)  
- **allowed_apps** (array)  
- **background_apps** (array)  
- **enable_default_app** (boolean)  
- **default_kiosk_app** (array)  
- **default_app_launch_mode** (integer)  
- **default_app_launch_timeout** (integer)  
- **wallpaper** (long)  
- **is_wallpaper_removed** (boolean)  
- **show_me_mdm_app** (boolean)  
- **allow_notification_badge** (boolean)  
- **allow_task_manager** (boolean)  
- **allow_system_bar** (boolean)  
- **allow_navigation_bar** (boolean)  
- **allow_status_bar** (boolean)  
- **allow_status_bar_expansion** (boolean)  
- **allow_home_button** (boolean)  
- **allow_power_button** (boolean)  
- **allow_back_button** (boolean)  
- **allow_shutdown** (boolean)  
- **allow_key_guard** (boolean)  
- **allow_notification** (boolean)  
- **allow_system_error_dialog** (boolean)  
- **allow_recent_apps** (boolean)  
- **allow_custom_settings** (boolean)  
- **is_stay_awake_on_charging** (boolean)  
- **allow_simunlock** (boolean)  
- **allow_multiwindow** (boolean)  
- **kiosk_custom_settings** (object)  
- **auto_distribute_apps** (boolean)  
- **webclippolicies** (array)  
- **auto_distribute_webapp** (boolean)  
- **exit_kiosk_password** (string)  
- **idle_refresh_timeout** (integer)  
- **clear_cookies_on_idle_timeout** (boolean)  
- **clear_cache_on_idle_timeout** (boolean)  
- **screenlayoutsettings** (object)  
- **screenlayout** (object)

## Sample Response: HTTP 200

```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": []
}
```

## Possible Response Codes

- **200** – HTTP code

## API Rate Limit

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