Skip to content

Clear Alerts

Deprecation Notice

This route is no longer supported and will be removed in future releases. Please implement/update to update alerts.

Clears the specified alerts. Every supplied alertId must exist and be owned by an organization you have access to, or the request is rejected (404/403).

Verb POST
Endpoint {base-url}/alerts/clear
Max Page Size N/A

Request Body

{
  "routeFilter": {
    "alertIds": [36578, 36579]
  }
}

Filters Honored

Note

All changes in this request are atomic. If any item fails, the entire batch is rolled back and no changes are made.

Returns

On Success

204 - No content

Response Body

// 204 - No Content

On Error

HTTP Code Error Code Definition
400 ALREADY_CLEARED One or more of the alerts you wanted to clear are already cleared.
403 DATA_ACCESS_VIOLATION One or more alertIds reference an alert in an organization you do not have access to.
404 MISSING_RECORD One or more alertIds do not exist.