PATCH
/
users
/
{user_id}
/
dependants
/
{dependant_id}
cURL
curl --request PATCH \
  --url http://localhost:8080/users/{user_id}/dependants/{dependant_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "date_of_birth": "2000-01-15",
  "first_name": "<string>",
  "gender": "male",
  "last_name": "<string>",
  "salutation": "mr"
}
'
{
  "created_at": "<string>",
  "date_of_birth": "2000-01-15",
  "first_name": "<string>",
  "gender": "male",
  "id": "<string>",
  "last_modified_at": "<string>",
  "last_name": "<string>",
  "primary_user_id": "<string>",
  "relationship": "self",
  "salutation": "mr",
  "status": "active",
  "previous_version_id": "<string>"
}

Authorizations

​
Authorization
string
header
required

JWT access token. Obtain from /auth/otp/verify endpoint.

Path Parameters

​
user_id
string
required

User ID

​
dependant_id
string
required

Dependant ID

Body

application/json
​
date_of_birth
string | null
Example:

"2000-01-15"

​
first_name
string | null
​
gender
null | enum<string>

User gender.

Available options:
male,
female,
other
​
last_name
string | null
​
salutation
null | enum<string>

Title or honorific for a person.

Available options:
mr,
mrs,
ms,
master

Response

Dependant updated

​
created_at
string
required
​
date_of_birth
string
required
Example:

"2000-01-15"

​
first_name
string
required
​
gender
enum<string>
required

User gender.

Available options:
male,
female,
other
​
id
string
required
​
last_modified_at
string
required
​
last_name
string
required
​
primary_user_id
string
required
​
relationship
enum<string>
required

Relationship of a dependant to the primary user.

Available options:
self,
spouse,
mother,
father,
child,
father_in_law,
mother_in_law,
sibling
​
salutation
enum<string>
required

Title or honorific for a person.

Available options:
mr,
mrs,
ms,
master
​
status
enum<string>
required

Dependant row lifecycle status.

Available options:
active,
discarded
​
previous_version_id
string | null