# Modify the configuration of a Web Clips payload item within a profile To modify Web Clips policy payload item ## Endpoint **PUT** `/api/v1/mdm/profiles/{profile_id}/payloads/webclipspolicy/payloaditems/{payload_id}` ## Request URL ``` https://{serverurl}/api/v1/mdm/profiles/{profile_id}/payloads/webclipspolicy/payloaditems/{payload_id} ``` - `{serverurl}` – Obtain your server URL from the OAuth authentication domain: https://www.manageengine.com/mobile-device-management/help/api/cloud/oauth-authentication-endpoint-domain.html ## 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-web-clips-payload-ios.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` ### JSON Object - **webclip_label** (string, Mandatory) Webclip Label. - **webclip_name** (string, Mandatory) Webclip Name. - **webclip_url** (string, Mandatory) Webclip Url. - **is_removal** (boolean, Optional) Is Removal. Default: true. - **webclips_file_upload** (long, Optional) Webclips File Upload. Use the fileID from the [File Upload API](https://www.manageengine.com/mobile-device-management/help/api/cloud/files-upload-file-ems.html) response. - **icon_file_name** (string, Optional) Icon File Name. - **use_precomp_icon** (boolean, Optional) Use Precomp Icon. Default: false. - **allow_full_screen** (boolean, Optional) Allow Full Screen. Default: false. - **webclip_policy_id** (long, Optional) Webclip Policy Id. - **allow_site_permission** (boolean, Optional) Allow Site Permission. Default: false. ## Sample Request ### Curl ```bash curl --request PUT \ --url https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/webclipspolicy/payloaditems/{payload_id} \ --header 'Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52' \ --header 'content-type: application/json' \ --data '{"webclip_url":"https://zylker.com","webclip_label":"value","webclip_name":"Zylker User"}' ``` ### 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/webclipspolicy/payloaditems/{payload_id}")) .header("content-type", "application/json") .header("Authorization", "Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52") .method("PUT", HttpRequest.BodyPublishers.ofString("{\"webclip_url\":\"https://zylker.com\",\"webclip_label\":\"value\",\"webclip_name\":\"Zylker User\"}")) .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 = "{\"webclip_url\":\"https://zylker.com\",\"webclip_label\":\"value\",\"webclip_name\":\"Zylker User\"}" headers = { 'content-type': "application/json", 'Authorization': "Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52" } conn.request("PUT", "/api/v1/mdm/profiles/{profile_id}/payloads/webclipspolicy/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(); data.put("webclip_url","value"); data.put("webclip_label","value"); data.put("webclip_name","value"); response = invokeUrl [ url: "https://appDomain/api/v1/mdm/profiles/{profile_id}/payloads/webclipspolicy/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/webclipspolicy/payloaditems/{payload_id}' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{"webclip_url":"https://zylker.com","webclip_label":"value","webclip_name":"Zylker User"}' ``` ## Sample Request Body ```json { "webclip_url": "https://zylker.com", "is_removal": true, "allow_site_permission": false, "webclip_label": "value", "webclip_policy_id": 1, "webclips_file_upload": "value", "webclip_name": "Zylker User", "use_precomp_icon": false, "icon_file_name": "value", "allow_full_screen": false } ``` ## Response Parameters ### HTTP 200 **Response Body:** `application/json` #### JSON Object - **payload_id** (long) Unique identifier of the payload item. - **webclip_label** (string) Webclip Label. - **webclip_name** (string) Webclip Name. - **webclip_url** (string) Webclip Url. - **is_removal** (boolean) Is Removal. Default: true. - **webclips_file_upload** (long) Webclips File Upload. Use the fileID from the [File Upload API](https://www.manageengine.com/mobile-device-management/help/api/cloud/files-upload-file-ems.html) response. - **icon_file_name** (string) Icon File Name. - **use_precomp_icon** (boolean) Use Precomp Icon. Default: false. - **allow_full_screen** (boolean) Allow Full Screen. Default: false. - **webclip_policy_id** (long) Webclip Policy Id. - **allow_site_permission** (boolean) Allow Site Permission. Default: false. ## Sample Response: HTTP 200 ```json { "webclip_url": "https://zylker.com", "payload_id": 9007199254741000, "is_removal": true, "allow_site_permission": false, "webclip_label": "value", "webclip_policy_id": 1, "webclips_file_upload": "value", "webclip_name": "Zylker User", "use_precomp_icon": false, "icon_file_name": "value", "allow_full_screen": false } ``` ## Possible Response Codes - **200** – HTTP code ## 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.