Add a new Kiosk Homescreen payload configuration to an existing profile

Create Android Kiosk payload with Home screen layout

Endpoints

post /api/v1/mdm/profiles/{profile_id}/payloads/androidkioskhomescreenpolicy

Copy full URL

Request URL

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

Scope

MDMDeviceMgmt.CREATECopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

Content-TypestringMandatory

application/jsonCopied!

AcceptstringMandatory

application/jsonCopied!

- Path Parameters

profile_idstringMandatory

Unique identifier of the profile. Obtain from the Create Profile or Get Profiles response

- Request Body

application/json

JSON Object

Hide Sub-Attributes

sub_configstringOptional

Sub-configuration type identifier

kiosk_modeintegerOptional

Kiosk mode. 0 = Single App, 1 = Multi App, 3 = Single Web App (COSU). Default: 0

launcher_typeintegerOptional

Launcher type. 1 = Default device launcher, 2 = ME MDM custom launcher. Default: 2

allowed_appsJSON ArrayOptional

List of apps allowed in kiosk mode

Show Sub-Attributes

JSON Object

Show Sub-Attributes

group_display_namestringOptional

Display name of the app or app group

app_idlongOptional

Unique identifier of the app group

background_appsJSON ArrayOptional

List of apps that run in the background during kiosk mode

Show Sub-Attributes

JSON Object

Show Sub-Attributes

group_display_namestringOptional

Display name of the app or app group

app_idlongOptional

Unique identifier of the app group

enable_default_appbooleanOptional

Whether a default app is launched automatically in kiosk mode. Default: false

default_kiosk_appJSON ArrayOptional

The default app launched automatically when kiosk mode starts (single app)

Show Sub-Attributes

JSON Object

Show Sub-Attributes

group_display_namestringOptional

Display name of the app or app group

app_idlongOptional

Unique identifier of the app group

default_app_launch_modeintegerOptional

Default app launch behavior. Default: 0

default_app_launch_timeoutintegerOptional

Seconds of idle time before the default app is relaunched. Default: 20

wallpaperlongOptional

Wallpaper image file ID

is_wallpaper_removedbooleanOptional

Whether the kiosk wallpaper image has been removed. Default: false

show_me_mdm_appbooleanOptional

Whether the ME MDM app is visible on the kiosk launcher. Default: true

allow_notification_badgebooleanOptional

Whether notification badges are shown on app icons in kiosk mode. Default: false

allow_task_managerbooleanOptional

Whether the task manager is accessible in kiosk mode. Default: true

allow_system_barbooleanOptional

Whether the system bar is visible in kiosk mode. Default: true

allow_navigation_barbooleanOptional

Whether the navigation bar is visible in kiosk mode. Default: true

allow_status_barbooleanOptional

Whether the status bar is visible in kiosk mode. Default: true

allow_status_bar_expansionbooleanOptional

Whether the status bar can be expanded in kiosk mode. Default: true

allow_home_buttonbooleanOptional

Whether the home button is functional in kiosk mode. Default: true

allow_power_buttonbooleanOptional

Whether the power button is functional in kiosk mode. Default: true

allow_back_buttonbooleanOptional

Whether the back button is functional in kiosk mode. Default: true

allow_shutdownbooleanOptional

Whether the device can be shut down in kiosk mode. Default: true

allow_key_guardbooleanOptional

Whether the key guard (lock screen) is enabled in kiosk mode. Default: true

allow_notificationbooleanOptional

Whether notifications are shown in kiosk mode. Default: true

allow_system_error_dialogbooleanOptional

Whether app crash dialogs are displayed in kiosk mode. Default: false

allow_recent_appsbooleanOptional

Whether the recent apps view is accessible in kiosk mode. Default: true

allow_custom_settingsbooleanOptional

Whether the custom settings app is enabled in kiosk mode. Default: true

is_stay_awake_on_chargingbooleanOptional

Whether the device stays awake while charging in kiosk mode. Default: true

allow_simunlockbooleanOptional

Whether SIM unlock is allowed in kiosk mode. Default: true

allow_multiwindowbooleanOptional

