Skip to main content
PATCH
Update a tag

Authorizations

Authorization
string
header
required

Personal API key, e.g. Authorization: Bearer sajn_sk_.... Not scope-limited — acts as the issuing user.

Headers

Sajn-Version
enum<string>

API version for this request. Without it, the request uses the organization's default version; an organization without a default is pinned to the latest version by its first request.

Available options:
2026-09,
2026-10
Sajn-Workspace
string

ID of the workspace this request acts in, from GET /api/v1/workspaces. Without it, an API key acts in its default workspace. The token's user must be a member of the workspace; an OAuth token only accepts the workspace it was granted for. A workspace that doesn't exist or can't be reached returns 403 WORKSPACE_ACCESS_DENIED.

Idempotency-Key
string

Makes retries safe. A retry with the same key and the same request replays the stored response for 24 hours (header Idempotent-Replayed: true); the same key with a different request returns 400.

Maximum string length: 255

Path Parameters

id
string
required

The tag ID.

Body

application/json

Body

name
string
Minimum string length: 1
color
string
Pattern: ^#[0-9A-F]{6}$
availableFor
enum<string>[]
Minimum array length: 1
Available options:
DOCUMENT,
TEMPLATE,
CONTACT

Response

200

id
string
required

Unique tag identifier

name
string
required

Tag name

color
string
required

Tag color in hex format (e.g., #FF5733)

availableFor
string[]
required

Where this tag can be used: DOCUMENT, TEMPLATE, and/or CONTACT

createdAt
string<date-time>
required

Date and time when tag was created

updatedAt
string<date-time>
required

Date and time when tag was last updated