API ReferenceTask Status

Create TaskStatus

Creates a new TaskStatus level for a specific Project within your Workspace. A TaskStatus is a named status level used by your business to determine how to measure the progress of Tasks. You can define your own named status levels that are appropriate for your business.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

projectIdstringRequiredformat: "uuid"
The unique identifier of the Project for the new TaskStatus

Headers

x-integration-namestringOptional
The name of the calling system passed along as a header parameter

Request

Information about the new TaskStatus level to create within this Project
namestringRequired>=1 character
The name of this TaskStatus.
idstring or nullOptionalformat: "uuid"
The unique identifier of this TaskStatus.
orderinteger or nullOptional
A numerical value that can be used to sort TaskStatus values according to the needs of your business.
isDoneboolean or nullOptional
A numerical value that can be used to sort TaskStatus values according to the needs of your business.

Response

Success
errorobject or null
If the API call failed, this will contain information about the error that occurred.
successboolean or null

True if the API call succeeded; false otherwise.

hasErrorboolean or null
True if the API call failed.
statusCodeenum or null
The HTTP code of the response.
dataobject or null
A TaskStatus is a named status level used by your business to determine how to measure the progress of Tasks. You can define your own named status levels that are appropriate for your business and determine which status levels are considered done.