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

Create Android Lock screen message payload

Endpoints

post /api/v1/mdm/profiles/{profile_id}/payloads/androidlockscreenmessage

Copy full URL

Request URL

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

Scope

MDMDeviceMgmt.CREATECopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

Content-TypestringMandatory

application/jsonCopied!

AcceptstringMandatory

application/jsonCopied!

- Path Parameters

profile_idstringMandatory

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

- Request Body

application/json

JSON Object

Hide Sub-Attributes

wallpaper_typeintegerMandatory

Wallpaper type. 1 = Custom color wallpaper, 2 = Uploaded image wallpaper, 3 = Uploaded image with separate landscape image (required)

bg_colourstringOptional

Background hex color code for custom wallpaper (applies when wallpaper_type=1, e.g., #FFFFFF)

wallpaperlongOptional

Wallpaper image file ID (applies when wallpaper_type=2 or 3)

landscape_wallpaperlongOptional

Landscape wallpaper image file ID (applies when wallpaper_type=3)

messagesJSON ArrayMandatory

Array of messages displayed on the lock screen (required, max 5 messages)

Show Sub-Attributes

JSON Array

Lock screen message entry

Show Sub-Attributes

JSON Object

Show Sub-Attributes

messagestringMandatory

Lock screen message text (required, max 100 characters)

text_colourstringMandatory

Message text color as a hex color code (required, e.g., #FF0000)

orderintegerOptional

Display order of this message on the lock screen

wallpaper_modifiedbooleanOptional

Whether the wallpaper image has been modified

landscape_wallpaper_modifiedbooleanOptional

Whether the landscape wallpaper image has been modified

orientationintegerOptional

Lock screen message orientation. 0 = User Controlled, 1 = Portrait, 2 = Landscape. Default: 1

asset_tag_show_optionintegerOptional

Asset tag display location. 0 = Lock screen, 1 = Kiosk launcher, 2 = Lock screen and kiosk launcher. Default: 0

asset_tag_text_sizeintegerOptional

Asset tag text size. 1 = Small, 2 = Medium, 3 = Large. Default: 1

Sample Request

Curl

Java

Python

Deluge

PowerShell

Copied!

curl --request POST \
  --url https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/androidlockscreenmessage \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '{"orientation":1,"wallpaper":9007199254741080,"wallpaper_modified":false,"messages":[{"text_colour":"#000000","message":"This device belongs to Example Corp"}],"wallpaper_type":2,"landscape_wallpaper":0,"bg_colour":"#ffffff","landscape_wallpaper_modified":false}'

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.io.IOException;
import java.net.http.HttpTimeoutException;

public class Main {
  public static void main(String[] args) {

    HttpRequest request = HttpRequest.newBuilder()
        .uri(URI.create("https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/androidlockscreenmessage"))
        .header("Content-Type", "application/json")
        .header("Accept", "application/json")
        .header("Authorization", " d92d4xxxxxxxxxxxxx15f52")
        .method("POST", HttpRequest.BodyPublishers.ofString("{\"orientation\":1,\"wallpaper\":9007199254741080,\"wallpaper_modified\":false,\"messages\":[{\"text_colour\":\"#000000\",\"message\":\"This device belongs to Example Corp\"}],\"wallpaper_type\":2,\"landscape_wallpaper\":0,\"bg_colour\":\"#ffffff\",\"landscape_wallpaper_modified\":false}"))
        .build();
    HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.body());
  
  }
}

import http.client

conn = http.client.HTTPSConnection("appdomain")

payload = "{\"orientation\":1,\"wallpaper\":9007199254741080,\"wallpaper_modified\":false,\"messages\":[{\"text_colour\":\"#000000\",\"message\":\"This device belongs to Example Corp\"}],\"wallpaper_type\":2,\"landscape_wallpaper\":0,\"bg_colour\":\"#ffffff\",\"landscape_wallpaper_modified\":false}"

headers = {
    'Content-Type': "application/json",
    'Accept': "application/json",
    'Authorization': " d92d4xxxxxxxxxxxxx15f52"
    }

conn.request("POST", "/api/v1/mdm/profiles/{profile_id}/payloads/androidlockscreenmessage", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))


    headersMap = Map();
    headersMap.put("Content-Type", "application/json");
    headersMap.put("Accept", "application/json");

    data=Map();
    data.put("wallpaper_type","1");
    data.put("bg_colour","value");
    data.put("wallpaper","1");
    data.put("landscape_wallpaper","1");
    data_messages=List();
    data_messages_item1=List();
    data_messages_item1_item1=Map();
    data_messages_item1_item1.put("message","value");
    data_messages_item1_item1.put("text_colour","value");
    data_messages_item1_item1.put("order","1");
    data_messages_item1.add(data_messages_item1_item1);
    data_messages.add(data_messages_item1);
    data.put("messages",data_messages);
    data.put("wallpaper_modified",true);
    data.put("landscape_wallpaper_modified",true);
    data.put("orientation","1");
    data.put("asset_tag_show_option","1");
    data.put("asset_tag_text_size","1");

    response = invokeUrl
    [
        url: "https://appDomain/api/v1/mdm/profiles/{profile_id}/payloads/androidlockscreenmessage"
        type: POST
        headers: headersMap
        body: data
        connection: connection_name
    ]

    info response;

