HEhellosunset
Persons

Add a person

Add an interested person or beneficiary to a case.

post/cases/{case_id}/persons

Request

  • Base URL
    https://api.example.com/v1
  • Auth
    none declared

Request body

first_namestring required
middle_namestring
last_namestring required
suffixstring
relationshipstring
emailstring email
phonestring
is_beneficiaryboolean
possible_disputeboolean
is_deceasedboolean
waiver_status'no_waiver_needed' | 'waiver_pending' | 'waiver_signed' | 'waiver_refused'

Response

Person added.

Example response

{
  "data": {
    "id": "01K5XD09EJ7T44HRYE78AN7JKL",
    "first_name": "John",
    "middle_name": "Jonas",
    "last_name": "Johnson",
    "relationship": "daughter",
    "email": "alice@example.com",
    "phone": "+11112223333",
    "is_beneficiary": true,
    "waiver_status": "no_waiver_needed"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.