# Add a new Lock Screen Message payload configuration to an existing profile

To create Ios Lock Screen Message

## Endpoints

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

## Request

### Request URL

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

### Scope

`MDMDeviceMgmt.CREATE`

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

#### Request Body

`application/json`

- `JSON Object`
  - **wallpaper_type** `integer` — **Mandatory**

    Wallpaper type for lock screen. Allowed values: 1=Background Color, 2=Uploaded Image

  - **bg_colour** `string` — Optional

    Bg Colour

  - **wallpaper** `long` — Optional

    Wallpaper file id. Use the fileID from the [File Upload API](https://www.manageengine.com/products/desktop-central/help/api/onpremise/files-upload-file-ems.html) response.

  - **messages** `JSON Array` — **Mandatory**

    List of lock screen messages

  - **wallpaper_modified** `boolean` — Optional

    Wallpaper Modified

  - **orientation** `integer` — Optional

    Orientation. Default: 1

### Sample Request

```curl
curl --request POST \
  --url https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/ioslockscreenmessage \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '"{                     \"wallpaper_type\": -1,                     \"bg_colour\": \"value\",                     \"wallpaper\": \"value\",                     \"wallpaper\": \"value\",                     \"messages\": [{\"message\": \"Zylker message\", \"text_colour\": \"#000000\", \"offset_position\": 0}],                     \"wallpaper_modified\": false,                     \"orientation\": 1                     }"'
```

### Sample Request Body

Add Lock Screen Message payload to the profile

```json
"{                     \"wallpaper_type\": -1,                     \"bg_colour\": \"value\",                     \"wallpaper\": \"value\",                     \"wallpaper\": \"value\",                     \"messages\": [{\"message\": \"Zylker message\", \"text_colour\": \"#000000\", \"offset_position\": 0}],                     \"wallpaper_modified\": false,                     \"orientation\": 1                     }"
```

## Response

### Response Parameters

#### HTTP Code 200

Response Body — `application/json`

- `JSON Object`
  - **payload_id** `long`

    Unique identifier for the created payload item

  - **wallpaper_type** `integer`

    Wallpaper type for lock screen. Allowed values: 1=Background Color, 2=Uploaded Image

  - **bg_colour** `string`

    Bg Colour

  - **wallpaper** `long`

    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.

  - **messages** `JSON Array`

    List of lock screen messages

  - **wallpaper_modified** `boolean`

    Wallpaper Modified

  - **orientation** `integer`

    Orientation. Default: 1

### Possible Response Codes

- **200** `HTTP code`

### Sample Response: HTTP 200

Lock Screen Message payload successfully added

```json
"{                         \"payload_id\": 9007199254741001,                         \"wallpaper_type\": -1,                         \"bg_colour\": \"value\",                         \"wallpaper\": \"value\",                         \"wallpaper\": \"value\",                         \"messages\": [{\"message\": \"Zylker message\", \"text_colour\": \"#000000\", \"offset_position\": 0}],                         \"wallpaper_modified\": false,                         \"orientation\": 1                         }"
```

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