Skip to main content

Update tag

PATCH 
/v2/boards/:board_id/tags/:tag_id

Updates a tag based on the data properties provided in the request body.
Note: Updates to tags made via the REST API will not be reflected on the board in realtime. To see REST API updates to tags on a board, you need to refresh the board. This applies to the following endpoints: Attach tag to item, Remove tag from item, Delete tag.

Required scope

boards:write

Rate limiting

Level 1

Request​

Path Parameters

    board_id stringrequired

    Unique identifier (ID) of the board where you want to update a specific tag.

    tag_id stringrequired

    Unique identifier (ID) of the tag that you want to update.

Body

required

    fillColor string

    Possible values: [red, light_green, cyan, yellow, magenta, green, blue, gray, violet, dark_green, dark_blue, black]

    Default value: red

    Fill color for the tag.

    title string

    Possible values: <= 120 characters

    Text of the tag. Case-sensitive. Must be unique.

Responses​

Tag updated

Schema

    id stringrequired

    Unique identifier of the tag.

    title stringrequired

    Text of the tag

    fillColor stringrequired

    Possible values: [red, light_green, cyan, yellow, magenta, green, blue, gray, violet, dark_green, dark_blue, black]

    Background color of the tag.

    links

    object

    Contains applicable links for the current object.

    self string

    Link to obtain more information about the current object.

    type stringrequired

    Type of the object that is returned. In this case, type returns tag.

Loading...