Whether multi-window (split screen) mode is allowed in kiosk mode. Default: true

kiosk_custom_settingsJSON ObjectOptional

Advanced kiosk device feature controls configuration

Show Sub-Attributes

allow_wifibooleanOptional

Whether the user can access Wi-Fi settings in kiosk mode. Default: true

screen_orientationstringOptional

Forced screen orientation. Values: PORTRAIT, LANDSCAPE, AUTO

allow_brightnessbooleanOptional

Whether the user can adjust screen brightness. Default: true

screen_timeoutstringOptional

Screen timeout duration in milliseconds. 0 = User controlled, 15000 = 15 sec, 30000 = 30 sec, 60000 = 1 min, 300000 = 5 min, 1800000 = 30 min, 2147483647 = Always on

allow_flash_lightbooleanOptional

Whether the flashlight is accessible in kiosk mode. Default: true

allow_mobile_networkbooleanOptional

Whether mobile network settings are accessible. Default: true

allow_mobile_hotspot_settingsbooleanOptional

Whether mobile hotspot settings are accessible. Default: true

hotspot_settings_timeoutintegerOptional

Seconds before hotspot settings panel auto-closes. Default: 30

allow_bluetooth_settingsbooleanOptional

Whether Bluetooth settings are accessible. Default: true

bluetooth_settings_timeoutintegerOptional

Seconds before Bluetooth settings panel auto-closes. Default: 30

allow_apn_settingsbooleanOptional

Whether APN settings are accessible. Default: true

apn_settings_timeoutintegerOptional

Seconds before APN settings panel auto-closes. Default: 30

settings_timeoutintegerOptional

General settings panel timeout in seconds. Default: 30

allow_wifi_network_configurationbooleanOptional

Whether the user can add or configure Wi-Fi networks. Default: true

allow_battery_optimizationbooleanOptional

Whether battery optimization settings are accessible. Default: true

allow_locale_settingsbooleanOptional

Whether language and locale settings are accessible. Default: true

allow_device_passcode_change_settingsbooleanOptional

Whether the user can change the device passcode from kiosk mode. Default: true

allow_display_settingsbooleanOptional

Whether display settings are accessible. Default: true

battery_optimized_appsJSON ArrayOptional

List of apps exempt from battery optimization in kiosk mode

Show Sub-Attributes

JSON Object

Show Sub-Attributes

group_display_namestringOptional

Display name of the app or app group

app_idlongOptional

Unique identifier of the app group

mobile_data_usagebooleanOptional

Whether the user can view or manage mobile data usage. Default: true

default_keyboardbooleanOptional

Whether only the default keyboard is allowed. Default: true

allow_location_settingsbooleanOptional

Whether location settings are accessible. Default: true

allow_airplane_modebooleanOptional

Whether the user can toggle airplane mode. Default: true

allow_locationbooleanOptional

Whether location services are enabled on the device. Default: true

allow_nfc_settingsbooleanOptional

Whether NFC settings are accessible. Default: true

allow_datetime_settingsbooleanOptional

Whether date and time settings are accessible. Default: true

allow_accessibility_settingsbooleanOptional

Whether accessibility settings are accessible. Default: true

auto_distribute_appsbooleanOptional

Whether kiosk apps are automatically distributed to the device. Default: true

webclippoliciesJSON ArrayOptional

List of web shortcuts displayed on the kiosk home screen

Show Sub-Attributes

JSON Object

Show Sub-Attributes

webclip_policy_idlongOptional

Unique identifier of the web shortcut policy

webclip_namestringOptional

Display name of the web shortcut shown on the kiosk home screen

auto_distribute_webappbooleanOptional

Whether kiosk web shortcuts are automatically distributed. Default: true

exit_kiosk_passwordstringOptional

Password required to exit kiosk mode (write-only)

idle_refresh_timeoutintegerOptional

Seconds of idle time before web shortcuts are refreshed. -1 = Disabled. Default: -1

clear_cookies_on_idle_timeoutbooleanOptional

Whether cookies are cleared when the idle refresh timeout triggers. Default: true

