Suspends an active announcement, halting its delivery to target computers Suspends an active announcement, halting its delivery to target computers. Accepts an optional 'orgin' query parameter to indicate the source of the suspension action.
Request URL https://{server-hostname}:8383/dcapi/tools/announcement/{collectionId}/suspend
Scope
Header Authorization: d92d4xxxxxxxxxxxxx15f52
Request Parameters - Request Headers - Path Parameters collectionId string Mandatory
The unique identifier of the system tools collection
Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request PUT \
--url https://appdomain/dcapi/tools/announcement/{collectionId}/suspend \
--header 'Accept: application/collectionSuspendStatus.v1+json' \
--header 'Authorization: d92d4xxxxxxxxxxxxx15f52'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/dcapi/tools/announcement/{collectionId}/suspend"))
.header("Accept", "application/collectionSuspendStatus.v1+json")
.header("Authorization", " d92d4xxxxxxxxxxxxx15f52")
.method("PUT", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
}
}
import http.client
conn = http.client.HTTPSConnection("appdomain")
headers = {
'Accept': "application/collectionSuspendStatus.v1+json",
'Authorization': " d92d4xxxxxxxxxxxxx15f52"
}
conn.request("PUT", "/dcapi/tools/announcement/{collectionId}/suspend", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
headersMap = Map();
headersMap.put("Accept", "application/collectionSuspendStatus.v1+json");
response = invokeUrl
[
url: "https://appDomain/dcapi/tools/announcement/{collectionId}/suspend"
type: PUT
headers: headersMap
connection: connection_name
]
info response;
$headers=@{}
$headers.Add("Accept", "application/collectionSuspendStatus.v1+json")
$headers.Add("Authorization", " d92d4xxxxxxxxxxxxx15f52")
$response = Invoke-WebRequest -Uri 'https://appdomain/dcapi/tools/announcement/{collectionId}/suspend' -Method PUT -Headers $headersResponse Parameters - HTTP code 200 Response Body - application/json Possible Response Codes Sample Response: HTTP 200 {
"status": "success"
}
▼ 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.
© 2026, Zoho Corporation Pvt. Ltd. All Rights Reserved.
© 2026, Zoho Corporation Pvt. Ltd. All Rights Reserved.