API Reference

Create Custom Paperwork Link (Early Access)

post
https://api.zeal.com/employees/custom_paperwork
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

This endpoint provides a link for an employee to complete Custom Paperwork. Note: the order of the formTemplateIDs provided dictates the order in which the worker will see the paperwork to complete.

Returns


attributetypedescription
successbooleanResponse status
dataobjectLink to a Custom Paperwork collection screen
errorsarrayContains a list of error objects which consists of:
message: Error message
code: Error code as described in Error codes
Body Params
string
required

Company ID of employer

string
required

Employee ID of the employee

formTemplateIDs
array of strings
required

Array of form template IDs (in order of how it appears to worker)

formTemplateIDs*
boolean
Defaults to false

If true, this link will be sent to the worker's email address

Responses

Updated 7 months ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 7 months ago

Did this page help you?