Skip to main content
POST
Begin closing

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
enum<string>
required

Outcome type (case-insensitive)

Available options:
won_settled,
lost,
no_longer_pursuing
reason
string

Optional note recorded on the resulting status-history entry. Line breaks are collapsed to spaces.

Required string length: 1 - 5000
closureReason
string

Narrative closure reason stored on the referral

Required string length: 1 - 5000
settlementAmount
number

Final settlement amount in dollars; must be greater than zero when supplied

Required range: 0 < x <= 1000000000
clientFeeAgreementPercentage
number

Client fee agreement as a FRACTION of the settlement, 0–1 (0.3333 = 33.33%). Not a whole percent — contrast with sendingFirmPercentage.

Required range: 0 <= x <= 1
attorneyFees
number

Attorney fees in dollars

Required range: 0 <= x <= 1000000000
estimatedDistributionDate
string<date> | null

YYYY-MM-DD

payoutType
enum<string>
Available options:
lump_sum,
structured,
hybrid,
other

Response

Updated referral

data
object
required

A referral as seen by either party. Referral-level fields only (financials, resolution, workflow) — client and case details live on the parent case. When the caller is the receiving firm and the referral is still SENT (not yet acknowledged), leadAttorneyName, warmTransferUnsuccessfulReason, warmTransferUnsuccessfulReasonType and notes are null and customFields is empty.

meta
object
required