clear_cache_on_idle_timeoutbooleanOptional

Whether cache is cleared when the idle refresh timeout triggers. Default: false

screenlayoutsettingsJSON ObjectOptional

Home screen layout appearance settings (orientation, icon size, text color)

Show Sub-Attributes

orientation_typeintegerOptional

Screen orientation. 0 = User Controlled, 1 = Portrait, 2 = Landscape

allow_change_app_positionbooleanOptional

Whether users can rearrange app icons on the home screen

text_colourstringOptional

Icon label text color as a hex color code (e.g., #FFFFFF)

text_sizeintegerOptional

Icon label font size in sp units

icon_sizeintegerOptional

App icon display size in dp units

model_typeintegerOptional

Home screen layout model type

screenlayoutJSON ObjectOptional

Kiosk home screen page layout structure containing pages, apps, web shortcuts, and folders

Show Sub-Attributes

pagesJSON ArrayOptional

Array of home screen pages in the kiosk layout

Show Sub-Attributes

JSON Object

Show Sub-Attributes

page_nointegerOptional

Page number (sequential order of this page)

page_typeintegerOptional

Page type. 1 = Home screen page, 2 = Dock page

screenpagelayoutJSON ArrayOptional

Array of items (apps, web shortcuts, folders) placed on this page

Show Sub-Attributes

JSON Object

Show Sub-Attributes

page_layout_rowintegerOptional

Row position of this item on the page grid

page_layout_columnintegerOptional

Column position of this item on the page grid

page_layout_typeintegerOptional

Item type. 1 = App, 2 = Web shortcut, 3 = Folder

app_idlongOptional

App ID (applicable when page_layout_type=1)

app_namestringOptional

Display name of the app

icon_file_namestringOptional

File name of the custom icon image

display_image_locstringOptional

Display image location path

webclip_namestringOptional

Web shortcut name (applicable when page_layout_type=2)

webclip_policy_idlongOptional

Web shortcut policy ID (applicable when page_layout_type=2)

folder_namestringOptional

Folder display name (applicable when page_layout_type=3)

folderpagesJSON ArrayOptional

Array of pages inside this folder (applicable when page_layout_type=3)

Show Sub-Attributes

JSON Object

Show Sub-Attributes

page_nointegerOptional

Page number within the folder

page_typeintegerOptional

Page type. 1 = Home screen page, 2 = Dock page

folderpagelayoutJSON ArrayOptional

Array of items placed on this folder page

Show Sub-Attributes

JSON Object

Show Sub-Attributes

page_layout_rowintegerOptional

Row position of this item within the folder page

page_layout_columnintegerOptional

Column position of this item within the folder page

page_layout_typeintegerOptional

Item type. 1 = App, 2 = Web shortcut

app_idlongOptional

App ID (applicable when page_layout_type=1)

app_namestringOptional

Display name of the app

webclip_namestringOptional

Web shortcut name (applicable when page_layout_type=2)

display_image_locstringOptional

Display image location path

icon_file_namestringOptional

File name of the custom icon image

webclip_policy_idlongOptional

Web shortcut policy ID (applicable when page_layout_type=2)

Sample Request

Curl

Java

Python

Deluge

PowerShell

Copied!

curl --request POST \
  --url https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/androidkioskhomescreenpolicy \
  --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":[]}'

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.io.IOException;
import java.net.http.HttpTimeoutException;

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

    HttpRequest request = HttpRequest.newBuilder()
        .uri(URI.create("https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/androidkioskhomescreenpolicy"))
        .header("Content-Type", "application/json")
        .header("Accept", "application/json")
        .header("Authorization", " d92d4xxxxxxxxxxxxx15f52")
        .method("POST", HttpRequest.BodyPublishers.ofString("{\"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\":[]}"))
        .build();
    HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.body());
  
  }
}

import http.client

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

payload = "{\"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\":[]}"

