Skip to main content
POST
/
referrals
/
{id}
/
send
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
​
referentFirmId
string<uuid>
required

UUID of the receiving (referent) firm

​
notes
string

Optional internal notes for this referral.

Maximum string length: 10000
​
reason
string

Optional reason for sending. When provided, it is appended to the status-update message and captured in the audit log. CR/LF characters are stripped server-side.

Maximum string length: 5000

Response

Referral sent

​
data
object
required
​
meta
object
required