Skip to main content
PATCH
Update Employee Task

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Headers

x-account-id
string
required

The account identifier

Prefer
string

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

Example:

"heartbeat"

Path Parameters

id
string
required
subResourceId
string
required

Body

application/json
comment
string | null

Comment or note about the task update

Example:

"All required documents have been submitted"

status
object | null

The status to apply to this Task

Example:

"blocked"

Response

The task has been successfully updated.

statusCode
number
required
Example:

200

message
string
required
Example:

"Record updated successfully."

timestamp
string<date-time>
required
Example:

"2021-01-01T01:01:01.000Z"