v1

latestOpenAPI 3.1.02026-07-1274177461.2 KB

Employees

Tasks

Update Employee Task

patch/unified/hris/employees/{id}/tasks/{subResourceId}

Path parameters

idstring required

subResourceIdstring required

Headers

x-account-idstring required

The account identifier

Preferstring

Example:heartbeat

Set to "heartbeat" to enable keep-alive newline heartbeats during long-running requests. Response includes Preference-Applied: heartbeat header when honored. (RFC 7240)

Request body

commentstring nullable

Comment or note about the task update

Example request

{
  "comment": "All required documents have been submitted",
  "status": {
    "value": "open"
  }
}

Response

The task has been successfully updated.

statusCodenumber required

messagestring required

timestampstring date-time required

Example response

{
  "statusCode": 200,
  "message": "Record updated successfully.",
  "timestamp": "2021-01-01T01:01:01.000Z"
}