Skip to main content
POST
Close a case

Authorizations

X-API-Key
string
header
required

Public API key: cxp_<hex> (firm-scoped) or cxpp_<hex> (provider-scoped). Required on every request.

Path Parameters

id
string<uuid>
required

Resource UUID

Body

application/json
closingStatus
string
required
closingNotes
string
settlementAmount
number
Required range: x >= 0
clientFeeAgreementPercentage
number
Required range: 0 <= x <= 1
attorneyFees
number
Required range: x >= 0
closureReason
string

Response

Closed case

data
object
required

A referral as seen by either party (the public API calls a referral a "case" on this path). Base-case fields are flattened onto the referral. Client fields are masked for SENT-status cases viewed by the receiving firm until acknowledged.

meta
object
required