Add a new Wallpaper payload configuration to an existing profile

To create Ios Wallpaper policy

Endpoints

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

Copy full URL

Request URL

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

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

below_hdpi_wallpaperlongOptional

Below Hdpi Wallpaper. Use the fileID from the File Upload API response

above_hdpi_wallpaperlongOptional

Above Hdpi Wallpaper. Use the fileID from the File Upload API response

below_hdpi_lock_wallpaperlongOptional

Below Hdpi Lock Wallpaper. Use the fileID from the File Upload API response

is_below_hdpi_wall_modifiedbooleanOptional

Is Below Hdpi Wall Modified

is_above_hdpi_wall_modifiedbooleanOptional

Is Above Hdpi Wall Modified

is_below_hdpi_lock_wall_modifiedbooleanOptional

Is Below Hdpi Lock Wall Modified

set_wallpaper_positionintegerMandatory

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_changebooleanOptional

Allow Wallpaper Change. Default: false

Sample Request

Curl

Java

Python

Deluge

PowerShell

Copied!

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

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/ioswallpaperpolicy"))
        .header("Content-Type", "application/json")
        .header("Accept", "application/json")
        .header("Authorization", " d92d4xxxxxxxxxxxxx15f52")
        .method("POST", HttpRequest.BodyPublishers.ofString("\"{                     \\\"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                     }\""))
        .build();
    HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.body());
  
  }
}

import http.client

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

payload = "\"{                     \\\"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                     }\""

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

conn.request("POST", "/api/v1/mdm/profiles/{profile_id}/payloads/ioswallpaperpolicy", 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("below_hdpi_wallpaper","1");
    data.put("above_hdpi_wallpaper","1");
    data.put("below_hdpi_lock_wallpaper","1");
    data.put("is_below_hdpi_wall_modified",true);
    data.put("is_above_hdpi_wall_modified",true);
    data.put("is_below_hdpi_lock_wall_modified",true);
    data.put("set_wallpaper_position","1");
    data.put("allow_wallpaper_change",true);

    response = invokeUrl
    [
        url: "https://appDomain/api/v1/mdm/profiles/{profile_id}/payloads/ioswallpaperpolicy"
        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/ioswallpaperpolicy' -Method POST -Headers $headers -ContentType 'application/json' -Body '"{                     \"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

Copied!

  "{                     \"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                     }"

▼ 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

below_hdpi_wallpaperlong

Below Hdpi Wallpaper. Use the fileID from the File Upload API response

above_hdpi_wallpaperlong

Above Hdpi Wallpaper. Use the fileID from the File Upload API response

below_hdpi_lock_wallpaperlong

Below Hdpi Lock Wallpaper. Use the fileID from the File Upload API response

is_below_hdpi_wall_modifiedboolean

Is Below Hdpi Wall Modified

is_above_hdpi_wall_modifiedboolean

Is Above Hdpi Wall Modified

is_below_hdpi_lock_wall_modifiedboolean

Is Below Hdpi Lock Wall Modified

set_wallpaper_positioninteger

allow_wallpaper_changeboolean

Allow Wallpaper Change. Default: false

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Wallpaper payload successfully added

Copied!

  "{                         \"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                         }"

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