Add a new App Notification payload configuration to an existing profile

To create Ios App Notification policy

Endpoints

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

Copy full URL

Request URL

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

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

app_notification_settingsJSON ArrayMandatory

List of per-app notification settings

Show Sub-Attributes

JSON Object

Show Sub-Attributes

notifications_enabledbooleanOptional

Whether notifications are enabled for this app. Default: true

badges_enabledbooleanOptional

Whether badge count is shown. Default: true

alert_typeintegerOptional

Alert style. Allowed values: 0=None, 1=Banners (temporary), 2=Alerts (require action)

preview_typeintegerOptional

Notification preview type. Allowed values: 0=Always, 1=When Unlocked, 2=Never

grouping_typeintegerOptional

Notification grouping. Allowed values: 0=Automatic, 1=By App, 2=Off

show_in_notification_centerbooleanOptional

Show in Notification Center. Default: true

show_in_lock_screenbooleanOptional

Show on Lock Screen. Default: true

show_in_car_playbooleanOptional

Show in CarPlay. Default: true

sounds_enabledbooleanOptional

Whether notification sounds are enabled. Default: true

critical_alert_enabledbooleanOptional

Whether critical alerts are enabled. Default: false

appsarrayOptional

List of app IDs (long) for this notification setting. Use the app_group_id from the Apps API response

Sample Request

Curl

Java

Python

Deluge

PowerShell

Copied!

curl --request POST \
  --url https://appdomain/api/v1/mdm/profiles/{profile_id}/payloads/iosappnotificationpolicy \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '{"app_notification_settings":[{"badges_enabled":true,"notifications_enabled":true,"alert_type":1,"apps":[9007199254741072]}]}'

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/iosappnotificationpolicy"))
        .header("Content-Type", "application/json")
        .header("Accept", "application/json")
        .header("Authorization", " d92d4xxxxxxxxxxxxx15f52")
        .method("POST", HttpRequest.BodyPublishers.ofString("{\"app_notification_settings\":[{\"badges_enabled\":true,\"notifications_enabled\":true,\"alert_type\":1,\"apps\":[9007199254741072]}]}"))
        .build();
    HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.body());
  
  }
}

import http.client

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

payload = "{\"app_notification_settings\":[{\"badges_enabled\":true,\"notifications_enabled\":true,\"alert_type\":1,\"apps\":[9007199254741072]}]}"

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

conn.request("POST", "/api/v1/mdm/profiles/{profile_id}/payloads/iosappnotificationpolicy", 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_app_notification_settings=List();
    data_app_notification_settings_item1=Map();
    data_app_notification_settings_item1.put("notifications_enabled",true);
    data_app_notification_settings_item1.put("badges_enabled",true);
    data_app_notification_settings_item1.put("alert_type","1");
    data_app_notification_settings_item1.put("preview_type","1");
    data_app_notification_settings_item1.put("grouping_type","1");
    data_app_notification_settings_item1.put("show_in_notification_center",true);
    data_app_notification_settings_item1.put("show_in_lock_screen",true);
    data_app_notification_settings_item1.put("show_in_car_play",true);
    data_app_notification_settings_item1.put("sounds_enabled",true);
    data_app_notification_settings_item1.put("critical_alert_enabled",true);
    data_app_notification_settings_item1_apps=List();
    data_app_notification_settings_item1.put("apps",data_app_notification_settings_item1_apps);
    data_app_notification_settings.add(data_app_notification_settings_item1);
    data.put("app_notification_settings",data_app_notification_settings);

    response = invokeUrl
    [
        url: "https://appDomain/api/v1/mdm/profiles/{profile_id}/payloads/iosappnotificationpolicy"
        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/iosappnotificationpolicy' -Method POST -Headers $headers -ContentType 'application/json' -Body '{"app_notification_settings":[{"badges_enabled":true,"notifications_enabled":true,"alert_type":1,"apps":[9007199254741072]}]}'

Sample Request Body

Add App Notification payload to the profile

Copied!

  {
    "app_notification_settings": [
      {
        "badges_enabled": true,
        "notifications_enabled": true,
        "alert_type": 1,
        "apps": [
          9007199254741072
        ]
      }
    ]
  }

▼ 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

app_notification_settingsJSON Array

List of per-app notification settings

Show Sub-Attributes

JSON Object

Show Sub-Attributes

notifications_enabledboolean

Whether notifications are enabled for this app. Default: true

badges_enabledboolean

Whether badge count is shown. Default: true

alert_typeinteger

Alert style. Allowed values: 0=None, 1=Banners (temporary), 2=Alerts (require action)

preview_typeinteger

Notification preview type. Allowed values: 0=Always, 1=When Unlocked, 2=Never

grouping_typeinteger

Notification grouping. Allowed values: 0=Automatic, 1=By App, 2=Off

show_in_notification_centerboolean

Show in Notification Center. Default: true

show_in_lock_screenboolean

Show on Lock Screen. Default: true

show_in_car_playboolean

Show in CarPlay. Default: true

sounds_enabledboolean

Whether notification sounds are enabled. Default: true

critical_alert_enabledboolean

Whether critical alerts are enabled. Default: false

appsarray

List of app IDs (long) for this notification setting. Use the app_group_id from the Apps API response

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

App Notification payload successfully added

Copied!

  {
    "payload_id": 9007199254741000,
    "app_notification_settings": [
      {
        "badges_enabled": true,
        "notifications_enabled": true,
        "alert_type": 1,
        "apps": [
          9007199254741072
        ]
      }
    ]
  }

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