# Modify the configuration of a Wallpaper payload item within a profile

Modify Android Wallpaper policy payload

## Endpoints

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

## Request URL

```
https://{serverurl}/api/v1/mdm/profiles/{profile_id}/payloads/androidwallpaperpolicy/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-wallpaper-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`  
Type: JSON object

#### Attributes

- **below_hdpi_wallpaper** (long) — Optional  
  Wallpaper image file for sub-HDPI density devices

- **above_hdpi_wallpaper** (long) — Optional  
  Wallpaper image file for HDPI and above density devices

- **allow_wallpaper_change** (boolean) — Optional  
  Whether the user can change the wallpaper. Default: true

- **is_below_hdpi_wall_modified** (boolean) — Optional  
  Whether the sub-HDPI wallpaper has been modified in this request

- **is_above_hdpi_wall_modified** (boolean) — Optional  
  Whether the HDPI wallpaper has been modified in this request

- **set_wallpaper_position** (string) — Mandatory  
  Wallpaper display position.  
  `1` = Home Screen  
  `2` = Lock Screen  
  `3` = Both (required)  
  Default: `3`

## Sample Request

### cURL

```bash
curl --request PUT \
  --url https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/androidwallpaperpolicy/payloaditems/{payload_id} \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52' \
  --header 'content-type: application/json' \
  --data '{"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/androidwallpaperpolicy/payloaditems/{payload_id}"))
        .header("content-type", "application/json")
        .header("Authorization", "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52")
        .method("PUT", HttpRequest.BodyPublishers.ofString("{\"set_wallpaper_position\":3}"))
        .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 = "{\"set_wallpaper_position\":3}"

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

conn.request("PUT", "/api/v1/mdm/profiles/{profile_id}/payloads/androidwallpaperpolicy/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","value");

response = invokeUrl
[
    url: "https://appDomain/api/v1/mdm/profiles/{profile_id}/payloads/androidwallpaperpolicy/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/androidwallpaperpolicy/payloaditems/{payload_id}' -Method PUT -Headers $headers -ContentType 'application/json' -Body '{"set_wallpaper_position":3}'
```

## Sample Request Body

```json
{
  "below_hdpi_wallpaper_path": "value",
  "allow_wallpaper_change": true,
  "below_hdpi_wallpaper": "value",
  "above_hdpi_wallpaper_path": "value",
  "is_above_hdpi_wall_modified": false,
  "set_wallpaper_position": 3,
  "above_hdpi_wallpaper": "value",
  "is_below_hdpi_wall_modified": false
}
```

## 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)  
  Wallpaper image file for sub-HDPI density devices

- **above_hdpi_wallpaper** (long)  
  Wallpaper image file for HDPI and above density devices

- **allow_wallpaper_change** (boolean)  
  Whether the user can change the wallpaper. Default: true

- **is_below_hdpi_wall_modified** (boolean)  
  Whether the sub-HDPI wallpaper has been modified in this request

- **is_above_hdpi_wall_modified** (boolean)  
  Whether the HDPI wallpaper has been modified in this request

- **set_wallpaper_position** (string)  
  Wallpaper display position.  
  `1` = Home Screen  
  `2` = Lock Screen  
  `3` = Both (required)  
  Default: `3`

## Sample Response: HTTP 200

```json
{
  "payload_id": 9007199254741000,
  "below_hdpi_wallpaper_path": "value",
  "allow_wallpaper_change": true,
  "below_hdpi_wallpaper": "value",
  "above_hdpi_wallpaper_path": "value",
  "is_above_hdpi_wall_modified": false,
  "set_wallpaper_position": 3,
  "above_hdpi_wallpaper": "value",
  "is_below_hdpi_wall_modified": false
}
```

## Possible Response Codes

- **200** — HTTP code

## Rate Limiting

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