Sign in

v1

latestOpenAPI 3.1.02026-08-066984441.1 MB
taskStatuses

Updates a task status for the specified project.

The status type cannot be changed if it is the last status of type 'todo' or 'done'.

         <Check title="Required Permissions" icon="key">The user must either have `project-planning-data:write` permissions or be creator of the project.</Check>
put/projects/{projectId}/taskstatuses/{taskStatusId}

Path parameters

projectIdstring uuid required

The id of the project.

taskStatusIdstring uuid required

The id of the task status to update.

Headers

Authorizationstring required

Bearer authentication

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).