Skip to main content
POST
/
referrals
/
{id}
/
begin-closing
Error
A valid request URL is required to generate request examples
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "referenceNumber": "ABC-0001-R1",
    "closureReason": "<string>",
    "referringFirmId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "referentFirmId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "settlementAmount": 123,
    "attorneyFees": 123,
    "projectedSettlementAmount": 123,
    "estimatedDateOfResolution": "2023-12-25",
    "estimatedDistributionDate": "2023-12-25",
    "statuteOfLimitationsExpiration": "2023-12-25",
    "clientFeeAgreementPercentage": 123,
    "sendingFirmPercentage": 123,
    "leadAttorneyName": "<string>",
    "phase": "<string>",
    "notes": "<string>",
    "isRetainerSigned": false,
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  },
  "meta": {
    "requestId": "req_f2dbe1d3f6ad4a7bb5b4c9f2",
    "timestamp": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
X-API-Key
string
header
required

Public API key (format cxp_<tier>_<body>, tier = ro|std|full). Scoped to a single firm. The firm must have public_api in allowedIntegrations.

Path Parameters

​
id
string<uuid>
required

Referral UUID

Body

application/json
​
closingStatus
string
required

ClosingStatus enum value (e.g. won_settled, lost, no_longer_pursuing)

Example:

"won_settled"

​
reason
string

Optional free-text note. Written to the status_updates row generated by the transition. CR/LF characters are stripped server-side.

Required string length: 1 - 5000
Example:

"Settlement reached and client approved disbursement."

​
closureReason
string

Optional formal closure reason. Written to the case record's closureReason column. Required at the service layer when closingStatus is no_longer_pursuing. CR/LF characters are stripped server-side.

Required string length: 1 - 5000
Example:

"Mediated settlement; both parties signed release."

​
settlementAmount
number<float> | null

Total settlement amount in USD

​
clientFeeAgreementPercentage
number<float> | null

Client fee agreement percentage as a decimal (0–1)

Required range: 0 <= x <= 1
​
attorneyFees
number<float> | null

Attorney fees in USD

​
estimatedDistributionDate
string<date> | null

Estimated date funds will be distributed (ISO date)

Response

Referral transitioned to CLOSING

​
data
object
required
​
meta
object
required