Set labels for an issue

PUT

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

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

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PUT 'https://api.github.com/repos///issues//labels' \
--header 'Content-Type: application/json' \
--data-raw '{
    "labels": [
        "bug",
        "enhancement"
    ]
}'

Response Example

200 - Example 1

[
    {
        "color": "FFFFFF",
        "default": true,
        "description": "Something isn't working",
        "id": 208045946,
        "name": "bug",
        "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=",
        "url": "https://api.github.com/repositories/42/labels/bug"
    }
]

Request

Path Params

owner

string

required

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

repo

string

required

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

issue_number

integer

required

The number that identifies the issue.

Body Params application/json

optional

labels

array[string]

optional

The names of the labels to set for the issue. The labels you set replace any existing labels. You can pass an empty array to remove all labels. Alternatively, you can pass a single label as a string or an array of labels directly, but GitHub recommends passing an object with the labels key. You can also add labels to the existing labels for an issue. For more information, see "Add labels to an issue."

>= 1 items

Examples

Responses

🟢200Response

application/json

Body

array of:

color

string

required

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

Example:

FFFFFF

default

boolean

required

Example:

true

description

string | null

required

Example:

Something isn't working

integer <int64>

required

Example:

208045946

name

string

required

The name of the label.

Example:

bug

node_id

string

required

Example:

MDU6TGFiZWwyMDgwNDU5NDY=

url

string <uri>

required

URL for the label

Example:

https://api.github.com/repositories/42/labels/bug

🔵301301

🟠404404

🟠410410

🟠422422

Modified at 2023-08-15 02:59:27

Add labels to an issue

Remove a label from an issue