Update a received referral
curl --request PATCH \
--url https://api.casexchange.com/api/public/v1/received-referrals/{id} \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"leadAttorneyName": "<string>",
"statuteOfLimitationsExpiration": "2023-12-25",
"clientFeeAgreementPercentage": 0.5,
"attorneyFees": 500000000,
"estimatedDateOfResolution": "2023-12-25",
"estimatedDistributionDate": "2023-12-25",
"projectedSettlementAmount": 500000000,
"phase": "<string>",
"sendingFirmPercentage": 50,
"settlementAmount": 500000000,
"notes": "<string>",
"customFields": [
{
"fieldId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"value": "<string>"
}
]
}
'import requests
url = "https://api.casexchange.com/api/public/v1/received-referrals/{id}"
payload = {
"leadAttorneyName": "<string>",
"statuteOfLimitationsExpiration": "2023-12-25",
"clientFeeAgreementPercentage": 0.5,
"attorneyFees": 500000000,
"estimatedDateOfResolution": "2023-12-25",
"estimatedDistributionDate": "2023-12-25",
"projectedSettlementAmount": 500000000,
"phase": "<string>",
"sendingFirmPercentage": 50,
"settlementAmount": 500000000,
"notes": "<string>",
"customFields": [
{
"fieldId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"value": "<string>"
}
]
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
leadAttorneyName: '<string>',
statuteOfLimitationsExpiration: '2023-12-25',
clientFeeAgreementPercentage: 0.5,
attorneyFees: 500000000,
estimatedDateOfResolution: '2023-12-25',
estimatedDistributionDate: '2023-12-25',
projectedSettlementAmount: 500000000,
phase: '<string>',
sendingFirmPercentage: 50,
settlementAmount: 500000000,
notes: '<string>',
customFields: [{fieldId: '3c90c3cc-0d44-4b50-8888-8dd25736052a', value: '<string>'}]
})
};
fetch('https://api.casexchange.com/api/public/v1/received-referrals/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.casexchange.com/api/public/v1/received-referrals/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'leadAttorneyName' => '<string>',
'statuteOfLimitationsExpiration' => '2023-12-25',
'clientFeeAgreementPercentage' => 0.5,
'attorneyFees' => 500000000,
'estimatedDateOfResolution' => '2023-12-25',
'estimatedDistributionDate' => '2023-12-25',
'projectedSettlementAmount' => 500000000,
'phase' => '<string>',
'sendingFirmPercentage' => 50,
'settlementAmount' => 500000000,
'notes' => '<string>',
'customFields' => [
[
'fieldId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'value' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.casexchange.com/api/public/v1/received-referrals/{id}"
payload := strings.NewReader("{\n \"leadAttorneyName\": \"<string>\",\n \"statuteOfLimitationsExpiration\": \"2023-12-25\",\n \"clientFeeAgreementPercentage\": 0.5,\n \"attorneyFees\": 500000000,\n \"estimatedDateOfResolution\": \"2023-12-25\",\n \"estimatedDistributionDate\": \"2023-12-25\",\n \"projectedSettlementAmount\": 500000000,\n \"phase\": \"<string>\",\n \"sendingFirmPercentage\": 50,\n \"settlementAmount\": 500000000,\n \"notes\": \"<string>\",\n \"customFields\": [\n {\n \"fieldId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"value\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.casexchange.com/api/public/v1/received-referrals/{id}")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"leadAttorneyName\": \"<string>\",\n \"statuteOfLimitationsExpiration\": \"2023-12-25\",\n \"clientFeeAgreementPercentage\": 0.5,\n \"attorneyFees\": 500000000,\n \"estimatedDateOfResolution\": \"2023-12-25\",\n \"estimatedDistributionDate\": \"2023-12-25\",\n \"projectedSettlementAmount\": 500000000,\n \"phase\": \"<string>\",\n \"sendingFirmPercentage\": 50,\n \"settlementAmount\": 500000000,\n \"notes\": \"<string>\",\n \"customFields\": [\n {\n \"fieldId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"value\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.casexchange.com/api/public/v1/received-referrals/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"leadAttorneyName\": \"<string>\",\n \"statuteOfLimitationsExpiration\": \"2023-12-25\",\n \"clientFeeAgreementPercentage\": 0.5,\n \"attorneyFees\": 500000000,\n \"estimatedDateOfResolution\": \"2023-12-25\",\n \"estimatedDistributionDate\": \"2023-12-25\",\n \"projectedSettlementAmount\": 500000000,\n \"phase\": \"<string>\",\n \"sendingFirmPercentage\": 50,\n \"settlementAmount\": 500000000,\n \"notes\": \"<string>\",\n \"customFields\": [\n {\n \"fieldId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"value\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"baseCaseId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"referenceNumber": "<string>",
"cmsId": "<string>",
"status": "draft",
"closingStatus": "won_settled",
"payoutType": "lump_sum",
"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",
"clientAddress1": "<string>",
"clientAddress2": "<string>",
"clientCity": "<string>",
"clientPostalCode": "<string>",
"incidentDate": "2023-11-07T05:31:56Z",
"notes": "<string>",
"settlementAmount": 500000000,
"attorneyFees": 500000000,
"leadAttorneyName": "<string>",
"warmTransferSuccessful": true,
"warmTransferUnsuccessfulReason": "<string>",
"warmTransferUnsuccessfulReasonType": "FIRM_UNABLE_TO_ANSWER",
"clientFeeAgreementPercentage": 0.5,
"sendingFirmPercentage": 50,
"netFeeToSendingFirm": 123,
"netFeeToHandlingFirm": 123,
"resolutionDate": "2023-11-07T05:31:56Z",
"closedDate": "2023-11-07T05:31:56Z",
"sendingFirmPercentageSource": "manual",
"sendingFirmFeeRuleSnapshot": {
"ruleId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"caseTypeName": "<string>",
"jurisdictionCode": "<string>",
"percentage": 123,
"effectiveFrom": "2023-12-25",
"effectiveTo": "2023-12-25",
"resolvedAsOf": "2023-12-25"
},
"feeProvenance": {
"kind": "locked",
"resolvedAsOf": "2023-12-25",
"percentage": 123,
"coverageLapsed": true,
"missingFacts": [
"settlement_amount"
]
},
"projectedSettlementAmount": 500000000,
"estimatedDateOfResolution": "2023-11-07T05:31:56Z",
"estimatedDistributionDate": "2023-11-07T05:31:56Z",
"statuteOfLimitationsExpiration": "2023-11-07T05:31:56Z",
"phase": "<string>",
"isRetainerSigned": true,
"customFields": [
{
"fieldId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"fieldName": "<string>",
"displayName": "<string>",
"fieldType": "<string>",
"value": "<string>"
}
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
},
"meta": {
"requestId": "req_f2dbe1d3f6ad4a7bb5b4c9f2",
"timestamp": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
},
"meta": {
"requestId": "req_f2dbe1d3f6ad4a7bb5b4c9f2",
"timestamp": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
},
"meta": {
"requestId": "req_f2dbe1d3f6ad4a7bb5b4c9f2",
"timestamp": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
},
"meta": {
"requestId": "req_f2dbe1d3f6ad4a7bb5b4c9f2",
"timestamp": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
},
"meta": {
"requestId": "req_f2dbe1d3f6ad4a7bb5b4c9f2",
"timestamp": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
},
"meta": {
"requestId": "req_f2dbe1d3f6ad4a7bb5b4c9f2",
"timestamp": "2023-11-07T05:31:56Z"
}
}Received Referrals
Update a received referral
Partially updates receiver-editable fields on a received referral; only the fields supplied are changed. Unknown fields are rejected and at least one field must be provided. When both are supplied, attorneyFees must not exceed settlementAmount. Custom fields can only be set once the referral is SIGNED or later. Requires a firm-scoped key (admin-global keys receive 403 wrong_scope) and STANDARD tier.
PATCH
/
received-referrals
/
{id}
Update a received referral
curl --request PATCH \
--url https://api.casexchange.com/api/public/v1/received-referrals/{id} \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"leadAttorneyName": "<string>",
"statuteOfLimitationsExpiration": "2023-12-25",
"clientFeeAgreementPercentage": 0.5,
"attorneyFees": 500000000,
"estimatedDateOfResolution": "2023-12-25",
"estimatedDistributionDate": "2023-12-25",
"projectedSettlementAmount": 500000000,
"phase": "<string>",
"sendingFirmPercentage": 50,
"settlementAmount": 500000000,
"notes": "<string>",
"customFields": [
{
"fieldId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"value": "<string>"
}
]
}
'import requests
url = "https://api.casexchange.com/api/public/v1/received-referrals/{id}"
payload = {
"leadAttorneyName": "<string>",
"statuteOfLimitationsExpiration": "2023-12-25",
"clientFeeAgreementPercentage": 0.5,
"attorneyFees": 500000000,
"estimatedDateOfResolution": "2023-12-25",
"estimatedDistributionDate": "2023-12-25",
"projectedSettlementAmount": 500000000,
"phase": "<string>",
"sendingFirmPercentage": 50,
"settlementAmount": 500000000,
"notes": "<string>",
"customFields": [
{
"fieldId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"value": "<string>"
}
]
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
leadAttorneyName: '<string>',
statuteOfLimitationsExpiration: '2023-12-25',
clientFeeAgreementPercentage: 0.5,
attorneyFees: 500000000,
estimatedDateOfResolution: '2023-12-25',
estimatedDistributionDate: '2023-12-25',
projectedSettlementAmount: 500000000,
phase: '<string>',
sendingFirmPercentage: 50,
settlementAmount: 500000000,
notes: '<string>',
customFields: [{fieldId: '3c90c3cc-0d44-4b50-8888-8dd25736052a', value: '<string>'}]
})
};
fetch('https://api.casexchange.com/api/public/v1/received-referrals/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.casexchange.com/api/public/v1/received-referrals/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'leadAttorneyName' => '<string>',
'statuteOfLimitationsExpiration' => '2023-12-25',
'clientFeeAgreementPercentage' => 0.5,
'attorneyFees' => 500000000,
'estimatedDateOfResolution' => '2023-12-25',
'estimatedDistributionDate' => '2023-12-25',
'projectedSettlementAmount' => 500000000,
'phase' => '<string>',
'sendingFirmPercentage' => 50,
'settlementAmount' => 500000000,
'notes' => '<string>',
'customFields' => [
[
'fieldId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'value' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.casexchange.com/api/public/v1/received-referrals/{id}"
payload := strings.NewReader("{\n \"leadAttorneyName\": \"<string>\",\n \"statuteOfLimitationsExpiration\": \"2023-12-25\",\n \"clientFeeAgreementPercentage\": 0.5,\n \"attorneyFees\": 500000000,\n \"estimatedDateOfResolution\": \"2023-12-25\",\n \"estimatedDistributionDate\": \"2023-12-25\",\n \"projectedSettlementAmount\": 500000000,\n \"phase\": \"<string>\",\n \"sendingFirmPercentage\": 50,\n \"settlementAmount\": 500000000,\n \"notes\": \"<string>\",\n \"customFields\": [\n {\n \"fieldId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"value\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.casexchange.com/api/public/v1/received-referrals/{id}")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"leadAttorneyName\": \"<string>\",\n \"statuteOfLimitationsExpiration\": \"2023-12-25\",\n \"clientFeeAgreementPercentage\": 0.5,\n \"attorneyFees\": 500000000,\n \"estimatedDateOfResolution\": \"2023-12-25\",\n \"estimatedDistributionDate\": \"2023-12-25\",\n \"projectedSettlementAmount\": 500000000,\n \"phase\": \"<string>\",\n \"sendingFirmPercentage\": 50,\n \"settlementAmount\": 500000000,\n \"notes\": \"<string>\",\n \"customFields\": [\n {\n \"fieldId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"value\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.casexchange.com/api/public/v1/received-referrals/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"leadAttorneyName\": \"<string>\",\n \"statuteOfLimitationsExpiration\": \"2023-12-25\",\n \"clientFeeAgreementPercentage\": 0.5,\n \"attorneyFees\": 500000000,\n \"estimatedDateOfResolution\": \"2023-12-25\",\n \"estimatedDistributionDate\": \"2023-12-25\",\n \"projectedSettlementAmount\": 500000000,\n \"phase\": \"<string>\",\n \"sendingFirmPercentage\": 50,\n \"settlementAmount\": 500000000,\n \"notes\": \"<string>\",\n \"customFields\": [\n {\n \"fieldId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"value\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"baseCaseId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"referenceNumber": "<string>",
"cmsId": "<string>",
"status": "draft",
"closingStatus": "won_settled",
"payoutType": "lump_sum",
"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",
"clientAddress1": "<string>",
"clientAddress2": "<string>",
"clientCity": "<string>",
"clientPostalCode": "<string>",
"incidentDate": "2023-11-07T05:31:56Z",
"notes": "<string>",
"settlementAmount": 500000000,
"attorneyFees": 500000000,
"leadAttorneyName": "<string>",
"warmTransferSuccessful": true,
"warmTransferUnsuccessfulReason": "<string>",
"warmTransferUnsuccessfulReasonType": "FIRM_UNABLE_TO_ANSWER",
"clientFeeAgreementPercentage": 0.5,
"sendingFirmPercentage": 50,
"netFeeToSendingFirm": 123,
"netFeeToHandlingFirm": 123,
"resolutionDate": "2023-11-07T05:31:56Z",
"closedDate": "2023-11-07T05:31:56Z",
"sendingFirmPercentageSource": "manual",
"sendingFirmFeeRuleSnapshot": {
"ruleId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"caseTypeName": "<string>",
"jurisdictionCode": "<string>",
"percentage": 123,
"effectiveFrom": "2023-12-25",
"effectiveTo": "2023-12-25",
"resolvedAsOf": "2023-12-25"
},
"feeProvenance": {
"kind": "locked",
"resolvedAsOf": "2023-12-25",
"percentage": 123,
"coverageLapsed": true,
"missingFacts": [
"settlement_amount"
]
},
"projectedSettlementAmount": 500000000,
"estimatedDateOfResolution": "2023-11-07T05:31:56Z",
"estimatedDistributionDate": "2023-11-07T05:31:56Z",
"statuteOfLimitationsExpiration": "2023-11-07T05:31:56Z",
"phase": "<string>",
"isRetainerSigned": true,
"customFields": [
{
"fieldId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"fieldName": "<string>",
"displayName": "<string>",
"fieldType": "<string>",
"value": "<string>"
}
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
},
"meta": {
"requestId": "req_f2dbe1d3f6ad4a7bb5b4c9f2",
"timestamp": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
},
"meta": {
"requestId": "req_f2dbe1d3f6ad4a7bb5b4c9f2",
"timestamp": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
},
"meta": {
"requestId": "req_f2dbe1d3f6ad4a7bb5b4c9f2",
"timestamp": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
},
"meta": {
"requestId": "req_f2dbe1d3f6ad4a7bb5b4c9f2",
"timestamp": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
},
"meta": {
"requestId": "req_f2dbe1d3f6ad4a7bb5b4c9f2",
"timestamp": "2023-11-07T05:31:56Z"
}
}{
"error": {
"code": "<string>",
"message": "<string>"
},
"meta": {
"requestId": "req_f2dbe1d3f6ad4a7bb5b4c9f2",
"timestamp": "2023-11-07T05:31:56Z"
}
}Authorizations
Public API key: cxp_<hex> (firm-scoped) or cxpp_<hex> (provider-scoped). Required on every request.
Path Parameters
Flexible identifier. Accepts a referral UUID, a base-case UUID, a CaseXchange reference number (e.g. PREFIX-0001, exact match), or one of the calling firm's own integration ids: a case-management id it holds on a referral it received (DearLegal case id, Neos intake id, Clio matter id, SmartAdvocate case id, Salesforce intake record id, Case Status user-entered id, or numeric Case Status internal id), or the Salesforce record id of a case it sent. An integration id belongs to the firm whose system it points to: another firm's ids never resolve, not even on a case both firms share. Resolution order is UUID, then reference number, then integration ids; the match must be a referral received by the calling firm or the request returns 404. A case-management or Case Status id that matches more than one of the calling firm's cases returns 409 ambiguous_external_id; one that matches several referrals of a single case (the firm received the case again) resolves to the live referral. The Salesforce record id of cases the firm sent resolves to the one still being referred (latest referral not rejected, withdrawn or closed), or to the newest when none is, and returns 409 only when more than one is still being referred.
Minimum string length:
1Body
application/json
Maximum string length:
500YYYY-MM-DD
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 <= 1Attorney fees in dollars
Required range:
0 <= x <= 1000000000YYYY-MM-DD
YYYY-MM-DD
Projected settlement amount in dollars
Required range:
0 <= x <= 1000000000Maximum string length:
200Referral fee owed to the sending firm as a WHOLE-NUMBER percent of attorney fees (33.33 = 33.33%). Input values strictly between 0 and 1 are rejected as likely fractions; 0 means no fee.
Required range:
0 <= x <= 100Final settlement amount in dollars
Required range:
0 <= x <= 1000000000Maximum string length:
10000Custom field values to set. Custom fields can only be updated by the receiving firm once the referral is SIGNED or later; otherwise the request is rejected with 403.
Show child attributes
Show child attributes
Response
Updated received referral
Full detail of a referral received by the calling firm, with the parent case flattened in. While the referral is still SENT (not yet acknowledged) the client PII fields, description, notes, leadAttorneyName, warmTransferUnsuccessfulReason and warmTransferUnsuccessfulReasonType are null. An admin-global key sees unmasked values.
Show child attributes
Show child attributes
Show child attributes
Show child attributes