API Reference

Updates the metadata and custom field configuration for a specific onboarding document template.

put
https://api.worklio.com/wep/companies//onboarding/start//documents/

This operation updates only the document metadata and custom fields. To update the actual document file, use the upload endpoint.

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.

Input model for Template Document.

string | null
required

Name.

string | null

Note.

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
Defaults to 1.0

The requested API version

string
Defaults to 1.0

The requested API version

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 10 days 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 10 days ago