# Modify the configuration of a Lock Screen Message payload item within a profile To modify Ios Lock Screen Message payload item ## Endpoints **PUT** `/api/v1/mdm/profiles/{profile_id}/payloads/ioslockscreenmessage/payloaditems/{payload_id}` ## Request URL ``` https://{serverurl}/api/v1/mdm/profiles/{profile_id}/payloads/ioslockscreenmessage/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-lock-screen-message-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** - **wallpaper_type** (integer) — **Mandatory** Wallpaper type for lock screen. Allowed values: - `1` = Background Color - `2` = Uploaded Image - **bg_colour** (string) — Optional Bg Colour - **wallpaper** (string) — Optional 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. - **messages** (array) — **Mandatory** List of lock screen messages - **message** (string) — Optional Message text to display on lock screen - **text_colour** (string) — Optional Text colour hex code (e.g. `#FFFFFF`) - **offset_position** (integer) — Optional Vertical offset position of the message - **wallpaper_modified** (boolean) — Optional Wallpaper Modified - **orientation** (integer) — Optional Orientation. Default: `1` ## Sample Request ### Curl ```bash curl --request PUT \ --url https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/ioslockscreenmessage/payloaditems/{payload_id} \ --header 'Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52' \ --header 'content-type: application/json' \ --data '"{ \"wallpaper_type\": -1, \"bg_colour\": \"value\", \"wallpaper\": \"value\", \"wallpaper\": \"value\", \"messages\": [{\"message\": \"Zylker message\", \"text_colour\": \"#000000\", \"offset_position\": 0}], \"wallpaper_modified\": false, \"orientation\": 1 }"' ``` ### 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/ioslockscreenmessage/payloaditems/{payload_id}")) .header("content-type", "application/json") .header("Authorization", "Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52") .method("PUT", HttpRequest.BodyPublishers.ofString("\"{ \\\"wallpaper_type\\\": -1, \\\"bg_colour\\\": \\\"value\\\", \\\"wallpaper\\\": \\\"value\\\", \\\"wallpaper\\\": \\\"value\\\", \\\"messages\\\": [{\\\"message\\\": \\\"Zylker message\\\", \\\"text_colour\\\": \\\"#000000\\\", \\\"offset_position\\\": 0}], \\\"wallpaper_modified\\\": false, \\\"orientation\\\": 1 }\"")) .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 = "\"{ \\\"wallpaper_type\\\": -1, \\\"bg_colour\\\": \\\"value\\\", \\\"wallpaper\\\": \\\"value\\\", \\\"wallpaper\\\": \\\"value\\\", \\\"messages\\\": [{\\\"message\\\": \\\"Zylker message\\\", \\\"text_colour\\\": \\\"#000000\\\", \\\"offset_position\\\": 0}], \\\"wallpaper_modified\\\": false, \\\"orientation\\\": 1 }\"" headers = { 'content-type': "application/json", 'Authorization': "Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52" } conn.request("PUT", "/api/v1/mdm/profiles/{profile_id}/payloads/ioslockscreenmessage/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_messages=List(); data_messages_item1=Map(); data_messages.add(data_messages_item1); data.put("messages",data_messages); data.put("wallpaper_type","1"); response = invokeUrl [ url: "https://appDomain/api/v1/mdm/profiles/{profile_id}/payloads/ioslockscreenmessage/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/ioslockscreenmessage/payloaditems/{payload_id}' -Method PUT -Headers $headers -ContentType 'application/json' -Body '"{ \"wallpaper_type\": -1, \"bg_colour\": \"value\", \"wallpaper\": \"value\", \"wallpaper\": \"value\", \"messages\": [{\"message\": \"Zylker message\", \"text_colour\": \"#000000\", \"offset_position\": 0}], \"wallpaper_modified\": false, \"orientation\": 1 }"'``` ## Sample Request Body ```json "{ \"wallpaper_type\": -1, \"bg_colour\": \"value\", \"wallpaper\": \"value\", \"wallpaper\": \"value\", \"messages\": [{\"message\": \"Zylker message\", \"text_colour\": \"#000000\", \"offset_position\": 0}], \"wallpaper_modified\": false, \"orientation\": 1 }" ``` ## Response Parameters ### HTTP 200 **Response Body:** `application/json` **JSON object** - **payload_id** (long) Unique identifier of the payload item - **wallpaper_type** (integer) Wallpaper type for lock screen. Allowed values: - `1` = Background Color - `2` = Uploaded Image - **bg_colour** (string) Bg Colour - **wallpaper** (long) 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. - **messages** (array) List of lock screen messages - **message** (string) Message text to display on lock screen - **text_colour** (string) Text colour hex code (e.g. `#FFFFFF`) - **offset_position** (integer) Vertical offset position of the message - **wallpaper_modified** (boolean) Wallpaper Modified - **orientation** (integer) Orientation. Default: `1` ## Sample Response: HTTP 200 ```json "{ \"payload_id\": 9007199254741001, \"wallpaper_type\": -1, \"bg_colour\": \"value\", \"wallpaper\": \"value\", \"wallpaper\": \"value\", \"messages\": [{\"message\": \"Zylker message\", \"text_colour\": \"#000000\", \"offset_position\": 0}], \"wallpaper_modified\": false, \"orientation\": 1 }" ``` ## Possible Response Codes - **200** — HTTP code