workflows

Updates a project status for the workflow.

Changed on

Updates a project status for the 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}/projectstatuses/{projectStatusId}

Request

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

Path parameters

workflowIdstring uuid required
projectStatusIdstring uuid required

Request body

namestring required

The name of the project status.

typestring required

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

Response

OK

idstring uuid

The primary identifier of this project status.

namestring nullable

The name of the project status.

typestring nullable

The general type of this project status.

isArchivedboolean

Indicates whether this status is archived.

orderinteger nullable

The order of this status.

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.

projectTemplateIdstring uuid nullable

The id of the project template of the status.

projectIdstring uuid nullable

The id of the project the status belongs to.

workflowIdstring uuid nullable

The id of the workflow linked to this project status.

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

Changes