Create Enrollments

post

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

Create one or more enrollments for a single employee in one request. All enrollments are created atomically - if one fails, all fail and are rolled back.

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

employeeId

string

The ID of the employee being enrolled. Can be your id or Nayya's. All enrollments in this request will be for this employee. One of employeeId or employeeExternalId must be provided.

employeeExternalId

string

The external ID of the employee being enrolled. All enrollments in this request will be for this employee. One of employeeId or employeeExternalId must be provided.

enrollments

array of objects

required

Array of benefit enrollments to create for the employee specified above.

enrollments*

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

201Created