headers = {
    'Content-Type': "application/json",
    'Accept': "application/json",
    'Authorization': " 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"))


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

    data=Map();
    data.put("sub_config","value");
    data.put("kiosk_mode","1");
    data.put("launcher_type","1");
    data_allowed_apps=List();
    data_allowed_apps_item1=Map();
    data_allowed_apps_item1.put("group_display_name","value");
    data_allowed_apps_item1.put("app_id","1");
    data_allowed_apps.add(data_allowed_apps_item1);
    data.put("allowed_apps",data_allowed_apps);
    data_background_apps=List();
    data_background_apps_item1=Map();
    data_background_apps_item1.put("group_display_name","value");
    data_background_apps_item1.put("app_id","1");
    data_background_apps.add(data_background_apps_item1);
    data.put("background_apps",data_background_apps);
    data.put("enable_default_app",true);
    data_default_kiosk_app=List();
    data_default_kiosk_app_item1=Map();
    data_default_kiosk_app_item1.put("group_display_name","value");
    data_default_kiosk_app_item1.put("app_id","1");
    data_default_kiosk_app.add(data_default_kiosk_app_item1);
    data.put("default_kiosk_app",data_default_kiosk_app);
    data.put("default_app_launch_mode","1");
    data.put("default_app_launch_timeout","1");
    data.put("wallpaper","1");
    data.put("is_wallpaper_removed",true);
    data.put("show_me_mdm_app",true);
    data.put("allow_notification_badge",true);
    data.put("allow_task_manager",true);
    data.put("allow_system_bar",true);
    data.put("allow_navigation_bar",true);
    data.put("allow_status_bar",true);
    data.put("allow_status_bar_expansion",true);
    data.put("allow_home_button",true);
    data.put("allow_power_button",true);
    data.put("allow_back_button",true);
    data.put("allow_shutdown",true);
    data.put("allow_key_guard",true);
    data.put("allow_notification",true);
    data.put("allow_system_error_dialog",true);
    data.put("allow_recent_apps",true);
    data.put("allow_custom_settings",true);
    data.put("is_stay_awake_on_charging",true);
    data.put("allow_simunlock",true);
    data.put("allow_multiwindow",true);
    data_kiosk_custom_settings=Map();
    data_kiosk_custom_settings.put("allow_wifi",true);
    data_kiosk_custom_settings.put("screen_orientation","value");
    data_kiosk_custom_settings.put("allow_brightness",true);
    data_kiosk_custom_settings.put("screen_timeout","value");
    data_kiosk_custom_settings.put("allow_flash_light",true);
    data_kiosk_custom_settings.put("allow_mobile_network",true);
    data_kiosk_custom_settings.put("allow_mobile_hotspot_settings",true);
    data_kiosk_custom_settings.put("hotspot_settings_timeout","1");
    data_kiosk_custom_settings.put("allow_bluetooth_settings",true);
    data_kiosk_custom_settings.put("bluetooth_settings_timeout","1");
    data_kiosk_custom_settings.put("allow_apn_settings",true);
    data_kiosk_custom_settings.put("apn_settings_timeout","1");
    data_kiosk_custom_settings.put("settings_timeout","1");
    data_kiosk_custom_settings.put("allow_wifi_network_configuration",true);
    data_kiosk_custom_settings.put("allow_battery_optimization",true);
    data_kiosk_custom_settings.put("allow_locale_settings",true);
    data_kiosk_custom_settings.put("allow_device_passcode_change_settings",true);
    data_kiosk_custom_settings.put("allow_display_settings",true);
    data_kiosk_custom_settings_battery_optimized_apps=List();
    data_kiosk_custom_settings_battery_optimized_apps_item1=Map();
    data_kiosk_custom_settings_battery_optimized_apps_item1.put("group_display_name","value");
    data_kiosk_custom_settings_battery_optimized_apps_item1.put("app_id","1");
    data_kiosk_custom_settings_battery_optimized_apps.add(data_kiosk_custom_settings_battery_optimized_apps_item1);
    data_kiosk_custom_settings.put("battery_optimized_apps",data_kiosk_custom_settings_battery_optimized_apps);
    data_kiosk_custom_settings.put("mobile_data_usage",true);
    data_kiosk_custom_settings.put("default_keyboard",true);
    data_kiosk_custom_settings.put("allow_location_settings",true);
    data_kiosk_custom_settings.put("allow_airplane_mode",true);
    data_kiosk_custom_settings.put("allow_location",true);
    data_kiosk_custom_settings.put("allow_nfc_settings",true);
    data_kiosk_custom_settings.put("allow_datetime_settings",true);
    data_kiosk_custom_settings.put("allow_accessibility_settings",true);
    data.put("kiosk_custom_settings",data_kiosk_custom_settings);
    data.put("auto_distribute_apps",true);
    data_webclippolicies=List();
    data_webclippolicies_item1=Map();
    data_webclippolicies_item1.put("webclip_policy_id","1");
    data_webclippolicies_item1.put("webclip_name","value");
    data_webclippolicies.add(data_webclippolicies_item1);
    data.put("webclippolicies",data_webclippolicies);
    data.put("auto_distribute_webapp",true);
    data.put("exit_kiosk_password","value");
    data.put("idle_refresh_timeout","1");
    data.put("clear_cookies_on_idle_timeout",true);
    data.put("clear_cache_on_idle_timeout",true);
    data_screenlayoutsettings=Map();
    data_screenlayoutsettings.put("orientation_type","1");
    data_screenlayoutsettings.put("allow_change_app_position",true);
    data_screenlayoutsettings.put("text_colour","value");
    data_screenlayoutsettings.put("text_size","1");
    data_screenlayoutsettings.put("icon_size","1");
    data_screenlayoutsettings.put("model_type","1");
    data.put("screenlayoutsettings",data_screenlayoutsettings);
    data_screenlayout=Map();
    data_screenlayout_pages=List();
    data_screenlayout_pages_item1=Map();
    data_screenlayout_pages_item1.put("page_no","1");
    data_screenlayout_pages_item1.put("page_type","1");
    data_screenlayout_pages_item1_screenpagelayout=List();
    data_screenlayout_pages_item1_screenpagelayout_item1=Map();
    data_screenlayout_pages_item1_screenpagelayout_item1.put("page_layout_row","1");
    data_screenlayout_pages_item1_screenpagelayout_item1.put("page_layout_column","1");
    data_screenlayout_pages_item1_screenpagelayout_item1.put("page_layout_type","1");
    data_screenlayout_pages_item1_screenpagelayout_item1.put("app_id","1");
    data_screenlayout_pages_item1_screenpagelayout_item1.put("app_name","value");
    data_screenlayout_pages_item1_screenpagelayout_item1.put("icon_file_name","value");
    data_screenlayout_pages_item1_screenpagelayout_item1.put("display_image_loc","value");
    data_screenlayout_pages_item1_screenpagelayout_item1.put("webclip_name","value");
    data_screenlayout_pages_item1_screenpagelayout_item1.put("webclip_policy_id","1");
    data_screenlayout_pages_item1_screenpagelayout_item1.put("folder_name","value");
    data_screenlayout_pages_item1_screenpagelayout_item1_folderpages=List();
    data_screenlayout_pages_item1_screenpagelayout_item1_folderpages_item1=Map();
    data_screenlayout_pages_item1_screenpagelayout_item1_folderpages_item1.put("page_no","1");
    data_screenlayout_pages_item1_screenpagelayout_item1_folderpages_item1.put("page_type","1");
    data_screenlayout_pages_item1_screenpagelayout_item1_folderpages_item1_folderpagelayout=List();
    data_screenlayout_pages_item1_screenpagelayout_item1_folderpages_item1_folderpagelayout_item1=Map();
    data_screenlayout_pages_item1_screenpagelayout_item1_folderpages_item1_folderpagelayout_item1.put("page_layout_row","1");
    data_screenlayout_pages_item1_screenpagelayout_item1_folderpages_item1_folderpagelayout_item1.put("page_layout_column","1");
    data_screenlayout_pages_item1_screenpagelayout_item1_folderpages_item1_folderpagelayout_item1.put("page_layout_type","1");
    data_screenlayout_pages_item1_screenpagelayout_item1_folderpages_item1_folderpagelayout_item1.put("app_id","1");
    data_screenlayout_pages_item1_screenpagelayout_item1_folderpages_item1_folderpagelayout_item1.put("app_name","value");
    data_screenlayout_pages_item1_screenpagelayout_item1_folderpages_item1_folderpagelayout_item1.put("webclip_name","value");
    data_screenlayout_pages_item1_screenpagelayout_item1_folderpages_item1_folderpagelayout_item1.put("display_image_loc","value");
    data_screenlayout_pages_item1_screenpagelayout_item1_folderpages_item1_folderpagelayout_item1.put("icon_file_name","value");
    data_screenlayout_pages_item1_screenpagelayout_item1_folderpages_item1_folderpagelayout_item1.put("webclip_policy_id","1");
    data_screenlayout_pages_item1_screenpagelayout_item1_folderpages_item1_folderpagelayout.add(data_screenlayout_pages_item1_screenpagelayout_item1_folderpages_item1_folderpagelayout_item1);
    data_screenlayout_pages_item1_screenpagelayout_item1_folderpages_item1.put("folderpagelayout",data_screenlayout_pages_item1_screenpagelayout_item1_folderpages_item1_folderpagelayout);
    data_screenlayout_pages_item1_screenpagelayout_item1_folderpages.add(data_screenlayout_pages_item1_screenpagelayout_item1_folderpages_item1);
    data_screenlayout_pages_item1_screenpagelayout_item1.put("folderpages",data_screenlayout_pages_item1_screenpagelayout_item1_folderpages);
    data_screenlayout_pages_item1_screenpagelayout.add(data_screenlayout_pages_item1_screenpagelayout_item1);
    data_screenlayout_pages_item1.put("screenpagelayout",data_screenlayout_pages_item1_screenpagelayout);
    data_screenlayout_pages.add(data_screenlayout_pages_item1);
    data_screenlayout.put("pages",data_screenlayout_pages);
    data.put("screenlayout",data_screenlayout);

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

    info response;

