Skip to main content
Reset an agreement's checks and alerts

Authorizations

Authorization
string
header
required

Personal API key. Send X-Organization-Id. The required cumulative level is listed in x-watchdog-permission.

Headers

X-Organization-Id
string

Required for personal API keys. Target one organization you have access to. Migrated keys may omit it to use their original organization. For Clerk sessions, it must match the active organization.

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