apidocs

UpdateTaskStatus API

Updates the status, finish date, and comment of a workflow task in a single call. This is the composite operation that mirrors the UPDATESTATUS form submission in the task UI — it saves the comment first, then applies the new status and finish date.

Endpoint

/srv.asmx/UpdateTaskStatus

Methods

Parameters

Parameter Type Required Description
authenticationTicket string Yes Authentication ticket obtained from AuthenticateUser
taskId integer Yes Unique numeric ID of the task to update
taskStatus integer Yes New task status: -2=Reassigned, -1=Dropped, 0=NotStarted, 10=InProgress, 20=DueDateChanged, 30=Completed
finishDate DateTime Yes Actual finish date. Honoured only when status is Completed or Dropped and the assignee has ChangeFinishDate permission; otherwise the current time is used. Pass 0001-01-01T00:00:00 to omit
comments string No User comment to record on the task. Pass an empty string to clear an existing comment

Response

Success Response

<root success="true"/>

Error Response

<root success="false" error="[ErrorCode] Error message"/>

Required Permissions

The calling user must be the task assignee. When taskStatus is 30 (Completed), all task requirements (Approval, Sign, ISOReview, etc.) must be satisfied first — use TestTaskCompletion to verify readiness before calling this API.

Behavior Notes

Example

Request (POST)

POST /srv.asmx/UpdateTaskStatus HTTP/1.1
Content-Type: application/x-www-form-urlencoded

authenticationTicket=abc123&taskId=42&taskStatus=30&finishDate=2026-04-15T10:00:00&comments=Review+complete

Request (GET)

GET /srv.asmx/UpdateTaskStatus?authenticationTicket=abc123&taskId=42&taskStatus=30&finishDate=2026-04-15T10:00:00&comments=Review+complete