$headers=@{}
$headers.Add("Content-Type", "application/json")
$headers.Add("Accept", "application/json")
$headers.Add("Authorization", " d92d4xxxxxxxxxxxxx15f52")
$response = Invoke-WebRequest -Uri 'https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/androidkioskhomescreenpolicy' -Method POST -Headers $headers -ContentType 'application/json' -Body '{"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

Add Kiosk Homescreen payload to the profile

Copied!

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

▼ Show full

Response Parameters

- HTTP code 200

Response Body - application/json

JSON Object

Hide Sub-Attributes

payload_idlong

Unique identifier for the created payload item

sub_configstring

Sub-configuration type identifier

kiosk_modeinteger

Kiosk mode. 0 = Single App, 1 = Multi App, 3 = Single Web App (COSU). Default: 0

launcher_typeinteger

Launcher type. 1 = Default device launcher, 2 = ME MDM custom launcher. Default: 2

allowed_appsJSON Array

List of apps allowed in kiosk mode

Show Sub-Attributes

JSON Object

Show Sub-Attributes

group_display_namestring

Display name of the app or app group

app_idlong

Unique identifier of the app group

background_appsJSON Array

List of apps that run in the background during kiosk mode

Show Sub-Attributes

JSON Object

Show Sub-Attributes

group_display_namestring

