Skip to main content
Create a claim

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.

Body

application/json
agreement_id
string<uuid>
required
title
string
required
Required string length: 1 - 200
alerts
object

Alerts to add in the same transaction, with the rules of POST /v1/claims/{id}/alerts. With alert_ids, an alert that does not qualify fails the request and no claim is created.

Response

The created claim with its current counts and amounts.

id
string<uuid>
required
agreement
object
required
suppliers
object[]
required
title
string | null
required
status
enum<string>
required
Available options:
pending,
in_progress,
completed,
cancelled
creator
object | null
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
refund_summary
object
required
summary
object
required