workflows

Updates a task status for the specified workflow.

Changed on

Updates a task status for the specified workflow. Linked projects use the submitted status settings.

<Check title="Required Permissions" icon="key">The user must be an admin or have project-manage-config:write permissions.</Check>

put/workflows/{workflowId}/taskstatuses/{taskStatusId}

Request

  • Base URL: https://api.awork.com/api/v1
  • URL: https://api.awork.com/api/v1/workflows/{workflowId}/taskstatuses/{taskStatusId}
  • Auth: HTTP bearer

Path parameters

workflowIdstring uuid required
taskStatusIdstring uuid required

Request body

namestring required

The name of the task status.

typestring required

Specifies the general type of this task status. Accepted values: 'todo', 'progress', 'review', 'stuck', 'done'.

ordernumber double nullable

The order of the task status. If it is null, the task status will be appended after the last task status.

iconstring nullable

The icon of the task status.

Response

OK

idstring uuid

The primary identifier of this task status.

namestring nullable

The name of the task status.

typestring nullable

Of what general type is this task status?.

ordernumber double nullable

The order of the task status in a project.

iconstring nullable

The icon of the task status.

projectIdstring uuid nullable

Is set if the task status is related to a project.

projectTypeIdstring uuid nullable

Is set if the task status is related to a project type.

workflowIdstring uuid nullable

Is set if the task status is related to a workflow.

createdOnstring date-time

The date this entity was created.

createdBystring uuid

The id of the user who created this entity.

updatedOnstring date-time

The date this entity was last modified.

updatedBystring uuid

The id of the user who last modified this entity.

isExternalboolean

True if the task status is coming from an external workspace (awork Connect).

Changes

  • 1556e0487867Revision changes
    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security oauth2 was added to the API

  • 8e46cf415581Revision changes
    • info

      api operation id PutWorkflowTaskStatusByWorkflowIdAndTaskStatusId removed and replaced with workflows_PutWorkflowTaskStatusByWorkflowIdAndTaskStatusId