Returns the full configuration details of the specified announcement, including the message content, schedule (start time, end time, lap time), deployment targets, and current status.
get /dcapi/tools/announcement/{collectionId}
https://{serverurl}/dcapi/tools/announcement/{collectionId}
Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
The unique identifier of the system tools collection
curl --request GET \
--url https://appdomains/dcapi/tools/announcement/{collectionId} \
--header 'Accept: application/json' \
--header 'Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52'Announcement collection unique identifier
Announcement display label
Deployment status
Target scope: Computer or User
Target configuration with targetType, targetValue, and envType
Array containing announcement toolDetails with message, schedule, and timing
{
"configDetails": [
{
"toolDetails": {
"repeatFrequency": 1,
"repeatDuration": 600,
"startTime": "22:00",
"endTime": "02:00",
"message": "System maintenance scheduled tonight from 11 PM to 2 AM."
}
}
],
"label": "Maintenance Window Notice",
"configType": "Computer",
"collectionId": 7,
"targetDetails": {
"envType": 0,
"targetValue": "Engineering",
"targetType": "CustomGroup"
},
"status": "Active"
}
![]()
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.
© 2026, Zoho Corporation Pvt. Ltd. All Rights Reserved.