# Add a new Wallpaper payload configuration to an existing profile

Create Android Wallpaper payload

## Endpoint

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

## Request

### Request URL

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

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

JSON Object:

| Attribute | Type | Required | Description |
|---|---|---|---|
| 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
curl --request POST \
  --url https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/androidwallpaperpolicy \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '{"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}'
```

### Sample Request Body

Add Wallpaper payload to the profile

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

### Response Parameters

#### HTTP Code 200

Response Body: `application/json`

JSON Object:

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

### Possible Response Codes

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

### Sample Response: HTTP 200

Wallpaper payload successfully added

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

## Rate Limit

![](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.