curl --request POST \
--url https://app.outboundlegal.com/api/v1/cases/settled \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"settled_on": "2026-10-13",
"external_id": "M-1042",
"first_name": "Ana",
"last_name": "Diaz"
}
'import requests
url = "https://app.outboundlegal.com/api/v1/cases/settled"
payload = {
"settled_on": "2026-10-13",
"external_id": "M-1042",
"first_name": "Ana",
"last_name": "Diaz"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
settled_on: '2026-10-13',
external_id: 'M-1042',
first_name: 'Ana',
last_name: 'Diaz'
})
};
fetch('https://app.outboundlegal.com/api/v1/cases/settled', 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://app.outboundlegal.com/api/v1/cases/settled",
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([
'settled_on' => '2026-10-13',
'external_id' => 'M-1042',
'first_name' => 'Ana',
'last_name' => 'Diaz'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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://app.outboundlegal.com/api/v1/cases/settled"
payload := strings.NewReader("{\n \"settled_on\": \"2026-10-13\",\n \"external_id\": \"M-1042\",\n \"first_name\": \"Ana\",\n \"last_name\": \"Diaz\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://app.outboundlegal.com/api/v1/cases/settled")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"settled_on\": \"2026-10-13\",\n \"external_id\": \"M-1042\",\n \"first_name\": \"Ana\",\n \"last_name\": \"Diaz\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.outboundlegal.com/api/v1/cases/settled")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"settled_on\": \"2026-10-13\",\n \"external_id\": \"M-1042\",\n \"first_name\": \"Ana\",\n \"last_name\": \"Diaz\"\n}"
response = http.request(request)
puts response.read_body{
"result": {
"index": 0,
"status": "updated",
"id": "0b6c1d8e-6a43-4c1e-9d0f-2f5b9a7e4c21"
}
}{
"error": {
"code": "invalid_request",
"message": "limit must be a whole number from 1 to 100."
}
}{
"error": {
"code": "unauthorized",
"message": "Send your API key as: Authorization: Bearer obl_…"
}
}{
"error": {
"code": "not_enabled",
"message": "The API isn't turned on for this account yet."
}
}{
"error": {
"code": "unauthorized",
"message": "<string>"
}
}{
"error": {
"code": "unauthorized",
"message": "<string>"
},
"result": {
"index": 123,
"status": "created",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"message": "<string>"
}
}{
"error": {
"code": "rate_limited",
"message": "Too many requests. The limit is 120 per minute per key."
}
}{
"error": {
"code": "unauthorized",
"message": "<string>"
}
}Mark a case settled
“This client’s case settled.” Adds the client if they’re new, otherwise updates them, and sets settled_on — the date a case-settled client letter waits for. Send settled_on plus either external_id (enough on its own for a client you’ve already sent us; add a name to create a new one) or a name, street address and ZIP. Unlike POST /clients, a changed settled date counts as a new settlement unless you send new_settlement: false.
curl --request POST \
--url https://app.outboundlegal.com/api/v1/cases/settled \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"settled_on": "2026-10-13",
"external_id": "M-1042",
"first_name": "Ana",
"last_name": "Diaz"
}
'import requests
url = "https://app.outboundlegal.com/api/v1/cases/settled"
payload = {
"settled_on": "2026-10-13",
"external_id": "M-1042",
"first_name": "Ana",
"last_name": "Diaz"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
settled_on: '2026-10-13',
external_id: 'M-1042',
first_name: 'Ana',
last_name: 'Diaz'
})
};
fetch('https://app.outboundlegal.com/api/v1/cases/settled', 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://app.outboundlegal.com/api/v1/cases/settled",
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([
'settled_on' => '2026-10-13',
'external_id' => 'M-1042',
'first_name' => 'Ana',
'last_name' => 'Diaz'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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://app.outboundlegal.com/api/v1/cases/settled"
payload := strings.NewReader("{\n \"settled_on\": \"2026-10-13\",\n \"external_id\": \"M-1042\",\n \"first_name\": \"Ana\",\n \"last_name\": \"Diaz\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://app.outboundlegal.com/api/v1/cases/settled")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"settled_on\": \"2026-10-13\",\n \"external_id\": \"M-1042\",\n \"first_name\": \"Ana\",\n \"last_name\": \"Diaz\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.outboundlegal.com/api/v1/cases/settled")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"settled_on\": \"2026-10-13\",\n \"external_id\": \"M-1042\",\n \"first_name\": \"Ana\",\n \"last_name\": \"Diaz\"\n}"
response = http.request(request)
puts response.read_body{
"result": {
"index": 0,
"status": "updated",
"id": "0b6c1d8e-6a43-4c1e-9d0f-2f5b9a7e4c21"
}
}{
"error": {
"code": "invalid_request",
"message": "limit must be a whole number from 1 to 100."
}
}{
"error": {
"code": "unauthorized",
"message": "Send your API key as: Authorization: Bearer obl_…"
}
}{
"error": {
"code": "not_enabled",
"message": "The API isn't turned on for this account yet."
}
}{
"error": {
"code": "unauthorized",
"message": "<string>"
}
}{
"error": {
"code": "unauthorized",
"message": "<string>"
},
"result": {
"index": 123,
"status": "created",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"message": "<string>"
}
}{
"error": {
"code": "rate_limited",
"message": "Too many requests. The limit is 120 per minute per key."
}
}{
"error": {
"code": "unauthorized",
"message": "<string>"
}
}Authorizations
An API key from Settings → Integrations → API keys. Keys look like obl_ followed by 43 letters, numbers, - or _.
Body
A client to add or update. Every field is optional, but a new client needs a first or last name. Unknown fields are ignored. Blank values never erase what's saved.
The date the case settled: 2026-10-13 (also accepts 10/13/2026 or Oct 13, 2026).
"2026-10-13"
200200Street address.
300Apartment, suite, unit.
3002002-letter US state (a full state name is also accepted).
"NJ"
5- or 9-digit ZIP. A ZIP that lost its leading zero (7102) is fixed to 07102.
"07102"
32010 to 15 digits; any formatting is fine.
Free text, e.g. "Motor vehicle accident". Client letters can be limited to certain case types.
200Date the case opened: 2026-10-13, 10/13/2026 or Oct 13, 2026.
The client's id in your case system. Send it whenever you have it.
200true stops all client letters to this person. Also accepts yes/no. The API can turn this on, never off.
Only matters when the client already has a different settled date. true (default): a new settlement (may get another thank-you letter). false: a correction.
Response
The client was added or updated.
Show child attributes
Show child attributes

