Sign in
latestOpenAPI 3.1.02026-08-211061591.1 MB

69a962f1578f

Labels

Update Label

Update a personal label.

At least one mutable field must be provided. Passing null for an optional field keeps the existing value unchanged.

post/api/v1/labels/{label_id}

Path parameters

label_idinteger required

String ID of the label

Request body

namestring nullable

Updated label name. Passing null or omitting this field will leave it unchanged.

orderinteger nullable

Position of the label in the label list. Passing null or omitting this field will leave it unchanged.

is_favoriteboolean nullable

Whether the label is marked as a favorite. Passing null or omitting this field will leave it unchanged.

Example request

{
  "name": "Priority",
  "order": 12,
  "is_favorite": true
}

Response

Successful Response

idstring required

String ID of the label.

namestring required

Label name.

colorstring required

Label color name.

orderinteger nullable required

Position of the label in the label list, or null when no explicit order is set.

is_favoriteboolean required

Whether the label is marked as a favorite.

Example response

{
  "id": "2147509004",
  "name": "Priority",
  "color": "berry_red",
  "order": 12
}