Suspends an active announcement, halting its delivery to target computers

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

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

Tools.UPDATECopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory
application/collectionSuspendStatus.v1+jsonapplication/collectionSuspendStatus.v1+jsonCopied!

- Path Parameters

collectionIdstringMandatory

The unique identifier of the system tools collection

Sample Request

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'

Response Parameters

- HTTP code 200

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

Result of the operation: success or failure

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Copied!
  {
    "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.