Skip to main content
Reset an agreement's checks and 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.

Path Parameters

id
string<uuid>
required

Response

What the reset changed.

deleted_alert_count
integer
required
Required range: x >= 0
kept_alert_count
integer
required

Alerts kept because a claim holds their invoice and agreement pair.

Required range: x >= 0
cancelled_check_count
integer
required

Unfinished checks that were cancelled.

Required range: x >= 0