Skip to main content
Add alerts to a claim

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.

Path Parameters

id
string<uuid>
required

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
move_from_open_claims
boolean

Move alerts from pending or in-progress claims in the same transaction. Completed and cancelled claims are not moved.

claim_resolved
boolean

true also accepts alerts that were dismissed, so the whole selection is claimed. Credit is always kept.

Response

How many alerts changed and how many matching alerts were skipped.

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.