Modify the configuration of a Lock Screen Message payload item within a profile

Open in ChatGPT Open in ChatGPT to ask questions about this page
Open in Claude Open in Claude to ask questions about this page
Copy as MarkdownCopy this page as markdown to use with AI assistants
View as Markdown Open this page as markdown in a new tab

To modify Ios Lock Screen Message payload item

Request URL

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

Scope

MDMDeviceMgmt.UPDATECopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

Content-TypestringMandatory
application/jsonapplication/jsonCopied!
AcceptstringMandatory
application/jsonapplication/jsonCopied!

- Path Parameters

profile_idstringMandatory

Unique identifier of the profile. Obtain from the Create Profile or Get Profiles response

payload_idstringMandatory

Unique identifier of the payload item. Obtain from the Get Payload Item IDs response

- Request Body

application/json
JSON Object
Hide Sub-Attributes
wallpaper_typeintegerMandatory

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

bg_colourstringOptional

Bg Colour

wallpaperstringOptional

Wallpaper. Use the fileID from the File Upload API response

messagesJSON ArrayMandatory

List of lock screen messages

Show Sub-Attributes
JSON Object
Show Sub-Attributes
messagestringOptional

Message text to display on lock screen

text_colourstringOptional

Text colour hex code (e.g. #FFFFFF)

offset_positionintegerOptional

Vertical offset position of the message

wallpaper_modifiedbooleanOptional

Wallpaper Modified

orientationintegerOptional

Orientation. Default: 1

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request PUT \
  --url https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/ioslockscreenmessage/payloaditems/{payload_id} \
  --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

Modify Lock Screen Message payload item

Copied!
  "{                     \"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                     }"
                
Show full

Response Parameters

- HTTP code 200

Response Body - application/json
JSON Object
Hide Sub-Attributes
payload_idlong

Unique identifier of the payload item

wallpaper_typeinteger

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

bg_colourstring

Bg Colour

wallpaperlong

Wallpaper. Use the fileID from the File Upload API response

messagesJSON Array

List of lock screen messages

Show Sub-Attributes
JSON Object
Show Sub-Attributes
messagestring

Message text to display on lock screen

text_colourstring

Text colour hex code (e.g. #FFFFFF)

offset_positioninteger

Vertical offset position of the message

wallpaper_modifiedboolean

Wallpaper Modified

orientationinteger

Orientation. Default: 1

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Lock Screen Message payload item successfully modified

Copied!
  "{                         \"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                         }"
                
Show full

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.