Display name of the app or app group

app_idlong

Unique identifier of the app group

enable_default_appboolean

Whether a default app is launched automatically in kiosk mode. Default: false

default_kiosk_appJSON Array

The default app launched automatically when kiosk mode starts (single app)

Show Sub-Attributes

JSON Object

Show Sub-Attributes

group_display_namestring

Display name of the app or app group

app_idlong

Unique identifier of the app group

default_app_launch_modeinteger

Default app launch behavior. Default: 0

default_app_launch_timeoutinteger

Seconds of idle time before the default app is relaunched. Default: 20

wallpaperlong

Wallpaper image file ID

is_wallpaper_removedboolean

Whether the kiosk wallpaper image has been removed. Default: false

show_me_mdm_appboolean

Whether the ME MDM app is visible on the kiosk launcher. Default: true

allow_notification_badgeboolean

Whether notification badges are shown on app icons in kiosk mode. Default: false

allow_task_managerboolean

Whether the task manager is accessible in kiosk mode. Default: true

allow_system_barboolean

Whether the system bar is visible in kiosk mode. Default: true

allow_navigation_barboolean

Whether the navigation bar is visible in kiosk mode. Default: true

allow_status_barboolean

Whether the status bar is visible in kiosk mode. Default: true

allow_status_bar_expansionboolean

