Create a new announcement

Create the individual Announcement details

Endpoints

post /api/v1/mdm/announcements

Copy full URL

Request URL

https://{server-hostname}:8383/api/v1/mdm/announcements

Scope

MDMDeviceMgmt.CREATECopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

Content-TypestringMandatory

application/jsonCopied!

AcceptstringMandatory

application/jsonCopied!

- Request Body

application/json

JSON Object

Hide Sub-Attributes

announcement_namestringMandatory

Name/title of the announcement. Must be unique within the customer

announcement_formatintegerOptional

Display format for the announcement (e.g., 1)

announcement_detailJSON ObjectOptional

Nested object containing message details including title, content, icon, and acknowledgement settings

Show Sub-Attributes

titlestringMandatory

Title of the announcement displayed on the device

title_colorstringOptional

Hex color code for the title (e.g., #ffffff)

nbar_iconstringOptional

Path to the notification bar icon image (e.g., /images/announcement/nbaricon/info.png)

nbar_messagestringOptional

Short message shown in the device notification bar

detail_messagestringMandatory

Full HTML message content displayed in the app

needs_acknowledgementbooleanOptional

Whether the device user must acknowledge the announcement

ack_buttonstringOptional

Button text for acknowledgement (e.g., Got It). Required when needs_acknowledgement is true

Sample Request

Curl

Java

Python

Deluge

PowerShell

Copied!

curl --request POST \
  --url https://appdomain/api/v1/mdm/announcements \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '{"announcement_name":"Test announcement","announcement_format":1,"announcement_detail":{"ack_button":"Got It","nbar_message":"You have a new announcement","title_color":"#ffffff","nbar_icon":"/images/announcement/nbaricon/info.png","needs_acknowledgement":true,"detail_message":"<p>Test announcement message</p>","title":"Test announcement"}}'

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/announcements"))
        .header("Content-Type", "application/json")
        .header("Accept", "application/json")
        .header("Authorization", " d92d4xxxxxxxxxxxxx15f52")
        .method("POST", HttpRequest.BodyPublishers.ofString("{\"announcement_name\":\"Test announcement\",\"announcement_format\":1,\"announcement_detail\":{\"ack_button\":\"Got It\",\"nbar_message\":\"You have a new announcement\",\"title_color\":\"#ffffff\",\"nbar_icon\":\"/images/announcement/nbaricon/info.png\",\"needs_acknowledgement\":true,\"detail_message\":\"Test announcement message\",\"title\":\"Test announcement\"}}"))
        .build();
    HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.body());
  
  }
}

import http.client

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

payload = "{\"announcement_name\":\"Test announcement\",\"announcement_format\":1,\"announcement_detail\":{\"ack_button\":\"Got It\",\"nbar_message\":\"You have a new announcement\",\"title_color\":\"#ffffff\",\"nbar_icon\":\"/images/announcement/nbaricon/info.png\",\"needs_acknowledgement\":true,\"detail_message\":\"Test announcement message\",\"title\":\"Test announcement\"}}"

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

