Skip to main content
Preview deleting an agreement

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

The deletion impact.

Under an access limit every figure counts only what the caller can see; such a caller can delete only an agreement without claims or alerts.

claim_count
integer
required

Claims deleted with the agreement.

alert_count
integer
required

Alerts deleted with the agreement, whatever their verdict or claim.

recovery_summary
object | null
required

Recoveries recorded on those claims, which stop counting as recovered. Null under an access limit, which cannot delete an agreement with claims.

completed_claim_count
integer
required

Completed claims. While there is one, deleting the agreement returns 409.

completed_claims
object[]
required

The completed claims, oldest first, at most 100.