Employee

Update Engagement

Update an engagement record. All fields are optional — only provided fields are updated. When startDate is provided, it must not be later than the start date of any associated job.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

employeeUuidstringRequiredformat: "uuid"
User UUID of the employee
engagementUuidstringRequiredformat: "uuid"
UUID of the engagement to update

Headers

vnd.a1.tenant-idstringOptional

Tenant identifier for multi-tenant environments

Request

This endpoint expects an object.
payTypeenumOptional
Pay type for the engagement
Allowed values:
engagementTypeenumOptional

Type of engagement (not applicable for SUBCONTRACTOR)

Allowed values:
startDatedateOptional

Engagement start date — must not be later than any job’s start date

terminationDatedate or nullOptional

Engagement termination date — set to null to clear

terminationNotestringOptional
Note explaining termination reason
terminationReasonstringOptional
Termination reason code
terminationPayCyclestringOptional
Pay cycle at point of termination
hoursNormallyWorkedstringOptional
Classification of hours normally worked
payrollCompanyIdstringOptional
UUID of the payroll company
payCycleIdstringOptional
UUID of the pay cycle
engagementBasisstringOptional
irregularPaymentPatternbooleanOptional
offPayrollWorkerbooleanOptional

IR35 off-payroll worker flag

nonIndividualbooleanOptional
enableEncaseLeavebooleanOptional
supplierIdintegerOptional

ID of the linked supplier (SUBCONTRACTOR only)

Response

Engagement updated successfully
userUuidstring
eventJobIdstring

Errors

400
Bad Request Error
404
Not Found Error