API Reference

Updates metadata and required custom fields for an onboarding document template.

put
https://example.com/wep/companies//onboarding/start//documents/

Access: System, Admin, and ClientAdmin users only.

The document binary is not replaced here; only the display name, note, and required custom-field flags are updated.

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

The unique identifier of the company.

int32
required

The unique identifier of the onboarding process.

int32
required

The unique identifier of the document template to update.

Body Params

Updated document metadata and custom field configuration.

Request payload used to update onboarding document-template metadata.

string | null
required

Updated display name for the document template.

string | null

Updated note shown together with the document template.

int32
enum

Document custom fields flags.

Indicates which custom fields the document requires.

Members:

  • 1 - ErSignature ( Employer Signature )
  • 2 - EeSignature ( Employee Signature )

Allowed:
Headers
string
required
Defaults to 2.0

The requested API version

string
Defaults to 2.0

The requested API version

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Responses

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
text/json
text/plain

Updated about 1 month ago