Skip to main content
PATCH
Update a tag
PATCH /v1/tag/{tag_id} requires Tags: Write (tags.update).
Both fields are optional, but at least one is required. Renaming also regenerates normalized name. color accepts blue, green, yellow, red, gray, purple, pink, cyan, or null. Use gray or null for the default gray style; the response returns that default as null. Unsupported colors return 422 validation_error. Success returns the updated complete tag; conflicts return 409 tag_name_taken.

Shared API behavior

Authentication is workspace-scoped; see Authentication. Errors use the standard envelope and request IDs described in Errors, and requests are subject to Rate limits.

Authorizations

Authorization
string
header
required

A workspace API key beginning with biqli_.

Path Parameters

tag
string
required
Pattern: ^biq_tag_[0-9A-HJKMNP-TV-Z]{26}$

Body

application/json
display_name
string
Required string length: 2 - 100
color
enum<string> | null

Supported dashboard color. gray and null both select the default gray style, which responses represent as null.

Available options:
blue,
green,
yellow,
red,
gray,
purple,
pink,
cyan,
null

Response

Updated tag.

tag
object
required
status
string
required
Allowed value: "success"