# Add a new Wallpaper payload configuration to an existing profile

To create Ios Wallpaper policy

## Endpoint

**POST** `/api/v1/mdm/profiles/{profile_id}/payloads/ioswallpaperpolicy`

## Request URL

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

## Scope

`MDMDeviceMgmt.CREATE`

## Header

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

### Request Body

`application/json`

| Attribute | Type | Required | Description |
|---|---|---|---|
| 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 POST \
  --url https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/ioswallpaperpolicy \
  --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

Add Wallpaper payload to the profile

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

| Attribute | Type | Description |
|---|---|---|
| payload_id | long | Unique identifier for the created 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 |

## Sample Response: HTTP 200

Wallpaper payload successfully added

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

## Possible Response Codes

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

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

**Duration:** 1 minute | **Threshold:** 30 | **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.