Creates a project status for a project. | awork API

import requests
url = "https://api.awork.com/api/v1/projects/projectId/projectstatuses"
payload = {
    "name": "In Progress",
    "type": "progress"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.json())

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "In Progress",
  "type": "progress",
  "order": 2,
  "createdOn": "2024-01-15T09:30:00Z",
  "createdBy": "123e4567-e89b-12d3-a456-426614174000",
  "updatedOn": "2024-01-15T09:30:00Z",
  "projectTemplateId": "123e4567-e89b-12d3-a456-426614174000",
  "projectId": "123e4567-e89b-12d3-a456-426614174000",
  "workflowId": "123e4567-e89b-12d3-a456-426614174000",
  "updatedBy": "123e4567-e89b-12d3-a456-426614174000",
  "isExternal": true
}

Required Permissions

Any authenticated user.

<Check title="Required Permissions" icon="key">Any authenticated user.</Check>

Authentication

AuthorizationBearer

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

Path parameters

projectIdstringRequiredformat: "uuid"

The id of the project.

Request

The model to create the project status.

namestringRequired0-255 characters

The name of the project status.

typestringRequired0-25 characters

Specifies the general type of this project status. Accepted values: ‘progress’, ‘not-started’, ‘closed’, ‘stuck

Response

idstringformat: "uuid"

The primary identifier of this project status.

namestring or null

The name of the project status.

typestring or null

The general type of this project status.

orderinteger or null

The order of this status.

createdOndatetime

The date this entity was created.

createdBystringformat: "uuid"

The id of the user who created this entity.

updatedOndatetime

The date this entity was last modified.

projectTemplateIdstring or nullformat: "uuid"

The id of the project template of the status.

projectIdstring or nullformat: "uuid"

The id of the project the status belongs to.

workflowIdstring or nullformat: "uuid"

The id of the workflow linked to this project status.

updatedBystringformat: "uuid"

The id of the user who last modified this entity.

isExternalboolean

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

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error