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

Modify Android Lock screen policy payload

## Endpoint

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

## Request

### Request URL

```text
https://{server-hostname}:8383/api/v1/mdm/profiles/{profile_id}/payloads/androidlockscreenmessage/payloaditems/{payload_id}
```

### Scope

```text
MDMDeviceMgmt.UPDATE
```

### Header

```text
Authorization: d92d4xxxxxxxxxxxxx15f52
```

### Request Parameters

#### Request Headers

| Parameter | Type | Required | Value |
|---|---|---|---|
| Content-Type | string | Mandatory | application/json |
| Accept | string | Mandatory | application/json |

#### Path Parameters

| Parameter | Type | Required | Description |
|---|---|---|---|
| profile_id | string | Mandatory | Unique identifier of the profile. Obtain from the [Create Profile](https://www.manageengine.com/products/desktop-central/help/api/onpremise/mdm-profiles-create-profile.html) or [Get Profiles](https://www.manageengine.com/products/desktop-central/help/api/onpremise/mdm-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/products/desktop-central/help/api/onpremise/android-get-lock-screen-message-payload-android.html) response |

#### Request Body

`application/json`

| Parameter | Type | Required | Description |
|---|---|---|---|
| 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 | JSON Array | Mandatory | Array of messages displayed on the lock screen (required, max 5 messages) |
| 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
curl --request PUT \
  --url https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/androidlockscreenmessage/payloaditems/{payload_id} \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '{"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}'
```

### Sample Request Body

Modify Lock Screen Message payload item

```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

### HTTP Code 200

#### Response Body

`application/json`

| Parameter | Type | Description |
|---|---|---|
| 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 | JSON Array | Array of messages displayed on the lock screen (required, max 5 messages) |
| 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 |

### Possible Response Codes

| Code | Type |
|---|---|
| 200 | HTTP code |

### Sample Response: HTTP 200

Lock Screen Message payload item successfully modified

```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
}
```

## Rate Limit

![](https://www.zohowebstatic.com/sites/zweb/images/people/ico-help.png)

**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.