Update Enrollment

put

https://integrate.nayya.com/benefits/employers/{employerId}/enrollment

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).

Body Params

benefitId

string

required

The ID of the benefit being enrolled in

employeeId

string

The ID of the employee enrolling. One of employeeId or employeeExternalId must be provided.

employeeExternalId

string

The external ID of the employee enrolling. One of employeeId or employeeExternalId must be provided.

dependentId

string

The ID of the dependent being enrolled (if applicable)

benefitAmountCents

number

The benefit amount in cents

rateAmountCents

number

The rate amount in cents

beginsAt

date-time

When the enrollment begins

endsAt

date-time

When the enrollment ends (if applicable)

groupNumber

string

The group number for the enrollment (if applicable)

memberId

string

The member ID for the enrollment (if applicable)

deductiblePayerCode

string | null

The deductible payer code for this enrollment (if applicable)

externalRelationship

string | null

External relationship for enrollment owner

Headers

X-API-Version

string

Defaults to 1

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

Responses

403

Forbidden

422

Unprocessable entity

500

Internal server error