Retrieves a summary overview of the specified 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

Returns the summary overview of the specified announcement collection, including the message text, deployment status, target count, and schedule window.

Request URL

https://{serverurl}/dcapi/tools/announcement/{collectionId}/details

Scope

DesktopCentralCloud.Tools.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory
application/jsonapplication/jsonCopied!

- Path Parameters

collectionIdstringMandatory

The unique identifier of the system tools collection

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url https://appdomains/dcapi/tools/announcement/{collectionId}/details \
  --header 'Accept: application/json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52'

Response Parameters

- HTTP code 200

Response Body - application/json
JSON Object
Hide Sub-Attributes
collectionIdlong

Announcement collection unique identifier

labelstring

Announcement display label

statusstring

Deployment status: Active, Suspended, Completed

targetCountinteger

Number of target computers or users

startTimelong

Scheduled start time (epoch)

endTimelong

Scheduled end time (epoch)

messageSummarystring

Truncated announcement message preview

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Copied!
  {
    "messageSummary": "System maintenance scheduled tonight.",
    "startTime": 1711400000000,
    "label": "Maintenance Window Notice",
    "endTime": 1711436000000,
    "collectionId": 7,
    "targetCount": 40,
    "status": "Active"
  }
                
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.