Update a Dependent

patch

https://integrate.nayya.com/accounts/employers/{employerId}/employees/{employeeId}/dependents/{dependentId}

Path Params

employerId

string

required

The unique ID from Nayya or your unique ID prefixed with the external: indicator that represents an employer (e.g. external:3438yht-hg8ht39-h23uh9th-uewht0o).

employeeId

string

required

The unique ID from Nayya or your unique ID prefixed with the external: indicator that represents an employee (e.g. external:3438yht-hg8ht39-h23uh9th-uewht0o).

dependentId

string

required

The unique ID from Nayya or your unique ID prefixed with the external: indicator that represents an employee's dependent (e.g. external:3438yht-hg8ht39-h23uh9th-uewht0o).

Body Params

relationship

string

enum

Dependent's relationship to the employee

Allowed:

string | null

Dependent email

ssn

string | null

Dependent SSN (9 digits)

firstName

string | null

Dependent first name

lastName

string | null

Dependent last name

gender

string | null

enum

Dependent gender

Allowed:

dateOfBirth

date

Dependent date of birth

streetAddress

string | null

Dependent street address

city

string | null

Dependent city

state

string | null

Dependent state

zipCode

string | null

Dependent zip code

phoneNumber

string | null

Dependent phone number

incomeAmountCents

number | null

Dependent income amount in cents

incomeType

string | null

enum

Dependent income type

Allowed:

hoursPerWeek

number | null

Dependent hours worked per week

tobaccoUsage

boolean | null

Dependent tobacco usage

dependentStatus

boolean

Defaults to true

Status indicating whether the dependent should be included in the employee's benefit recommendations.

externalId

string | null

A unique identifier from the partner's system, used to map dependent records between the partner's system and Nayya

employmentStatus

string | null

enum

Dependent employment status

Allowed:

Headers

X-API-Version

string

Defaults to 1

Optional API major version. Omit this header for the same behavior as 1 (this specification).

Responses

400

Bad Request

403

Forbidden

404

Not Found

409

Conflict

422

Unprocessable Entity

500

Internal Server Error

200Ok