Skip to main content
PATCH
/
received-referrals
/
{id}
Error
A valid request URL is required to generate request examples
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "baseCaseId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "referenceNumber": "<string>",
    "cmsId": "<string>",
    "sequenceNumber": 123,
    "status": "<string>",
    "closingStatus": "<string>",
    "closureReason": "<string>",
    "sendingFirmId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "sendingFirmName": "<string>",
    "receivingFirmId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "title": "<string>",
    "description": "<string>",
    "caseType": "<string>",
    "jurisdiction": "<string>",
    "county": "<string>",
    "clientFirstName": "<string>",
    "clientLastName": "<string>",
    "clientEmail": "<string>",
    "clientPhone": "<string>",
    "clientDateOfBirth": "2023-11-07T05:31:56Z",
    "incidentDate": "2023-11-07T05:31:56Z",
    "notes": "<string>",
    "settlementAmount": 123,
    "attorneyFees": 123,
    "leadAttorneyName": "<string>",
    "clientFeeAgreementPercentage": 123,
    "sendingFirmPercentage": 123,
    "projectedSettlementAmount": 123,
    "estimatedDateOfResolution": "2023-11-07T05:31:56Z",
    "estimatedDistributionDate": "2023-11-07T05:31:56Z",
    "statuteOfLimitationsExpiration": "2023-11-07T05:31:56Z",
    "phase": "<string>",
    "isRetainerSigned": true,
    "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 (starts with cxp_). Required on every request.

Path Parameters

​
id
string
required

UUID, reference number, or CMS ID

Body

application/json

At least one field must be provided

​
leadAttorneyName
string | null
Maximum string length: 500
​
statuteOfLimitationsExpiration
string<date-time> | null
​
clientFeeAgreementPercentage
number | null
Required range: 0 <= x <= 1
​
attorneyFees
number | null
Required range: x >= 0
​
estimatedDateOfResolution
string<date-time> | null
​
estimatedDistributionDate
string<date-time> | null
​
projectedSettlementAmount
number | null
Required range: x >= 0
​
phase
string | null
Maximum string length: 200
​
sendingFirmPercentage
number | null
Required range: 0 <= x <= 100
​
settlementAmount
number | null
Required range: x >= 0
​
notes
string | null
Maximum string length: 10000

Response

Updated referral detail

​
data
object
​
meta
object