Skip to main content
PATCH
Update tag

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

The tag's unique ID.

Pattern: ^[0-9abcdefghjkmnpqrstvwxyz]{8}$
Example:

"a1b2c3d4"

Body

application/json

Payload to update a tag

color
enum<string>
default:DEFAULT

Tag color

Available options:
DEFAULT,
GRAY,
BROWN,
ORANGE,
YELLOW,
GREEN,
BLUE,
PURPLE,
PINK,
RED
Example:

"BLUE"

name
string

The tag name (3..50 chars). The slug is derived from this server-side and updates whenever name changes.

Required string length: 3 - 50
Example:

"Marketing"

Response

The updated tag.

A tag.

id
string
required

The tag's unique ID.

Pattern: ^[0-9abcdefghjkmnpqrstvwxyz]{8}$
Example:

"a1b2c3d4"

name
string
required
slug
string
required
color
enum<string>
required
Available options:
DEFAULT,
GRAY,
BROWN,
ORANGE,
YELLOW,
GREEN,
BLUE,
PURPLE,
PINK,
RED
workspaceId
string
required

ID of the workspace the tag belongs to.

creatorId
string
required

ID of the user who created the tag.

createdAt
string
required

ISO 8601 creation timestamp.

updatedAt
string
required

ISO 8601 timestamp of the last update.