Update a label

PATCH

/repos/{owner}/{repo}/labels/{id}

const url = 'https://gitea.com/api/v1/repos/example/example/labels/example';
const options = {
  method: 'PATCH',
  headers: {Authorization: 'Basic <credentials>', 'Content-Type': 'application/json'},
  body: '{"color":"#00aabb","description":"example","exclusive":false,"is_archived":false,"name":"example"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request PATCH \
  --url https://gitea.com/api/v1/repos/example/example/labels/example \
  --header 'Authorization: Basic <credentials>' \
  --header 'Content-Type: application/json' \
  --data '{ "color": "#00aabb", "description": "example", "exclusive": false, "is_archived": false, "name": "example" }'

Authorizations

Parameters

Path Parameters

owner

required

string

Owner of the repo

repo

required

string

Name of the repo

required

string

Id of the label to edit, or its name when not numeric

Request Body

application/json

EditLabelOption

Options for editing a label

object

color

string

Example

#00aabb

description

Description provides additional context about the label’s purpose

string

exclusive

boolean

Example

false

is_archived

boolean

Example

false

name

Name is the new display name for the label

string

Responses

200

Label

application/json

Label

A label to an issue or a pr

object

color

string

description

Description provides additional context about the label’s purpose

string

exclusive

boolean

ID is the unique identifier for the label

integer format: int64

is_archived

boolean

name

Name is the display name of the label

string

url

URL is the API endpoint for accessing this label

string format: uri

Example

{
  "color": "00aabb",
  "exclusive": false,
  "is_archived": false
}

default

APIError is error format response

Headers

message

string

url

string