Update an existing announcement

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

Update the individual Announcement details

Request URL

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

Scope

MDMDeviceMgmt.UPDATECopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

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

- Path Parameters

announcement_idstringMandatory

Unique identifier of the announcement. Obtain from the Create Announcement or Get Announcements response

- 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 PUT \
  --url https://appdomain/api/v1/mdm/announcements/{announcement_id} \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '{"announcement_name":"Updated Test Announcement","announcement_format":1,"announcement_detail":{"ack_button":"Got It","nbar_message":"Updated notification","title_color":"#ffffff","nbar_icon":"/images/announcement/nbaricon/info.png","needs_acknowledgement":true,"detail_message":"<p>Updated announcement content</p>","title":"Updated Test Announcement"}}'

Sample Request Body

Update announcement content. Full replacement — all required fields must be provided. Updated content is auto-redistributed

Copied!
  {
    "announcement_name": "Updated Test Announcement",
    "announcement_format": 1,
    "announcement_detail": {
      "ack_button": "Got It",
      "nbar_message": "Updated notification",
      "title_color": "#ffffff",
      "nbar_icon": "/images/announcement/nbaricon/info.png",
      "needs_acknowledgement": true,
      "detail_message": "<p>Updated announcement content</p>",
      "title": "Updated Test Announcement"
    }
  }
                
Show full

Possible Response Codes

204HTTP code

Sample Response: HTTP 204

Copied!
204 No Content
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.