API Reference

Saves phase-1 HR custom-field values and advances the onboarding step state.

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

Access: System, Admin, and ClientAdmin users only.

Unlike the draft-save endpoint, this operation persists the values and lets the onboarding workflow treat the HR-fields step as completed when all requirements are satisfied.
Field validation rules are identical to the draft-save operation.

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

Company identifier from the route.

int32
required

Onboarding identifier from the route.

Body Params

HR field values to persist.

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 2 months ago

Did this page help you?
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 2 months ago

Did this page help you?