# Modify the configuration of a Lock Screen Message payload item within a profile

Modify Android Lock screen policy payload

## Endpoints

**PUT** `/api/v1/mdm/profiles/{profile_id}/payloads/androidlockscreenmessage/payloaditems/{payload_id}`

## Request URL

```
https://{serverurl}/api/v1/mdm/profiles/{profile_id}/payloads/androidlockscreenmessage/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/android-get-lock-screen-message-payload-android.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.  
  - `1` = Custom color wallpaper  
  - `2` = Uploaded image wallpaper  
  - `3` = Uploaded image with separate landscape image (required)

- **bg_colour** (string) — Optional  
  Background hex color code for custom wallpaper (applies when `wallpaper_type=1`, e.g., `#FFFFFF`).

- **wallpaper** (long) — Optional  
  Wallpaper image file ID (applies when `wallpaper_type=2` or `3`).

- **landscape_wallpaper** (long) — Optional  
  Landscape wallpaper image file ID (applies when `wallpaper_type=3`).

- **messages** (array) — Mandatory  
  Array of messages displayed on the lock screen (required, max 5 messages).

  Each message object:

  - **message** (string) — Mandatory  
    Lock screen message text (required, max 100 characters).
  - **text_colour** (string) — Mandatory  
    Message text color as a hex color code (e.g., `#FF0000`).
  - **order** (integer) — Optional  
    Display order of this message on the lock screen.

- **wallpaper_modified** (boolean) — Optional  
  Whether the wallpaper image has been modified.

- **landscape_wallpaper_modified** (boolean) — Optional  
  Whether the landscape wallpaper image has been modified.

- **orientation** (integer) — Optional  
  Lock screen message orientation.  
  - `0` = User Controlled  
  - `1` = Portrait  
  - `2` = Landscape  
  Default: `1`.

- **asset_tag_show_option** (integer) — Optional  
  Asset tag display location.  
  - `0` = Lock screen  
  - `1` = Kiosk launcher  
  - `2` = Lock screen and kiosk launcher  
  Default: `0`.

- **asset_tag_text_size** (integer) — Optional  
  Asset tag text size.  
  - `1` = Small  
  - `2` = Medium  
  - `3` = Large  
  Default: `1`.

## Sample Request

### Curl

```bash
curl --request PUT \
  --url https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/androidlockscreenmessage/payloaditems/{payload_id} \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52' \
  --header 'content-type: application/json' \
  --data '{"messages":[{"text_colour":"#000000","message":"This device belongs to Example Corp"}],"wallpaper_type":2}'
```

### 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/androidlockscreenmessage/payloaditems/{payload_id}"))
        .header("content-type", "application/json")
        .header("Authorization", "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52")
        .method("PUT", HttpRequest.BodyPublishers.ofString("{\"messages\":[{\"text_colour\":\"#000000\",\"message\":\"This device belongs to Example Corp\"}],\"wallpaper_type\":2}"))
        .build();
    HttpResponse<String> response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.body());

  }
}
```

### Python

```python
import http.client

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

payload = "{\"messages\":[{\"text_colour\":\"#000000\",\"message\":\"This device belongs to Example Corp\"}],\"wallpaper_type\":2}"

headers = {
    'content-type': "application/json",
    'Authorization': "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52"
    }

conn.request("PUT", "/api/v1/mdm/profiles/{profile_id}/payloads/androidlockscreenmessage/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=List();
data_messages_item1_item1=Map();
data_messages_item1_item1.put("text_colour","value");
data_messages_item1_item1.put("message","value");
data_messages_item1.add(data_messages_item1_item1);
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/androidlockscreenmessage/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/androidlockscreenmessage/payloaditems/{payload_id}' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{"messages":[{"text_colour":"#000000","message":"This device belongs to Example Corp"}],"wallpaper_type":2}'
```

## Sample Request Body

```json
{
  "orientation": 1,
  "wallpaper": 9007199254741080,
  "wallpaper_modified": false,
  "messages": [
    {
      "text_colour": "#000000",
      "message": "This device belongs to Example Corp"
    }
  ],
  "wallpaper_type": 2,
  "landscape_wallpaper": 0,
  "bg_colour": "#ffffff",
  "landscape_wallpaper_modified": false
}
```

## Response Parameters

### HTTP 200

**Response Body:** `application/json`

#### JSON Object

- **payload_id** (long)  
  Unique identifier of the payload item.

- **wallpaper_type** (integer)  
  Wallpaper type.  
  - `1` = Custom color wallpaper  
  - `2` = Uploaded image wallpaper  
  - `3` = Uploaded image with separate landscape image (required)

- **bg_colour** (string)  
  Background hex color code for custom wallpaper (applies when `wallpaper_type=1`, e.g., `#FFFFFF`).

- **wallpaper** (long)  
  Wallpaper image file ID (applies when `wallpaper_type=2` or `3`).

- **landscape_wallpaper** (long)  
  Landscape wallpaper image file ID (applies when `wallpaper_type=3`).

- **messages** (array)  
  Array of messages displayed on the lock screen (max 5 messages).

  Each message object:

  - **message** (string)  
    Lock screen message text (max 100 characters).
  - **text_colour** (string)  
    Message text color as a hex color code (e.g., `#FF0000`).
  - **order** (integer)  
    Display order of this message on the lock screen.

- **wallpaper_modified** (boolean)  
  Whether the wallpaper image has been modified.

- **landscape_wallpaper_modified** (boolean)  
  Whether the landscape wallpaper image has been modified.

- **orientation** (integer)  
  Lock screen message orientation.  
  - `0` = User Controlled  
  - `1` = Portrait  
  - `2` = Landscape  
  Default: `1`.

- **asset_tag_show_option** (integer)  
  Asset tag display location.  
  - `0` = Lock screen  
  - `1` = Kiosk launcher  
  - `2` = Lock screen and kiosk launcher  
  Default: `0`.

- **asset_tag_text_size** (integer)  
  Asset tag text size.  
  - `1` = Small  
  - `2` = Medium  
  - `3` = Large  
  Default: `1`.

## Sample Response: HTTP 200

```json
{
  "payload_id": 9007199254741000,
  "orientation": 1,
  "wallpaper": 9007199254741080,
  "wallpaper_modified": false,
  "messages": [
    {
      "text_colour": "#000000",
      "message": "This device belongs to Example Corp"
    }
  ],
  "wallpaper_type": 2,
  "landscape_wallpaper": 0,
  "bg_colour": "#ffffff",
  "landscape_wallpaper_modified": false
}
```

## Possible Response Codes

- **200** — HTTP code