Skip to main content
POST
Mark a case settled

Authorizations

Authorization
string
header
required

An API key from Settings → Integrations → API keys. Keys look like obl_ followed by 43 letters, numbers, - or _.

Body

application/json

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.

settled_on
string
required

The date the case settled: 2026-10-13 (also accepts 10/13/2026 or Oct 13, 2026).

Example:

"2026-10-13"

first_name
string
Maximum string length: 200
last_name
string
Maximum string length: 200
address_line1
string

Street address.

Maximum string length: 300
address_line2
string

Apartment, suite, unit.

Maximum string length: 300
city
string
Maximum string length: 200
state
string

2-letter US state (a full state name is also accepted).

Example:

"NJ"

zip

5- or 9-digit ZIP. A ZIP that lost its leading zero (7102) is fixed to 07102.

Example:

"07102"

email
string<email>
Maximum string length: 320
phone

10 to 15 digits; any formatting is fine.

case_type
string

Free text, e.g. "Motor vehicle accident". Client letters can be limited to certain case types.

Maximum string length: 200
opened_on
string

Date the case opened: 2026-10-13, 10/13/2026 or Oct 13, 2026.

external_id

The client's id in your case system. Send it whenever you have it.

Maximum string length: 200
do_not_mail

true stops all client letters to this person. Also accepts yes/no. The API can turn this on, never off.

new_settlement
boolean
default:true

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.

result
object
required