Create employee, dependents, and snapshot atomically

Orchestrates partner-employee-creator, partner-dependent-creator, and snapshot creation via a synchronous Step Functions Express workflow. Hidden from public partner docs until GA.

Path Params
string
required

Nayya employer UUID or external ID prefixed with external: (e.g. external:abc-123)

Body Params
employee
object

Employee fields forwarded to partner-employee-creator as upsertEmployeeDto. Field validation is enforced by the creator Lambda (422 on rejection).

dependents
array of objects

Dependents forwarded to partner-dependent-creator. Field validation is enforced by the creator Lambda (422 on rejection).

dependents
snapshot
object
required

Snapshot payload forwarded to the snapshot creator step

Headers
string

Unique key for safe retries. Repeat requests with the same key and payload return the cached result; a different payload with the same key returns 409.

string
Defaults to 1

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

Response

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json