Whether the status bar can be expanded in kiosk mode. Default: true

allow_home_buttonboolean

Whether the home button is functional in kiosk mode. Default: true

allow_power_buttonboolean

Whether the power button is functional in kiosk mode. Default: true

allow_back_buttonboolean

Whether the back button is functional in kiosk mode. Default: true

allow_shutdownboolean

Whether the device can be shut down in kiosk mode. Default: true

allow_key_guardboolean

Whether the key guard (lock screen) is enabled in kiosk mode. Default: true

allow_notificationboolean

Whether notifications are shown in kiosk mode. Default: true

allow_system_error_dialogboolean

Whether app crash dialogs are displayed in kiosk mode. Default: false

allow_recent_appsboolean

Whether the recent apps view is accessible in kiosk mode. Default: true

allow_custom_settingsboolean

Whether the custom settings app is enabled in kiosk mode. Default: true

is_stay_awake_on_chargingboolean

Whether the device stays awake while charging in kiosk mode. Default: true

allow_simunlockboolean

Whether SIM unlock is allowed in kiosk mode. Default: true

allow_multiwindowboolean

Whether multi-window (split screen) mode is allowed in kiosk mode. Default: true

kiosk_custom_settingsJSON Object

Advanced kiosk device feature controls configuration

Show Sub-Attributes

allow_wifiboolean

Whether the user can access Wi-Fi settings in kiosk mode. Default: true

screen_orientationstring

Forced screen orientation. Values: PORTRAIT, LANDSCAPE, AUTO

allow_brightnessboolean

Whether the user can adjust screen brightness. Default: true

screen_timeoutstring

Screen timeout duration in milliseconds. 0 = User controlled, 15000 = 15 sec, 30000 = 30 sec, 60000 = 1 min, 300000 = 5 min, 1800000 = 30 min, 2147483647 = Always on

allow_flash_lightboolean

Whether the flashlight is accessible in kiosk mode. Default: true

allow_mobile_networkboolean

Whether mobile network settings are accessible. Default: true

allow_mobile_hotspot_settingsboolean

Whether mobile hotspot settings are accessible. Default: true

hotspot_settings_timeoutinteger

Seconds before hotspot settings panel auto-closes. Default: 30

allow_bluetooth_settingsboolean

Whether Bluetooth settings are accessible. Default: true

bluetooth_settings_timeoutinteger

Seconds before Bluetooth settings panel auto-closes. Default: 30

allow_apn_settingsboolean

Whether APN settings are accessible. Default: true

apn_settings_timeoutinteger

Seconds before APN settings panel auto-closes. Default: 30

settings_timeoutinteger

General settings panel timeout in seconds. Default: 30

allow_wifi_network_configurationboolean

Whether the user can add or configure Wi-Fi networks. Default: true

allow_battery_optimizationboolean

Whether battery optimization settings are accessible. Default: true

allow_locale_settingsboolean

Whether language and locale settings are accessible. Default: true

allow_device_passcode_change_settingsboolean

Whether the user can change the device passcode from kiosk mode. Default: true

allow_display_settingsboolean

Whether display settings are accessible. Default: true

battery_optimized_appsJSON Array

List of apps exempt from battery optimization in kiosk mode

Show Sub-Attributes

JSON Object

Show Sub-Attributes

group_display_namestring

Display name of the app or app group

app_idlong

Unique identifier of the app group

mobile_data_usageboolean

Whether the user can view or manage mobile data usage. Default: true

default_keyboardboolean

Whether only the default keyboard is allowed. Default: true

allow_location_settingsboolean

Whether location settings are accessible. Default: true

allow_airplane_modeboolean

