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

To modify Ios Wallpaper policy payload item

## Endpoints

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

## Request URL

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

## Scope

`MDMDeviceMgmt.UPDATE`

## Header

`Authorization: d92d4xxxxxxxxxxxxx15f52`

## Request Parameters

### Request Headers

- **Content-Type** `string` — **Mandatory** — `application/json`
- **Accept** `string` — **Mandatory** — `application/json`

### Path Parameters

- **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/ios-get-wallpaper-payload-ios.html) response.

### Request Body

`application/json`

JSON Object:

- **below_hdpi_wallpaper** `long` — Optional

  Below Hdpi Wallpaper. Use the fileID from the [File Upload API](https://www.manageengine.com/products/desktop-central/help/api/onpremise/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/products/desktop-central/help/api/onpremise/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/products/desktop-central/help/api/onpremise/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
curl --request PUT \
  --url https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/ioswallpaperpolicy/payloaditems/{payload_id} \
  --header 'Accept: application/json' \
  --header 'Authorization:  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                     }"'
```

## Sample Request Body

Modify Wallpaper payload item

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

Response Body — `application/json`

JSON Object:

- **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/products/desktop-central/help/api/onpremise/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/products/desktop-central/help/api/onpremise/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/products/desktop-central/help/api/onpremise/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

## Possible Response Codes

- **200** `HTTP code`

## Sample Response: HTTP 200

Wallpaper payload item successfully modified

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

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