Alerts

Dismiss an alert

Marks an alert as dismissed. There is no endpoint to reopen a dismissed alert.

This endpoint is idempotent: calling it on an already-dismissed alert returns the same 200 response without side effects.

put/api/v1/alerts/{id}/dismiss

Request

  • Base URL: https://api.dmarc-examiner.com
  • URL: https://api.dmarc-examiner.com/api/v1/alerts/{id}/dismiss
  • Auth: API key in header X-API-Key

Path parameters

idstring uuid required

Alert UUID.

Response

Alert dismissed

idstring uuid required
statusstring required
messagestring required

Example response

{
  "status": "dismissed",
  "message": "Alert dismissed"
}

Changes

No recorded changes to this operation across all 1 revision of this API.