API v1 Reference › TaskStatuses

Creates a task status for the specified project.

POSThttps://api.awork.com/api/v1/projects/{projectId}/taskstatuses
POST https://api.awork.com/api/v1/projects/{projectId}/taskstatuses

Creates a task status for the specified project.

Authentication

AuthorizationBearer

Send your token in the Authorization: Bearer <token> header. See Authentication for API keys and OAuth.

Path parameters

projectIdstringRequired
format: uuid

The id of the project.

Request body Required

The model used to create the task status.

application/json

namestringRequired
minLength: 1 maxLength: 30

The name of the task status.

typestringRequired
minLength: 1

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

ordernumber or nullOptional
format: double

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

iconstring or nullOptional

The icon of the task status.

Responses

200 OK

application/json

idstringOptional
format: uuid

The primary identifier of this task status.

namestring or nullOptional

The name of the task status.

typestring or nullOptional

Of what general type is this task status?.

ordernumber or nullOptional
format: double

The order of the task status in a project.

iconstring or nullOptional

The icon of the task status.

projectIdstring or nullOptional
format: uuid

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

projectTypeIdstring or nullOptional
format: uuid

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

workflowIdstring or nullOptional
format: uuid

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

createdOnstringOptional
format: date-time

The date this entity was created.

createdBystringOptional
format: uuid

The id of the user who created this entity.

updatedOnstringOptional
format: date-time

The date this entity was last modified.

updatedBystringOptional
format: uuid

The id of the user who last modified this entity.

isExternalbooleanOptional

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

400 Bad Request

application/json

codestringRequired
minLength: 1

The error code.

descriptionstringRequired
minLength: 1

The description of the error.

linkstringRequired
minLength: 1

The link to the API documentation page.

detailsarray of string or nullOptional

A list of details describing the error.

validationErrorsarray of object or nullOptional

If a validation error occurred, this contains the validation errors for each property.

Show 2 properties
propertystring or nullOptional

The name of the property that failed validation.

messagestring or nullOptional

The reason why this property failed validation.

traceIdstring or nullOptional

The request trace id for tracking the request.

401 Unauthorized

application/json

codestringRequired
minLength: 1

The error code.

descriptionstringRequired
minLength: 1

The description of the error.

linkstringRequired
minLength: 1

The link to the API documentation page.

detailsarray of string or nullOptional

A list of details describing the error.

validationErrorsarray of object or nullOptional

If a validation error occurred, this contains the validation errors for each property.

Show 2 properties
propertystring or nullOptional

The name of the property that failed validation.

messagestring or nullOptional

The reason why this property failed validation.

traceIdstring or nullOptional

The request trace id for tracking the request.

404 Not Found

application/json

codestringRequired
minLength: 1

The error code.

descriptionstringRequired
minLength: 1

The description of the error.

linkstringRequired
minLength: 1

The link to the API documentation page.

detailsarray of string or nullOptional

A list of details describing the error.

validationErrorsarray of object or nullOptional

If a validation error occurred, this contains the validation errors for each property.

Show 2 properties
propertystring or nullOptional

The name of the property that failed validation.

messagestring or nullOptional

The reason why this property failed validation.

traceIdstring or nullOptional

The request trace id for tracking the request.

Search documentation