git.issues.update

Edit, close or reopen an issue; replace its labels or assignees

PATCH /git/api/repositories/{repoId}/issues/{number}IAM git:UpdateIssueChanges state

Request syntax

PATCH /git/api/repositories/{repoId}/issues/{number}
{
  "title": "string",
  "body": "string",
  "state": "enum",
  "stateReason": "enum",
  "labels": "array of string",
  "assigneeIamUserIds": "array of string"
}

Path parameters

  • repoIdRequired

    string

    Constraints: uuid

  • numberRequired

    number

    Constraints: integer, min 1

Request body

  • titleOptional

    string

    The new title

    Constraints: 1-256 chars

  • bodyOptional

    string

    The new description (Markdown); null clears it

    Constraints: max 65536 chars

    May be null.

  • stateOptional

    enum

    `closed` closes the issue, `open` reopens it

    One of: open, closed

  • stateReasonOptional

    enum

    Why it is closed; completed when absent

    One of: completed, not_planned

  • labelsOptional

    array of string

    Replaces the labels; each name must exist in the repository

    Constraints: 1-50 chars

  • assigneeIamUserIdsOptional

    array of string

    Replaces the assignees: IAM users of the organization

    Constraints: uuid

Response

200 with the issue after the change, with its `labels` and `assigneeIamUserIds`. 422 names a label or IAM user that does not exist.

A JSON response is wrapped as { "success": true, "data": … }; the CLI prints the whole body with --json.

Fields of data

  • idAlways

    string

    The issue id
  • orgIdAlways

    string

    The organization it belongs to
  • repoIdAlways

    string

    The repository it belongs to
  • numberAlways

    number

    Its number, shared with pull requests in one sequence per repository
  • titleAlways

    string

    The title
  • bodyAlways

    string, may be null

    The description (Markdown); null when there is none
  • stateAlways

    one of open, closed

    Whether it is open or closed
  • stateReasonAlways

    one of completed, not_planned, may be null

    Why it was closed (done, or not going to be done); null while open
  • authorIamUserIdAlways

    string, may be null

    The IAM user who opened it; null once that user is deleted
  • closedAtAlways

    string, may be null

    When it was closed (ISO 8601); null while open
  • createdAtAlways

    string

    When it was opened (ISO 8601)
  • updatedAtAlways

    string

    When it last changed or was commented on (ISO 8601)
  • labelsAlways

    array of object

    The labels it carries
  • labels[].​idAlways

    string

    The label id
  • labels[].​nameAlways

    string

    The label name
  • labels[].​colorAlways

    string

    Six hex digits, without #
  • assigneeIamUserIdsAlways

    array of string

    The IAM users it is assigned to

Checked against the handlers: every route test validates their answers against this schema.

Errors

  • 400The request does not pass the schema above. The body is { "error": …, "issues": […] }, one issue per field.
  • 401No credentials, or an access key that is unknown, revoked or expired.
  • 403The caller's policies do not allow git:UpdateIssue on this resource. The body names the action and the resource, and the refusal is recorded in the audit log.
  • 404The resource does not exist in your organization.

Examples

The required parameters only, with example values. Replace id and the other placeholders with your own.

dcloud git issues update repoId number

Generated from the API description, the same one the API checks requests against and the CLI is built from. MCP tool: dcloud_git_issues_update.