Archives or unarchives the project status with the specified id. | awork API

Archives or unarchives the project status with the specified id. An archived project status still exists for all projects currently using it, but projects can no longer be moved to this status.

Authentication

AuthorizationBearer

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

Path parameters

projectStatusIdstringRequiredformat: "uuid"

The id of the status which will be changed.

Request

The model to archive or unarchive the project type.

isArchivedbooleanRequired

Flags the entity as archived.

Response

idstring or nullformat: "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.

createdOnstring or nullformat: "date-time"

The date this entity was created.

createdBystring or nullformat: "uuid"

The id of the user who created this entity.

updatedOnstring or nullformat: "date-time"

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.

updatedBystring or nullformat: "uuid"

The id of the user who last modified this entity.

1	curl -X POST https://api.awork.com/api/v1/projectstatuses/projectStatusId/setarchived \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"isArchived": true
6	}'

1	{
2	"id": "123e4567-e89b-12d3-a456-426614174000",
3	"name": "In Progress",
4	"type": "progress",
5	"order": 2,
6	"createdOn": "2024-01-15T09:30:00Z",
7	"createdBy": "123e4567-e89b-12d3-a456-426614174000",
8	"updatedOn": "2024-01-15T09:30:00Z",
9	"projectTemplateId": "123e4567-e89b-12d3-a456-426614174000",
10	"projectId": "123e4567-e89b-12d3-a456-426614174000",
11	"updatedBy": "123e4567-e89b-12d3-a456-426614174000"
12	}