Work Eligibility
Update Employee Work Eligibility Request
HRIS
- Overview
- Use Cases
Common Guides
API Reference
- Companies
- Custom Field Definitions
- Employees
- GETList Employees
- POSTCreates an employee
- GETGet Employee
- PATCHUpdates an employee
- POSTInvite Employee
- Time Off
- Documents
- Work Eligibility
- Time Off Balances
- Employments
- Skills
- Time Off Policies
- GET
- Documents
- Employments
- Locations
- Time Off
- Time Entries
- Benefits
- Groups
- Jobs
- Time Off Policies
Work Eligibility
Update Employee Work Eligibility Request
PATCH
/
unified
/
hris
/
employees
/
{id}
/
work_eligibility
/
{subResourceId}
curl --request PATCH \
--url https://api.stackone.com/unified/hris/employees/{id}/work_eligibility/{subResourceId} \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--header 'x-account-id: <x-account-id>' \
--data '{
"document": {
"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"name": "My Document",
"path": "/path/to/file",
"category": "templates, forms, backups, etc.",
"contents": [
{
"url": "https://example.com/file.pdf",
"unified_url": "https://api.stackone.com/unified/hris/employees/12345/documents/67890/download",
"file_format": {
"value": "pdf",
"source_value": "abc"
}
}
],
"category_id": "6530",
"created_at": "2021-01-01T01:01:01.000Z",
"updated_at": "2021-01-02T01:01:01.000Z",
"remote_url": "https://example.com/file.pdf",
"file_format": {
"value": "pdf",
"source_value": "abc"
}
},
"issued_by": {
"value": "US",
"source_value": "<string>"
},
"number": "1234567890",
"sub_type": "H1B",
"type": "visa",
"valid_from": "2021-01-01T00:00.000Z",
"valid_to": "2021-01-01T00:00.000Z",
"passthrough": {
"other_known_names": "John Doe"
}
}'
This response has no body data.
Authorizations
Basic authentication header of the form Basic <encoded-value>
, where <encoded-value>
is the base64-encoded string username:password
.
Headers
The account identifier
Body
application/json
Was this page helpful?
curl --request PATCH \
--url https://api.stackone.com/unified/hris/employees/{id}/work_eligibility/{subResourceId} \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--header 'x-account-id: <x-account-id>' \
--data '{
"document": {
"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"name": "My Document",
"path": "/path/to/file",
"category": "templates, forms, backups, etc.",
"contents": [
{
"url": "https://example.com/file.pdf",
"unified_url": "https://api.stackone.com/unified/hris/employees/12345/documents/67890/download",
"file_format": {
"value": "pdf",
"source_value": "abc"
}
}
],
"category_id": "6530",
"created_at": "2021-01-01T01:01:01.000Z",
"updated_at": "2021-01-02T01:01:01.000Z",
"remote_url": "https://example.com/file.pdf",
"file_format": {
"value": "pdf",
"source_value": "abc"
}
},
"issued_by": {
"value": "US",
"source_value": "<string>"
},
"number": "1234567890",
"sub_type": "H1B",
"type": "visa",
"valid_from": "2021-01-01T00:00.000Z",
"valid_to": "2021-01-01T00:00.000Z",
"passthrough": {
"other_known_names": "John Doe"
}
}'
This response has no body data.