Refer / re-refer a sent case
curl --request POST \
--url https://api.casexchange.com/api/public/v1/sent-cases/{id}/refer \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"referentFirmId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"notes": "<string>",
"routingRuleId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"roundRobinPosition": 1
}
'import requests
url = "https://api.casexchange.com/api/public/v1/sent-cases/{id}/refer"
payload = {
"referentFirmId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"notes": "<string>",
"routingRuleId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"roundRobinPosition": 1
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
referentFirmId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
notes: '<string>',
routingRuleId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
roundRobinPosition: 1
})
};
fetch('https://api.casexchange.com/api/public/v1/sent-cases/{id}/refer', 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/sent-cases/{id}/refer",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'referentFirmId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'notes' => '<string>',
'routingRuleId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'roundRobinPosition' => 1
]),
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/sent-cases/{id}/refer"
payload := strings.NewReader("{\n \"referentFirmId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"notes\": \"<string>\",\n \"routingRuleId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"roundRobinPosition\": 1\n}")
req, _ := http.NewRequest("POST", 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.post("https://api.casexchange.com/api/public/v1/sent-cases/{id}/refer")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"referentFirmId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"notes\": \"<string>\",\n \"routingRuleId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"roundRobinPosition\": 1\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.casexchange.com/api/public/v1/sent-cases/{id}/refer")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"referentFirmId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"notes\": \"<string>\",\n \"routingRuleId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"roundRobinPosition\": 1\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"referenceNumber": "ABC-0001",
"salesforceId": "<string>",
"salesforceObjectType": "<string>",
"title": "<string>",
"description": "<string>",
"caseType": "<string>",
"jurisdiction": "<string>",
"county": "<string>",
"clientAddress1": "<string>",
"clientAddress2": "<string>",
"clientCity": "<string>",
"clientPostalCode": "<string>",
"clientFirstName": "<string>",
"clientLastName": "<string>",
"clientEmail": "jsmith@example.com",
"clientPhone": "<string>",
"clientDateOfBirth": "2023-11-07T05:31:56Z",
"incidentDate": "2023-11-07T05:31:56Z",
"tier": 3,
"ratedTier": 3,
"ratingNotes": "<string>",
"source": "<string>",
"isTestCase": true,
"createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"status": "<string>",
"closingStatus": "won_settled",
"payoutType": "lump_sum",
"closureReason": "<string>",
"settlementAmount": 500000000,
"attorneyFees": 500000000,
"clientFeeAgreementPercentage": 0.5,
"projectedSettlementAmount": 500000000,
"estimatedDateOfResolution": "2023-11-07T05:31:56Z",
"estimatedDistributionDate": "2023-11-07T05:31:56Z",
"leadAttorneyName": "<string>",
"warmTransferSuccessful": true,
"warmTransferUnsuccessfulReason": "<string>",
"warmTransferUnsuccessfulReasonType": "FIRM_UNABLE_TO_ANSWER",
"netFeeToSendingFirm": 123,
"netFeeToHandlingFirm": 123,
"resolutionDate": "2023-11-07T05:31:56Z",
"closedDate": "2023-11-07T05:31:56Z",
"statuteOfLimitationsExpiration": "2023-11-07T05:31:56Z",
"phase": "<string>",
"requiresUpdate": true,
"customFields": [
{
"fieldId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"fieldName": "<string>",
"displayName": "<string>",
"fieldType": "<string>",
"value": "<string>"
}
],
"referrals": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"referentFirmId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"referentFirmName": "<string>",
"status": "<string>",
"closingStatus": "won_settled",
"payoutType": "lump_sum",
"closureReason": "<string>",
"settlementAmount": 500000000,
"attorneyFees": 500000000,
"clientFeeAgreementPercentage": 0.5,
"projectedSettlementAmount": 500000000,
"estimatedDateOfResolution": "2023-11-07T05:31:56Z",
"estimatedDistributionDate": "2023-11-07T05:31:56Z",
"leadAttorneyName": "<string>",
"netFeeToSendingFirm": 123,
"netFeeToHandlingFirm": 123,
"resolutionDate": "2023-11-07T05:31:56Z",
"closedDate": "2023-11-07T05:31:56Z",
"notes": "<string>",
"createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"lastUpdatedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"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"
}
}Sent Cases
Refer / re-refer a sent case
Sends a DRAFT case or re-refers an existing case to a receiving firm. Pass routingRuleId + roundRobinPosition (from GET /routing/re-refer) to advance the round-robin pointer. Requires STANDARD tier.
POST
/
sent-cases
/
{id}
/
refer
Refer / re-refer a sent case
curl --request POST \
--url https://api.casexchange.com/api/public/v1/sent-cases/{id}/refer \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"referentFirmId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"notes": "<string>",
"routingRuleId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"roundRobinPosition": 1
}
'import requests
url = "https://api.casexchange.com/api/public/v1/sent-cases/{id}/refer"
payload = {
"referentFirmId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"notes": "<string>",
"routingRuleId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"roundRobinPosition": 1
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
referentFirmId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
notes: '<string>',
routingRuleId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
roundRobinPosition: 1
})
};
fetch('https://api.casexchange.com/api/public/v1/sent-cases/{id}/refer', 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/sent-cases/{id}/refer",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'referentFirmId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'notes' => '<string>',
'routingRuleId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'roundRobinPosition' => 1
]),
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/sent-cases/{id}/refer"
payload := strings.NewReader("{\n \"referentFirmId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"notes\": \"<string>\",\n \"routingRuleId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"roundRobinPosition\": 1\n}")
req, _ := http.NewRequest("POST", 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.post("https://api.casexchange.com/api/public/v1/sent-cases/{id}/refer")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"referentFirmId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"notes\": \"<string>\",\n \"routingRuleId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"roundRobinPosition\": 1\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.casexchange.com/api/public/v1/sent-cases/{id}/refer")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"referentFirmId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"notes\": \"<string>\",\n \"routingRuleId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"roundRobinPosition\": 1\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"referenceNumber": "ABC-0001",
"salesforceId": "<string>",
"salesforceObjectType": "<string>",
"title": "<string>",
"description": "<string>",
"caseType": "<string>",
"jurisdiction": "<string>",
"county": "<string>",
"clientAddress1": "<string>",
"clientAddress2": "<string>",
"clientCity": "<string>",
"clientPostalCode": "<string>",
"clientFirstName": "<string>",
"clientLastName": "<string>",
"clientEmail": "jsmith@example.com",
"clientPhone": "<string>",
"clientDateOfBirth": "2023-11-07T05:31:56Z",
"incidentDate": "2023-11-07T05:31:56Z",
"tier": 3,
"ratedTier": 3,
"ratingNotes": "<string>",
"source": "<string>",
"isTestCase": true,
"createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"status": "<string>",
"closingStatus": "won_settled",
"payoutType": "lump_sum",
"closureReason": "<string>",
"settlementAmount": 500000000,
"attorneyFees": 500000000,
"clientFeeAgreementPercentage": 0.5,
"projectedSettlementAmount": 500000000,
"estimatedDateOfResolution": "2023-11-07T05:31:56Z",
"estimatedDistributionDate": "2023-11-07T05:31:56Z",
"leadAttorneyName": "<string>",
"warmTransferSuccessful": true,
"warmTransferUnsuccessfulReason": "<string>",
"warmTransferUnsuccessfulReasonType": "FIRM_UNABLE_TO_ANSWER",
"netFeeToSendingFirm": 123,
"netFeeToHandlingFirm": 123,
"resolutionDate": "2023-11-07T05:31:56Z",
"closedDate": "2023-11-07T05:31:56Z",
"statuteOfLimitationsExpiration": "2023-11-07T05:31:56Z",
"phase": "<string>",
"requiresUpdate": true,
"customFields": [
{
"fieldId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"fieldName": "<string>",
"displayName": "<string>",
"fieldType": "<string>",
"value": "<string>"
}
],
"referrals": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"referentFirmId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"referentFirmName": "<string>",
"status": "<string>",
"closingStatus": "won_settled",
"payoutType": "lump_sum",
"closureReason": "<string>",
"settlementAmount": 500000000,
"attorneyFees": 500000000,
"clientFeeAgreementPercentage": 0.5,
"projectedSettlementAmount": 500000000,
"estimatedDateOfResolution": "2023-11-07T05:31:56Z",
"estimatedDistributionDate": "2023-11-07T05:31:56Z",
"leadAttorneyName": "<string>",
"netFeeToSendingFirm": 123,
"netFeeToHandlingFirm": 123,
"resolutionDate": "2023-11-07T05:31:56Z",
"closedDate": "2023-11-07T05:31:56Z",
"notes": "<string>",
"createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"lastUpdatedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"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
Resource UUID
Body
application/json
Optional. Routing rule this send was chosen from (from GET /routing/re-refer). Ignored (with a server-side warning) if it is not a live rule owned by your firm.
Optional. The roundRobinPosition from GET /routing/re-refer. Requires routingRuleId; advances the rule's round-robin pointer when the selected slot is a first-look slot (its attempt window includes attempt 1); re-look-only slots leave the pointer unchanged.
Required range:
x >= 0