Update company-defined attributes
Changed onReturns an employee's company-defined attributes
patch/employees/{employee}/company_defined_attributes (COPY)
Request
- Base URLhttps://sandbox.checkhq.com
- AuthAPI key in header Authorization
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
employeestring required
ID of the employee to return
Request body
Response
200
Example response
{
"company_defined_attributes": [
{
"label": "Corporate officer status",
"description": "This employee is an owner or corporate officer of the business",
"name": "corporate_officer",
"value": "true",
"type": "boolean",
"effective_start": "2022-07-14"
}
]
}Changes
- info
endpoint added
- info