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

put

https://api.worklio.com/wep/companies/{companyId}/onboarding/start/{id}/documents/{documentId}

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

Path Params

companyId

int32

required

The unique identifier of the company.

int32

required

The unique identifier of the onboarding process.

documentId

int32

required

The unique identifier of the document template to update.

Body Params

Updated document metadata and custom field configuration.

name

string | null

required

Name.

note

string | null

Note.

customFields

int32

enum

Document custom fields flags.
Indicates which custom fields the document requires.

Members:

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

Allowed:

Headers

api-version

string

Defaults to 1.0

The requested API version

x-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

Language

Credentials

Bearer

jwt

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

text/json

text/plain

200Success

400Bad Request

500Server Error