Skip to main content
PATCH
Update a tag

Authorizations

Authorization
string
header
required

OAuth 2.0 access token for a connected application. Limited to the scopes granted at consent.

Headers

authorization
string
required

Bearer token for API authentication

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

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