Create a Snapshot

post

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

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

Body Params

reason

string

enum

required

The reason for taking the snapshot, such as new enrollment or new hire.

Allowed:

benefits

array of objects

required

benefits*

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 parent entity ID after maximum retry attempts. This may be because the parent entity is not yet available or due to temporary system issues. Please try again.

500

Internal server error

Language

Credentials

Bearer

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Created