Create Custom Paperwork Link (Early Access)
| Time | Status | User Agent | |
|---|---|---|---|
| Make a request to see history. |
URL Expired
The URL for this request expired after 30 days.
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 Skip link to Returns
| attribute | type | description |
|---|---|---|
| success | boolean | Response status |
| data | object | Link to a Custom Paperwork collection screen |
| errors | array | Contains a list of error objects which consists of:message: Error messagecode: Error code as described in Error codes |
companyID
string
required
Company ID of employer
employeeID
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* ADD string
send_to_worker
boolean
Defaults to false
If true, this link will be sent to the worker's email address
truefalse
``200 200
``400 400
Updated 7 months ago
ShellNodeRubyPHPPython
xxxxxxxxxx
curl --request POST \
--url https://api.zeal.com/employees/custom_paperwork \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--data '
{
"send_to_worker": false
}
'
Click Try It! to start a request and see the response here! Or choose an example:
application/json
200 - Result400 - Result
Updated7 months ago