Skip to main content
Dismiss selected alerts

Authorizations

Authorization
string
header
required

Personal API key sent as a bearer token, together with X-Organization-Id. The key must have at least the access level the endpoint requires (read, write or admin).

Headers

X-Organization-Id
string

The organization to act in. Required for personal API keys; list the organizations you can access with GET /v1/organizations.

Body

application/json
alert_ids
string<uuid>[]

Alerts to change. If any is unknown (404) or cannot be changed (409), nothing changes.

Required array length: 1 - 5000 elements
filter
object

Change every alert matching these filters: the listAlerts filters, given as JSON lists and booleans. Matching alerts that cannot be changed are skipped and counted in skipped_count.

excluded_alert_ids
string<uuid>[]

Alerts to leave out of a filter selection. Only valid with filter.

Required array length: 1 - 5000 elements
category
enum<string> | null

wrong_alert: the deviation does not exist, for example the charge is allowed or was agreed separately. valid_not_actioning: the alert is right but will not be pursued, for example too small. already_handled: the alert is right but already fixed, credited or corrected. duplicate_covered: another alert, claim or case already covers it. other: explain in note.

Available options:
wrong_alert,
valid_not_actioning,
already_handled,
duplicate_covered,
other,
null
note
string | null

Why the alerts are dismissed, in your own words.

Maximum string length: 2000
suggest_instructions
boolean

Whether a category or note should start a run that suggests changes to the agreement's instructions. Defaults to true. Send false when the note explains a cleanup rather than a rule for future checks.

Response

How many alerts changed and how many matching alerts were left alone.

changed_count
integer
required

Alerts the command changed. Alerts already in the requested state are not counted.

skipped_count
integer
required

Matching alerts a filter left unchanged. Always 0 for alert_ids.