Nayya.com
API Reference
API Reference

Replace Benefit Dependencies for Benefit

put
https://integrate.nayya-dev-01.nayya.com/benefits/employers//benefits//benefit-dependencies

Replaces the entire set of benefit dependencies for the benefit with the set provided in the request body. This is the authoritative state of the benefit dependencies: dependencies not present in the body are removed, and new ones are added, in a single atomic operation. An empty array removes all dependencies.

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

string
required

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

Body Params
benefitDependencies
array of objects
required
benefitDependencies*
Headers
string
Defaults to 1

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

Responses

403

Forbidden

404

Not Found

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

Updated about 20 hours ago

Did this page help you?
Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 20 hours ago

Did this page help you?