Skip to main content
PATCH
/
cases
/
{case_id}
/
persons
/
{person_id}
Update a person
curl --request PATCH \
  --url https://api.example.com/v1/cases/{case_id}/persons/{person_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "first_name": "<string>",
  "last_name": "<string>",
  "middle_name": "<string>",
  "suffix": "<string>",
  "relationship": "<string>",
  "email": "jsmith@example.com",
  "phone": "<string>",
  "is_beneficiary": true,
  "possible_dispute": true,
  "is_deceased": true,
  "waiver_status": "no_waiver_needed"
}
'
{
  "data": {
    "id": "01K5XD09EJ7T44HRYE78AN7JKL",
    "first_name": "John",
    "middle_name": "Jonas",
    "last_name": "Johnson",
    "suffix": null,
    "relationship": "daughter",
    "email": "alice@example.com",
    "phone": "+11112223333",
    "is_beneficiary": true,
    "possible_dispute": false,
    "is_deceased": false,
    "waiver_status": "no_waiver_needed",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

case_id
string
required

Unique case identifier (ULID format).

person_id
string
required

Person identifier.

Body

application/json
first_name
string
required
last_name
string
required
middle_name
string
suffix
string
relationship
string
email
string<email>
phone
string
is_beneficiary
boolean
possible_dispute
boolean
is_deceased
boolean
waiver_status
enum<string>
Available options:
no_waiver_needed,
waiver_pending,
waiver_signed,
waiver_refused

Response

Person updated.

data
object