Skip to main content
Preview adding 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.

Body

application/json
alerts
object
required

The alerts object POST /v1/claims takes: a selection, move_from_open_claims and accept_alerts.

agreement_id
string<uuid>

Preview a new claim of this agreement: what POST /v1/claims would add.

claim_id
string<uuid>

Preview this pending or in-progress claim: what POST /v1/alerts/update with claim_id would add (accept_alerts standing for verdict accepted).

Response

The alerts that would join, by verdict, and those left out, by reason.

joining_count
integer
required

Selected alerts the request would add to the claim or move into it: the changed_count a filter would return.

Required range: x >= 0
joining_by_verdict
object
required

The joining alerts by their current verdict. A claim asks only for accepted ones; accept_alerts (or verdict accepted) confirms the others, false alarms included. The app adds all but the false alarms.

already_in_claim_count
integer
required

Selected alerts already in claim_id, which stay in it. Always 0 with agreement_id.

Required range: x >= 0
left_out
object
required

Selected alerts that would not join, each under the first reason that applies, in this order. The command leaves them out of a filter and refuses alert_ids that name any of them (409).

joining_alert_ids
object
required

The joining alerts by verdict, in ID order. Send the ones you want as alert_ids to add exactly what was previewed.