git.labels.set-pull-request-labels

Replace a pull request’s labels

PUT /git/api/repositories/{repoId}/pulls/{prNumber}/labelsIAM git:UpdateIssueChanges state

Workflows see them as github.event.pull_request.labels (contains(github.event.pull_request.labels.*.name, …)).

Request syntax

PUT /git/api/repositories/{repoId}/pulls/{prNumber}/labels
{
  "labels": "array of string"
}

Path parameters

  • repoIdRequired

    string

    Constraints: uuid

  • prNumberRequired

    number

    Constraints: integer, min 1

Request body

  • labelsRequired

    array of string

    Label names replacing the current set (empty removes all); each must exist in the repository

    Constraints: 1-50 chars

Response

200 with the labels the pull request carries now, as `list` shows them. 422 names a label 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 label id
  • [].​orgIdAlways

    string

    The organization it belongs to
  • [].​repoIdAlways

    string

    The repository it belongs to
  • [].​nameAlways

    string

    The label name, unique within the repository
  • [].​colorAlways

    string

    Six hex digits, without #
  • [].​descriptionAlways

    string, may be null

    What the label means; null when none was given
  • [].​createdAtAlways

    string

    When it was created (ISO 8601)

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 labels set-pull-request-labels repoId prNumber --labels '["example"]'

Generated from the API description, the same one the API checks requests against and the CLI is built from. MCP tool: dcloud_git_labels_set-pull-request-labels.