API Reference

Saves employee-provided HR custom field values for phase 2 onboarding.

put
https://example.com/wep/companies//onboarding/ee//hr-fields

Access: Anonymous users with a valid onboarding link token.

Only fields that are writable for the employee can be persisted.
The request is validated against the current active HR-field definitions and required fields must be supplied when the definition requires them.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int32
required

Company identifier from the route.

string
required

Encrypted onboarding token from the employee link.

Body Params

HR field values keyed by custom-field identifiers.

Payload used to submit multiple HR custom-field values in one request.

values
array of objects | null
required

Collection of field/value pairs to save for the employee.

values*
Headers
string
required
Defaults to 2.0

The requested API version

string
Defaults to 2.0

The requested API version

Responses
204

No Content

Updated about 1 month ago

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

Updated about 1 month ago