Task

Close

Close a task, ending its workflow. Async — returns a ticketActionId on accept and queues the close; the task's state field is not updated synchronously. Poll task_service_get to observe the transition to TASK_STATE_CLOSED. When the task has an active provision step, close may no-op — finish or cancel the provision step first (mark_provision_complete / _errored / _cancelled) before closing.

post/api/v1/tasks/{task_id}/action/close

Path parameters

task_idstring required

The ID of the task to close.

Request body

commentstring

An optional comment attached to the close action.

Response

The TaskActionsServiceCloseResponse returns a task view with paths indicating the location of expanded items in the array.

taskActionIdstring

The ID of the task close action created by this request.

Changes