Sign in

v16

latestOpenAPI 3.0.3raw.githubusercontent.com2026-08-075922107.5 KB
Project

Update project

Update the project by its ID.

patch/v1/projects/{id}

Request body

keystring

Key of the project.

namestring

Name of the project.

descriptionstring nullable

Description of the project.

logostring uri nullable

Logo of the project.

status'active' | 'pending'

Status of the project.

Example request

{
  "key": "ENG",
  "name": "Engineering Project",
  "description": "Main engineering project",
  "logo": "https://example.com/logo.png",
  "status": "active"
}

Response

OK

idstring required

Unique identifier of the project.

keystring required

Key of the project.

namestring required

Name of the project.

descriptionstring nullable

Description of the project.

logostring uri nullable

Logo of the project.

status'active' | 'pending' required

Status of the project.

teamsstring[] required

IDs of the teams in the project.

issuesstring[] required

IDs of the issues in the project.

created_atstring date-time required

Date when the project was created.

updated_atstring date-time nullable required

Date when the project was updated.

Example response

{
  "id": "9bsv0s46s6s002p9ltq0",
  "key": "ENG",
  "name": "Engineering Project",
  "description": "Main engineering project",
  "logo": "https://example.com/logo.png",
  "status": "active",
  "teams": [
    "9bsv0s46s6s002p9ltq0"
  ],
  "documents": [
    {
      "id": "9bsv0s46s6s002p9ltq0",
      "name": "Project Plan",
      "excerpt": "Overview of the project plan",
      "created_by": "9bsv0s46s6s002p9ltq0"
    }
  ],
  "issues": [
    "9bsv0s46s6s002p9ltq0"
  ]
}