conn.request("POST", "/api/v1/mdm/announcements", 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("announcement_name","value");
    data.put("announcement_format","1");
    data_announcement_detail=Map();
    data_announcement_detail.put("title","value");
    data_announcement_detail.put("title_color","value");
    data_announcement_detail.put("nbar_icon","value");
    data_announcement_detail.put("nbar_message","value");
    data_announcement_detail.put("detail_message","value");
    data_announcement_detail.put("needs_acknowledgement",true);
    data_announcement_detail.put("ack_button","value");
    data.put("announcement_detail",data_announcement_detail);

    response = invokeUrl
    [
        url: "https://appDomain/api/v1/mdm/announcements"
        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/announcements' -Method POST -Headers $headers -ContentType 'application/json' -Body '{"announcement_name":"Test announcement","announcement_format":1,"announcement_detail":{"ack_button":"Got It","nbar_message":"You have a new announcement","title_color":"#ffffff","nbar_icon":"/images/announcement/nbaricon/info.png","needs_acknowledgement":true,"detail_message":"Test announcement message
","title":"Test announcement"}}'

Sample Request Body

Create an announcement that requires acknowledgement from devices

Copied!

  {
    "announcement_name": "Test announcement",
    "announcement_format": 1,
    "announcement_detail": {
      "ack_button": "Got It",
      "nbar_message": "You have a new announcement",
      "title_color": "#ffffff",
      "nbar_icon": "/images/announcement/nbaricon/info.png",
      "needs_acknowledgement": true,
      "detail_message": "<p>Test announcement message</p>",
      "title": "Test announcement"
    }
  }

▼ Show full

Create an informational announcement without acknowledgement requirement

Copied!

  {
    "announcement_name": "System Maintenance Notice",
    "announcement_format": 1,
    "announcement_detail": {
      "ack_button": "",
      "nbar_message": "Scheduled maintenance tonight",
      "title_color": "#ff5722",
      "nbar_icon": "/images/announcement/nbaricon/info.png",
      "needs_acknowledgement": false,
      "detail_message": "<p>System will undergo maintenance from 10PM to 2AM</p>",
      "title": "System Maintenance"
    }
  }

▼ Show full

Response Parameters

- HTTP code 200

Response Body - application/json

JSON Object

Hide Sub-Attributes

announcement_idlong

Unique ID representing the newly created announcement

announcement_namestring

Name/title of the announcement

announcement_formatstring

Display format code for the announcement

creation_timestring

Epoch timestamp (milliseconds) when the announcement was created

last_modified_timestring

Epoch timestamp (milliseconds) when the announcement was last modified

created_by_userstring

Username of the admin who created the announcement

last_modified_by_userstring

Username of the admin who last modified the announcement

collection_idstring

Internal collection ID associated with this announcement

profile_idstring

Internal profile ID associated with this announcement

ack_buttonstring

Acknowledgement button text shown on device. Empty string if acknowledgement not required

needs_acknowledgementboolean

Whether the announcement requires acknowledgement from the device user

is_moved_to_trashboolean

Whether the announcement has been soft-deleted

no_of_devices_distributedstring

Number of devices the announcement is distributed to

no_of_groups_distributedstring

Number of groups the announcement is distributed to

prioritystring

Priority level of the announcement

last_distributed_timestring

Epoch timestamp of the last distribution. -1 if never distributed

announcement_detailJSON Object

Nested object containing announcement message content details

Show Sub-Attributes

titlestring

Title of the announcement

title_colorstring

Hex color code for the title text (e.g., #ffffff)

nbar_iconstring

Path to the notification bar icon image

nbar_messagestring

Short message displayed in the device notification bar

detail_messagestring

Full HTML message content displayed in the app

announcement_img_idstring

Image ID for the notification bar image

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Response after creating an announcement with acknowledgement

Copied!

  {
    "creation_time": "1777342912041",
    "last_modified_time": "1777342912041",
    "announcement_name": "Test announcement",
    "announcement_format": "1",
    "needs_acknowledgement": true,
    "last_modified_by_user": "admin",
    "no_of_devices_distributed": "0",
    "priority": "0",
    "created_by_user": "admin",
    "no_of_groups_distributed": "0",
    "collection_id": "9007199254741063",
    "ack_button": "Got It",
    "last_distributed_time": "-1",
    "is_moved_to_trash": false,
    "profile_id": "9007199254741063",
    "announcement_id": "9007199254740995",
    "announcement_detail": {
      "nbar_message": "You have a new announcement",
      "title_color": "#ffffff",
      "nbar_icon": "/images/announcement/nbaricon/info.png",
      "announcement_img_id": "9007199254740995",
      "detail_message": "<p>Test announcement message</p>",
      "title": "Test announcement"
    }
  }

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