Skip to main content
PATCH
Update a tag definition

Authorizations

Authorization
string
header
required

A Recursion API key, created in the console under API keys.

Path Parameters

tag_id
string<uuid>
required

Tag id (UUID) as returned by createTag or listTags.

Body

application/json

Request body for changing a tag definition. Every field is optional and tag applications remain unchanged.

color
string

Replacement display color in #RRGGBB form. Omit to keep the current color.

Required string length: 7
Pattern: ^#[0-9A-Fa-f]{6}$
Example:

"#14b8a6"

description
string

Replacement description. Send an empty string to clear it; omit to keep the current description.

Maximum string length: 280
label
string

Replacement display label. Leading and trailing whitespace is removed. Omit to keep the current label.

Required string length: 1 - 32

Response

An organization-scoped classification definition. Applying or removing it changes only catalog membership: it does not update the agent, mint an AgentVersion, or affect running sessions.

An organization-scoped classification definition. Applying or removing it changes only catalog membership: it does not update the agent, mint an AgentVersion, or affect running sessions.

color
string
required

Display color in #RRGGBB form.

Required string length: 7
Pattern: ^#[0-9A-Fa-f]{6}$
Example:

"#14b8a6"

created_at
string<date-time>
required

Server-assigned RFC 3339 timestamp of when the tag was created.

label
string
required

Display label, trimmed by the service. Unique case-insensitively among live tags in this organization.

Required string length: 1 - 32
organization_id
string
required

Organization that owns the tag. Server-assigned from the authenticated principal and never accepted as authority from the request body.

tag_id
string<uuid>
required

Server-assigned tag id (UUID).

updated_at
string<date-time>
required

Server-assigned RFC 3339 timestamp of the most recent definition update.

description
string

Optional operator-facing explanation of the classification, up to 280 characters.

Maximum string length: 280