issues

Update a label

Changed on

Updates a label using the given label name.

patch/repos/{owner}/{repo}/labels/{name}

Request

  • Base URL: https://api.github.com
  • URL: https://api.github.com/repos/{owner}/{repo}/labels/{name}
  • 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.

namestring required

Request body

new_namestring

The new name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing :strawberry: will render the emoji :strawberry:. For a full list of available emoji and codes, see "Emoji cheat sheet."

colorstring

The hexadecimal color code for the label, without the leading #.

descriptionstring

A short description of the label. Must be 100 characters or fewer.

archivedboolean

Whether to archive or unarchive the label. Archived labels cannot be added to issues or pull requests. For more information, see "Archiving labels."

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

  • 2026-03-106ea91bcbb8e2Revision changes
    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • 2026-03-1077bd502d6220Revision changes
    • info

      added the new optional request property