Close a case
curl --request POST \
--url https://api.casexchange.com/api/public/v1/cases/{id}/close \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"closingStatus": "<string>",
"closingNotes": "<string>",
"settlementAmount": 1,
"clientFeeAgreementPercentage": 0.5,
"attorneyFees": 1,
"closureReason": "<string>"
}
'import requests
url = "https://api.casexchange.com/api/public/v1/cases/{id}/close"
payload = {
"closingStatus": "<string>",
"closingNotes": "<string>",
"settlementAmount": 1,
"clientFeeAgreementPercentage": 0.5,
"attorneyFees": 1,
"closureReason": "<string>"
}
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({
closingStatus: '<string>',
closingNotes: '<string>',
settlementAmount: 1,
clientFeeAgreementPercentage: 0.5,
attorneyFees: 1,
closureReason: '<string>'
})
};
fetch('https://api.casexchange.com/api/public/v1/cases/{id}/close', 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/cases/{id}/close",
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([
'closingStatus' => '<string>',
'closingNotes' => '<string>',
'settlementAmount' => 1,
'clientFeeAgreementPercentage' => 0.5,
'attorneyFees' => 1,
'closureReason' => '<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/cases/{id}/close"
payload := strings.NewReader("{\n \"closingStatus\": \"<string>\",\n \"closingNotes\": \"<string>\",\n \"settlementAmount\": 1,\n \"clientFeeAgreementPercentage\": 0.5,\n \"attorneyFees\": 1,\n \"closureReason\": \"<string>\"\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/cases/{id}/close")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"closingStatus\": \"<string>\",\n \"closingNotes\": \"<string>\",\n \"settlementAmount\": 1,\n \"clientFeeAgreementPercentage\": 0.5,\n \"attorneyFees\": 1,\n \"closureReason\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.casexchange.com/api/public/v1/cases/{id}/close")
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 \"closingStatus\": \"<string>\",\n \"closingNotes\": \"<string>\",\n \"settlementAmount\": 1,\n \"clientFeeAgreementPercentage\": 0.5,\n \"attorneyFees\": 1,\n \"closureReason\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"referenceNumber": "ABC-0001",
"title": "<string>",
"description": "<string>",
"status": "<string>",
"caseType": "<string>",
"jurisdiction": "<string>",
"county": "<string>",
"clientFirstName": "<string>",
"clientLastName": "<string>",
"clientEmail": "jsmith@example.com",
"clientPhone": "<string>",
"incidentDate": "2023-12-25",
"notes": "<string>",
"sendingFirmId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"receivingFirmId": "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"
}
}Cases
Close a case
Initiates the closing workflow for a case. Requires STANDARD tier.
POST
/
cases
/
{id}
/
close
Close a case
curl --request POST \
--url https://api.casexchange.com/api/public/v1/cases/{id}/close \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"closingStatus": "<string>",
"closingNotes": "<string>",
"settlementAmount": 1,
"clientFeeAgreementPercentage": 0.5,
"attorneyFees": 1,
"closureReason": "<string>"
}
'import requests
url = "https://api.casexchange.com/api/public/v1/cases/{id}/close"
payload = {
"closingStatus": "<string>",
"closingNotes": "<string>",
"settlementAmount": 1,
"clientFeeAgreementPercentage": 0.5,
"attorneyFees": 1,
"closureReason": "<string>"
}
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({
closingStatus: '<string>',
closingNotes: '<string>',
settlementAmount: 1,
clientFeeAgreementPercentage: 0.5,
attorneyFees: 1,
closureReason: '<string>'
})
};
fetch('https://api.casexchange.com/api/public/v1/cases/{id}/close', 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/cases/{id}/close",
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([
'closingStatus' => '<string>',
'closingNotes' => '<string>',
'settlementAmount' => 1,
'clientFeeAgreementPercentage' => 0.5,
'attorneyFees' => 1,
'closureReason' => '<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/cases/{id}/close"
payload := strings.NewReader("{\n \"closingStatus\": \"<string>\",\n \"closingNotes\": \"<string>\",\n \"settlementAmount\": 1,\n \"clientFeeAgreementPercentage\": 0.5,\n \"attorneyFees\": 1,\n \"closureReason\": \"<string>\"\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/cases/{id}/close")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"closingStatus\": \"<string>\",\n \"closingNotes\": \"<string>\",\n \"settlementAmount\": 1,\n \"clientFeeAgreementPercentage\": 0.5,\n \"attorneyFees\": 1,\n \"closureReason\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.casexchange.com/api/public/v1/cases/{id}/close")
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 \"closingStatus\": \"<string>\",\n \"closingNotes\": \"<string>\",\n \"settlementAmount\": 1,\n \"clientFeeAgreementPercentage\": 0.5,\n \"attorneyFees\": 1,\n \"closureReason\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"referenceNumber": "ABC-0001",
"title": "<string>",
"description": "<string>",
"status": "<string>",
"caseType": "<string>",
"jurisdiction": "<string>",
"county": "<string>",
"clientFirstName": "<string>",
"clientLastName": "<string>",
"clientEmail": "jsmith@example.com",
"clientPhone": "<string>",
"incidentDate": "2023-12-25",
"notes": "<string>",
"sendingFirmId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"receivingFirmId": "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"
}
}Authorizations
Public API key (starts with cxp_). Required on every request.
Path Parameters
Resource UUID
Body
application/json
⌘I