latestOpenAPI 3.0.3raw.githubusercontent.com2026-08-167449145.8 KB

6965ecf3ab92

Issue

Update issue

Update the issue by its ID.

patch/v1/issues/{id}

Request body

kind'epic' | 'story' | 'task' | 'bug'

Kind of the issue.

titlestring

Title of the issue.

descriptionstring nullable

Description of the issue.

Status of the issue.

priority'lowest' | 'low' | 'normal' | 'high' | 'highest'

Priority of the issue.

Resolution of the issue.

due_datestring date-time nullable

Due date of the issue.

assigneesstring[]

IDs of users assigned to the issue. Empty array clears assignees.

reviewersstring[]

IDs of users reviewing the issue. Empty array clears reviewers.

labelsstring[]

IDs of labels attached to the issue. Empty array clears labels.

start_datestring date-time nullable

Start date of the issue.

parentstring nullable

ID of the parent issue. Null clears the parent. Omitted leaves the parent unchanged.

Example request

{
  "kind": "story",
  "title": "Implement authentication",
  "description": "Add OAuth2 password and authorization code flows.",
  "status": "open",
  "priority": "normal",
  "resolution": "none",
  "links": [
    {
      "url": "https://example.com/ticket/1",
      "label": "Design spec"
    }
  ],
  "parent": "9bsv0s46s6s002p9ltq0"
}

Response

idstring required

Unique identifier of the issue.

keystring required

Composite issue key built from the owner project key and numeric ID.

numeric_idinteger required

Numeric identifier of the issue within its project.

kind'epic' | 'story' | 'task' | 'bug' required

Kind of the issue.

titlestring required

Title of the issue.

descriptionstring nullable

Description of the issue.

Status of the issue.

priority'lowest' | 'low' | 'normal' | 'high' | 'highest' required

Priority of the issue.

Resolution of the issue.

comment_countinteger nullable

Number of comments on the issue when projected.

attachment_countinteger nullable

Number of attachments on the issue when projected.

watcher_countinteger nullable

Number of users watching the issue when projected.

relation_countinteger nullable

Number of related issues when projected.

due_datestring date-time nullable

Due date of the issue.

start_datestring date-time nullable

Start date of the issue.

created_atstring date-time required

Date when the issue was created.

updated_atstring date-time nullable required

Date when the issue was updated.

Example response

{
  "id": "9bsv0s46s6s002p9ltq0",
  "key": "MOB-1",
  "numeric_id": 1,
  "parent": {
    "id": "9bsv0s46s6s002p9ltq0",
    "key": "MOB-1",
    "numeric_id": 1,
    "kind": "story",
    "title": "Implement authentication",
    "description": "Add OAuth2 password and authorization code flows.",
    "status": "open",
    "priority": "normal",
    "reported_by": {
      "id": "9bsv0s46s6s002p9ltq0",
      "first_name": "Test",
      "last_name": "User",
      "picture": "https://example.com/users/my-user.png"
    },
    "assignees": [
      {
        "id": "9bsv0s46s6s002p9ltq0",
        "first_name": "Test",
        "last_name": "User",
        "picture": "https://example.com/users/my-user.png"
      }
    ],
    "reviewers": [
      {
        "id": "9bsv0s46s6s002p9ltq0",
        "first_name": "Test",
        "last_name": "User",
        "picture": "https://example.com/users/my-user.png"
      }
    ],
    "labels": [
      {
        "id": "9bsv0s46s6s002p9ltq0",
        "name": "frontend"
      }
    ],
    "project": {
      "id": "9bsv0s46s6s002p9ltq0",
      "key": "ENG",
      "name": "Engineering Project",
      "description": "Main engineering project",
      "logo": "https://example.com/logo.png",
      "status": "active"
    },
    "namespace": {
      "id": "9bsv0s46s6s002p9ltq0",
      "name": "Engineering"
    }
  },
  "kind": "story",
  "title": "Implement authentication",
  "description": "Add OAuth2 password and authorization code flows.",
  "status": "open",
  "priority": "normal",
  "resolution": "none",
  "reported_by": {
    "id": "9bsv0s46s6s002p9ltq0",
    "first_name": "Test",
    "last_name": "User",
    "picture": "https://example.com/users/my-user.png"
  },
  "assignees": [
    {
      "id": "9bsv0s46s6s002p9ltq0",
      "first_name": "Test",
      "last_name": "User",
      "picture": "https://example.com/users/my-user.png"
    }
  ],
  "reviewers": [
    {
      "id": "9bsv0s46s6s002p9ltq0",
      "first_name": "Test",
      "last_name": "User",
      "picture": "https://example.com/users/my-user.png"
    }
  ],
  "labels": [
    {
      "id": "9bsv0s46s6s002p9ltq0",
      "name": "frontend"
    }
  ],
  "project": {
    "id": "9bsv0s46s6s002p9ltq0",
    "key": "ENG",
    "name": "Engineering Project",
    "description": "Main engineering project",
    "logo": "https://example.com/logo.png",
    "status": "active"
  },
  "namespace": {
    "id": "9bsv0s46s6s002p9ltq0",
    "name": "Engineering"
  },
  "comment_count": 3,
  "attachment_count": 1,
  "watcher_count": 2,
  "links": [
    {
      "url": "https://example.com/ticket/1",
      "label": "Design spec"
    }
  ]
}