issues

Set labels for an issue

Changed on

Removes any previous labels and sets the new labels for an issue.

put/repos/{owner}/{repo}/issues/{issue_number}/labels

Request

  • Base URL: https://api.github.com
  • URL: https://api.github.com/repos/{owner}/{repo}/issues/{issue_number}/labels
  • Auth: none declared

Path parameters

ownerstring required

The account owner of the repository. The name is not case sensitive.

repostring required

The name of the repository without the .git extension. The name is not case sensitive.

issue_numberinteger required

The number that identifies the issue.

Request body

OR
string[] required
OR
OR
OR
string required

Response

Response

idinteger required

Unique identifier for the label.

node_idstring required
urlstring uri required

URL for the label

namestring required

The name of the label.

descriptionstring nullable required

Optional description of the label, such as its purpose.

colorstring required

6-character hex code, without the leading #, identifying the color

defaultboolean required

Whether this label comes by default in a new repository.

archived_atstring date-time nullable required

Timestamp indicating when the label was archived, or null if it has not been archived.

Example response

[
  {
    "id": 208045946,
    "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=",
    "url": "https://api.github.com/repositories/42/labels/bug",
    "name": "bug",
    "description": "Something isn't working",
    "color": "FFFFFF",
    "default": true,
    "archived_at": "2023-01-01T12:00:00Z",
    "archived_by": {
      "login": "octocat",
      "id": 1,
      "node_id": "MDQ6VXNlcjE=",
      "avatar_url": "https://github.com/images/error/octocat_happy.gif",
      "gravatar_id": "41d064eb2195891e12d0413f63227ea7",
      "url": "https://api.github.com/users/octocat",
      "html_url": "https://github.com/octocat",
      "followers_url": "https://api.github.com/users/octocat/followers",
      "following_url": "https://api.github.com/users/octocat/following{/other_user}",
      "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
      "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
      "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
      "organizations_url": "https://api.github.com/users/octocat/orgs",
      "repos_url": "https://api.github.com/users/octocat/repos",
      "events_url": "https://api.github.com/users/octocat/events{/privacy}",
      "received_events_url": "https://api.github.com/users/octocat/received_events",
      "type": "User",
      "starred_at": "\"2020-07-09T00:17:55Z\"",
      "user_view_type": "public"
    }
  }
]

Changes

  • 2022-11-28a2954a79ff13Revision changes
    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status