$headers=@{}
$headers.Add("Content-Type", "application/json")
$headers.Add("Accept", "application/json")
$headers.Add("Authorization", " d92d4xxxxxxxxxxxxx15f52")
$response = Invoke-WebRequest -Uri 'https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/androidlockscreenmessage' -Method POST -Headers $headers -ContentType 'application/json' -Body '{"orientation":1,"wallpaper":9007199254741080,"wallpaper_modified":false,"messages":[{"text_colour":"#000000","message":"This device belongs to Example Corp"}],"wallpaper_type":2,"landscape_wallpaper":0,"bg_colour":"#ffffff","landscape_wallpaper_modified":false}'

Sample Request Body

Add Lock Screen Message payload to the profile

Copied!

  {
    "orientation": 1,
    "wallpaper": 9007199254741080,
    "wallpaper_modified": false,
    "messages": [
      {
        "text_colour": "#000000",
        "message": "This device belongs to Example Corp"
      }
    ],
    "wallpaper_type": 2,
    "landscape_wallpaper": 0,
    "bg_colour": "#ffffff",
    "landscape_wallpaper_modified": false
  }

▼ Show full

Response Parameters

- HTTP code 200

Response Body - application/json

JSON Object

Hide Sub-Attributes

payload_idlong

Unique identifier for the created payload item

wallpaper_typeinteger

Wallpaper type. 1 = Custom color wallpaper, 2 = Uploaded image wallpaper, 3 = Uploaded image with separate landscape image (required)

bg_colourstring

Background hex color code for custom wallpaper (applies when wallpaper_type=1, e.g., #FFFFFF)

wallpaperlong

Wallpaper image file ID (applies when wallpaper_type=2 or 3)

landscape_wallpaperlong

Landscape wallpaper image file ID (applies when wallpaper_type=3)

messagesJSON Array

Array of messages displayed on the lock screen (required, max 5 messages)

Show Sub-Attributes

JSON Array

Lock screen message entry

Show Sub-Attributes

JSON Object

Show Sub-Attributes

messagestring

Lock screen message text (required, max 100 characters)

text_colourstring

Message text color as a hex color code (required, e.g., #FF0000)

orderinteger

Display order of this message on the lock screen

wallpaper_modifiedboolean

Whether the wallpaper image has been modified

landscape_wallpaper_modifiedboolean

Whether the landscape wallpaper image has been modified

orientationinteger

Lock screen message orientation. 0 = User Controlled, 1 = Portrait, 2 = Landscape. Default: 1

asset_tag_show_optioninteger

Asset tag display location. 0 = Lock screen, 1 = Kiosk launcher, 2 = Lock screen and kiosk launcher. Default: 0

asset_tag_text_sizeinteger

Asset tag text size. 1 = Small, 2 = Medium, 3 = Large. Default: 1

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Lock Screen Message payload successfully added

Copied!

  {
    "payload_id": 9007199254741000,
    "orientation": 1,
    "wallpaper": 9007199254741080,
    "wallpaper_modified": false,
    "messages": [
      {
        "text_colour": "#000000",
        "message": "This device belongs to Example Corp"
      }
    ],
    "wallpaper_type": 2,
    "landscape_wallpaper": 0,
    "bg_colour": "#ffffff",
    "landscape_wallpaper_modified": false
  }

▼ Show full

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.