Update Employee Dependent

Replaces all fields on an existing employee dependent record. The request body must contain the full desired state of the dependent — omitted fields are written as empty or null, not preserved. employeeId is required and must reference a valid employee. relationship must be a valid relationship type and gender must be a valid gender value. isUsCitizen and isStudent accept "yes" or "no". state accepts a state code (e.g. "UT") and country accepts an ISO 3166-1 alpha-2 country code (e.g. "US"). dateOfBirth must be in YYYY-MM-DD format. SSN and SIN are accepted as plain text and stored encrypted. Accepts both application/json and application/xml request bodies. The response format mirrors the request Content-Type (not the Accept header): JSON request bodies receive a JSON response; XML request bodies receive an XML response. A successful update fires an internal dependent-updated event that may trigger downstream benefit enrollment processing.

Path Params
integer
required

The numeric ID of the employee dependent to update.

Body Params
string
required

The ID of the employee this dependent belongs to. Required.

string

The dependent's first name.

string

The dependent's middle name.

string

The dependent's last name.

string

The dependent's relationship to the employee (e.g. "spouse", "child", "domestic_partner").

string

The dependent's gender.

string

The dependent's Social Security Number, provided as plain text. Stored encrypted. Returned as a masked value (e.g. "xxx-xx-1234") on read.

string

The dependent's Social Insurance Number (Canadian equivalent of SSN), provided as plain text. Stored encrypted. Returned as a masked value on read.

date

The dependent's date of birth in YYYY-MM-DD format.

string

The first line of the dependent's address.

string

The second line of the dependent's address.

string

The dependent's city.

string

The dependent's state, provided as a state code (e.g. "UT"). Returned as a full state name on read.

string

The dependent's ZIP or postal code.

string

The dependent's home phone number.

string

The dependent's country, provided as an ISO 3166-1 alpha-2 country code (e.g. "US"). Returned as a full country name on read.

string
enum

Whether the dependent is a US citizen. Accepted values: "yes" or "no".

Allowed:
string
enum

Whether the dependent is currently a student. Accepted values: "yes" or "no".

Allowed:
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

400

The request body is invalid or contains a validation error (e.g. invalid relationship, gender, state code, country code, or date format).

403

The authenticated user does not have permission to update this dependent.

409

A duplicate record conflict was detected.

500

An unexpected server error occurred.

Language
Credentials
:
URL
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json