Whether the user can toggle airplane mode. Default: true

allow_locationboolean

Whether location services are enabled on the device. Default: true

allow_nfc_settingsboolean

Whether NFC settings are accessible. Default: true

allow_datetime_settingsboolean

Whether date and time settings are accessible. Default: true

allow_accessibility_settingsboolean

Whether accessibility settings are accessible. Default: true

auto_distribute_appsboolean

Whether kiosk apps are automatically distributed to the device. Default: true

webclippoliciesJSON Array

List of web shortcuts displayed on the kiosk home screen

Show Sub-Attributes

JSON Object

Show Sub-Attributes

webclip_policy_idlong

Unique identifier of the web shortcut policy

webclip_namestring

Display name of the web shortcut shown on the kiosk home screen

auto_distribute_webappboolean

Whether kiosk web shortcuts are automatically distributed. Default: true

exit_kiosk_passwordstring

Password required to exit kiosk mode (write-only)

idle_refresh_timeoutinteger

Seconds of idle time before web shortcuts are refreshed. -1 = Disabled. Default: -1

clear_cookies_on_idle_timeoutboolean

Whether cookies are cleared when the idle refresh timeout triggers. Default: true

clear_cache_on_idle_timeoutboolean

Whether cache is cleared when the idle refresh timeout triggers. Default: false

screenlayoutsettingsJSON Object

Home screen layout appearance settings (orientation, icon size, text color)

Show Sub-Attributes

orientation_typeinteger

Screen orientation. 0 = User Controlled, 1 = Portrait, 2 = Landscape

allow_change_app_positionboolean

Whether users can rearrange app icons on the home screen

text_colourstring

Icon label text color as a hex color code (e.g., #FFFFFF)

text_sizeinteger

Icon label font size in sp units

icon_sizeinteger

App icon display size in dp units

model_typeinteger

Home screen layout model type

screenlayoutJSON Object

Kiosk home screen page layout structure containing pages, apps, web shortcuts, and folders

Show Sub-Attributes

pagesJSON Array

Array of home screen pages in the kiosk layout

Show Sub-Attributes

JSON Object

Show Sub-Attributes

page_nointeger

Page number (sequential order of this page)

page_typeinteger

Page type. 1 = Home screen page, 2 = Dock page

screenpagelayoutJSON Array

Array of items (apps, web shortcuts, folders) placed on this page

Show Sub-Attributes

JSON Object

Show Sub-Attributes

page_layout_rowinteger

Row position of this item on the page grid

page_layout_columninteger

Column position of this item on the page grid

page_layout_typeinteger

Item type. 1 = App, 2 = Web shortcut, 3 = Folder

app_idlong

App ID (applicable when page_layout_type=1)

app_namestring

Display name of the app

icon_file_namestring

File name of the custom icon image

display_image_locstring

Display image location path

webclip_namestring

Web shortcut name (applicable when page_layout_type=2)

webclip_policy_idlong

Web shortcut policy ID (applicable when page_layout_type=2)

folder_namestring

Folder display name (applicable when page_layout_type=3)

folderpagesJSON Array

Array of pages inside this folder (applicable when page_layout_type=3)

Show Sub-Attributes

JSON Object

Show Sub-Attributes

page_nointeger

Page number within the folder

page_typeinteger

Page type. 1 = Home screen page, 2 = Dock page

folderpagelayoutJSON Array

Array of items placed on this folder page

Show Sub-Attributes

JSON Object

Show Sub-Attributes

page_layout_rowinteger

Row position of this item within the folder page

page_layout_columninteger

Column position of this item within the folder page

page_layout_typeinteger

Item type. 1 = App, 2 = Web shortcut

app_idlong

App ID (applicable when page_layout_type=1)

app_namestring

Display name of the app

webclip_namestring

Web shortcut name (applicable when page_layout_type=2)

display_image_locstring

Display image location path

icon_file_namestring

File name of the custom icon image

webclip_policy_idlong

Web shortcut policy ID (applicable when page_layout_type=2)

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Kiosk Homescreen payload successfully added

Copied!

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

▼ Show full

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.