# Modify the configuration of a Wallpaper payload item within a profile To modify Ios Wallpaper policy payload item ## Endpoint **PUT** `/api/v1/mdm/profiles/{profile_id}/payloads/ioswallpaperpolicy/payloaditems/{payload_id}` ## Request URL ``` https://{serverurl}/api/v1/mdm/profiles/{profile_id}/payloads/ioswallpaperpolicy/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-wallpaper-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` **Type:** JSON object ### Attributes - **below_hdpi_wallpaper** (long, Optional) Below Hdpi Wallpaper. Use the fileID from the [File Upload API](https://www.manageengine.com/mobile-device-management/help/api/cloud/files-upload-file-ems.html) response. - **above_hdpi_wallpaper** (long, Optional) Above Hdpi Wallpaper. Use the fileID from the [File Upload API](https://www.manageengine.com/mobile-device-management/help/api/cloud/files-upload-file-ems.html) response. - **below_hdpi_lock_wallpaper** (long, Optional) Below Hdpi Lock Wallpaper. Use the fileID from the [File Upload API](https://www.manageengine.com/mobile-device-management/help/api/cloud/files-upload-file-ems.html) response. - **is_below_hdpi_wall_modified** (boolean, Optional) Is Below Hdpi Wall Modified. - **is_above_hdpi_wall_modified** (boolean, Optional) Is Above Hdpi Wall Modified. - **is_below_hdpi_lock_wall_modified** (boolean, Optional) Is Below Hdpi Lock Wall Modified. - **set_wallpaper_position** (integer, Mandatory) Wallpaper position. Allowed values: 1 = Lock Screen 2 = Home Screen 3 = Both Lock Screen and Home Screen are configured with same image 4 = Both Lock screen and Home screen are configured with different images - **allow_wallpaper_change** (boolean, Optional) Allow Wallpaper Change. Default: false. ## Sample Request ### Curl ```bash curl --request PUT \ --url https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/ioswallpaperpolicy/payloaditems/{payload_id} \ --header 'Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52' \ --header 'content-type: application/json' \ --data '"{ \"below_hdpi_wallpaper\": \"value\", \"above_hdpi_wallpaper\": \"value\", \"below_hdpi_lock_wallpaper\": \"value\", \"below_hdpi_wallpaper\": \"value\", \"above_hdpi_wallpaper\": \"value\", \"below_hdpi_lock_wallpaper\": \"value\", \"is_below_hdpi_wall_modified\": false, \"is_above_hdpi_wall_modified\": false, \"is_below_hdpi_lock_wall_modified\": false, \"set_wallpaper_position\": 3 }"' ``` ### 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/ioswallpaperpolicy/payloaditems/{payload_id}")) .header("content-type", "application/json") .header("Authorization", "Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52") .method("PUT", HttpRequest.BodyPublishers.ofString("\"{ \\\"below_hdpi_wallpaper\\\": \\\"value\\\", \\\"above_hdpi_wallpaper\\\": \\\"value\\\", \\\"below_hdpi_lock_wallpaper\\\": \\\"value\\\", \\\"below_hdpi_wallpaper\\\": \\\"value\\\", \\\"above_hdpi_wallpaper\\\": \\\"value\\\", \\\"below_hdpi_lock_wallpaper\\\": \\\"value\\\", \\\"is_below_hdpi_wall_modified\\\": false, \\\"is_above_hdpi_wall_modified\\\": false, \\\"is_below_hdpi_lock_wall_modified\\\": false, \\\"set_wallpaper_position\\\": 3 }\"")) .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 = "\"{ \\\"below_hdpi_wallpaper\\\": \\\"value\\\", \\\"above_hdpi_wallpaper\\\": \\\"value\\\", \\\"below_hdpi_lock_wallpaper\\\": \\\"value\\\", \\\"below_hdpi_wallpaper\\\": \\\"value\\\", \\\"above_hdpi_wallpaper\\\": \\\"value\\\", \\\"below_hdpi_lock_wallpaper\\\": \\\"value\\\", \\\"is_below_hdpi_wall_modified\\\": false, \\\"is_above_hdpi_wall_modified\\\": false, \\\"is_below_hdpi_lock_wall_modified\\\": false, \\\"set_wallpaper_position\\\": 3 }\"" headers = { 'content-type': "application/json", 'Authorization': "Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52" } conn.request("PUT", "/api/v1/mdm/profiles/{profile_id}/payloads/ioswallpaperpolicy/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("set_wallpaper_position","1"); response = invokeUrl [ url: "https://appDomain/api/v1/mdm/profiles/{profile_id}/payloads/ioswallpaperpolicy/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/ioswallpaperpolicy/payloaditems/{payload_id}' -Method PUT -Headers $headers -ContentType 'application/json' -Body '"{ \"below_hdpi_wallpaper\": \"value\", \"above_hdpi_wallpaper\": \"value\", \"below_hdpi_lock_wallpaper\": \"value\", \"below_hdpi_wallpaper\": \"value\", \"above_hdpi_wallpaper\": \"value\", \"below_hdpi_lock_wallpaper\": \"value\", \"is_below_hdpi_wall_modified\": false, \"is_above_hdpi_wall_modified\": false, \"is_below_hdpi_lock_wall_modified\": false, \"set_wallpaper_position\": 3 }"' ``` ## Sample Request Body ```json "{ \"below_hdpi_wallpaper\": \"value\", \"above_hdpi_wallpaper\": \"value\", \"below_hdpi_lock_wallpaper\": \"value\", \"below_hdpi_wallpaper\": \"value\", \"above_hdpi_wallpaper\": \"value\", \"below_hdpi_lock_wallpaper\": \"value\", \"is_below_hdpi_wall_modified\": false, \"is_above_hdpi_wall_modified\": false, \"is_below_hdpi_lock_wall_modified\": false, \"set_wallpaper_position\": 3 }" ``` ## Response Parameters ### HTTP 200 **Response Body:** `application/json` **Type:** JSON object #### Attributes - **payload_id** (long) Unique identifier of the payload item. - **below_hdpi_wallpaper** (long) Below Hdpi Wallpaper. Use the fileID from the [File Upload API](https://www.manageengine.com/mobile-device-management/help/api/cloud/files-upload-file-ems.html) response. - **above_hdpi_wallpaper** (long) Above Hdpi Wallpaper. Use the fileID from the [File Upload API](https://www.manageengine.com/mobile-device-management/help/api/cloud/files-upload-file-ems.html) response. - **below_hdpi_lock_wallpaper** (long) Below Hdpi Lock Wallpaper. Use the fileID from the [File Upload API](https://www.manageengine.com/mobile-device-management/help/api/cloud/files-upload-file-ems.html) response. - **is_below_hdpi_wall_modified** (boolean) Is Below Hdpi Wall Modified. - **is_above_hdpi_wall_modified** (boolean) Is Above Hdpi Wall Modified. - **is_below_hdpi_lock_wall_modified** (boolean) Is Below Hdpi Lock Wall Modified. - **set_wallpaper_position** (integer) Wallpaper position. Allowed values: 1 = Lock Screen 2 = Home Screen 3 = Both Lock Screen and Home Screen are configured with same image 4 = Both Lock screen and Home screen are configured with different images - **allow_wallpaper_change** (boolean) Allow Wallpaper Change. Default: false. ## Sample Response: HTTP 200 ```json "{ \"payload_id\": 9007199254741001, \"below_hdpi_wallpaper\": \"value\", \"above_hdpi_wallpaper\": \"value\", \"below_hdpi_lock_wallpaper\": \"value\", \"below_hdpi_wallpaper\": \"value\", \"above_hdpi_wallpaper\": \"value\", \"below_hdpi_lock_wallpaper\": \"value\", \"is_below_hdpi_wall_modified\": false, \"is_above_hdpi_wall_modified\": false, \"is_below_hdpi_lock_wall_modified\": false, \"set_wallpaper_position\": 3 }" ``` ## Possible Response Codes - **200** — HTTP code