Create or Update a Benefit

post

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

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

string | null

Unique ID from Nayya used to identify a benefit

externalId

string | null

Your internal unique ID used to identify a benefit

carrierId

string

required

Unique identifier for the carrier for this benefit

externalCarrierName

string | null

Name of the carrier for this benefit

description

string | null

Description of the benefit

type

string

enum

required

Type of benefit

displayName

string

required

Name of the benefit that will be visible to employees

activeAt

date

required

The start date for when the plan is effective in the format: YYYY-MM-DD

inactiveAt

date | null

The end date for when the plan is no longer effective in the format: YYYY-MM-DD. This field does not need to be provided if a plan is anticipated to roll over from year to year

detailsUrl

string | null

URL to a benefit overview where an employee can see coverage details

code

string | null

Internal code used to identify this benefit

features

array of objects

required

features*

tiers

array of objects

required

tiers*

thresholds

array of objects

required

thresholds*

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

429

Unable to resolve employer ID after maximum retry attempts. This may be because the employer is not yet available or due to temporary system issues. Please try again.

500

Internal server error

201created