# Modify the configuration of a Shared Device Configuration payload item within a profile To modify Shared Device Configuration payload item ## Endpoints **PUT** `/api/v1/mdm/profiles/{profile_id}/payloads/shareddeviceconfiguration/payloaditems/{payload_id}` ## Request URL ``` https://{serverurl}/api/v1/mdm/profiles/{profile_id}/payloads/shareddeviceconfiguration/payloaditems/{payload_id} ``` ## Scope ``` MDMOnDemand.MDMDeviceMgmt.UPDATE ``` ## 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. - **payload_id** (string, Mandatory) Unique identifier of the payload item. Obtain from the [Get Payload Item IDs](https://www.manageengine.com/mobile-device-management/help/api/cloud/ios-get-shared-device-configuration-payload.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 - **user_allowed** (integer, Optional) Maximum number of users allowed on shared device. 0 means no limit. Default: 0 - **idle_time_logout** (integer, Optional) Idle time in seconds before auto-logout for regular users. 0 means disabled. Default: 0 - **max_grace_period** (integer, Optional) Maximum grace period in seconds before passcode is required. Allowed values: - `-1` = Not Configured - `0` = Immediately - `60`, `300`, `900`, `3600`, `14400` Default: `-1` - **diagnostics_submission** (integer, Optional) Diagnostics submission setting. Allowed values: - `0` = Not Configured - `1` = Enable - `2` = Disable - **app_analytics** (integer, Optional) App analytics setting. Allowed values: - `0` = Not Configured - `1` = Enable - `2` = Disable - **online_authentication_grace_period** (integer, Optional) Online authentication grace period in days. Default: 0 - **domains** (array, Optional) List of domain name strings for shared device authentication. ## Sample Request ### Curl ```bash curl --request PUT \ --url https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/shareddeviceconfiguration/payloaditems/{payload_id} \ --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; 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/shareddeviceconfiguration/payloaditems/{payload_id}")) .header("content-type", "application/json") .header("Authorization", "Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52") .method("PUT", HttpRequest.BodyPublishers.ofString("{}")) .build(); HttpResponse 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("PUT", "/api/v1/mdm/profiles/{profile_id}/payloads/shareddeviceconfiguration/payloaditems/{payload_id}", 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/shareddeviceconfiguration/payloaditems/{payload_id}" type: PUT 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/shareddeviceconfiguration/payloaditems/{payload_id}' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{}' ``` ## Sample Request Body ```json { "diagnostics_submission": 1, "user_allowed": 1, "max_grace_period": -1, "domains": [ "zylker.com" ], "online_authentication_grace_period": -1, "idle_time_logout": 0, "app_analytics": 2 } ``` ## Response Parameters ### HTTP 200 **Response Body:** `application/json` **Type:** JSON object #### Attributes - **payload_id** (long) Unique identifier of the payload item. - **user_allowed** (integer) Maximum number of users allowed on shared device. 0 means no limit. Default: 0 - **idle_time_logout** (integer) Idle time in seconds before auto-logout for regular users. 0 means disabled. Default: 0 - **max_grace_period** (integer) Maximum grace period in seconds before passcode is required. Allowed values: - `-1` = Not Configured - `0` = Immediately - `60`, `300`, `900`, `3600`, `14400` Default: `-1` - **diagnostics_submission** (integer) Diagnostics submission setting. Allowed values: - `0` = Not Configured - `1` = Enable - `2` = Disable - **app_analytics** (integer) App analytics setting. Allowed values: - `0` = Not Configured - `1` = Enable - `2` = Disable - **online_authentication_grace_period** (integer) Online authentication grace period in days. Default: 0 - **domains** (array) List of domain name strings for shared device authentication. ## Sample Response: HTTP 200 ```json { "payload_id": 9007199254741000, "diagnostics_submission": 1, "user_allowed": 1, "max_grace_period": -1, "domains": [ "zylker.com" ], "online_authentication_grace_period": -1, "idle_time_logout": 0, "app_analytics": 2 } ``` ## Rate Limit **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.