API ReferenceTags

Update tag

View as Markdown

Updates a single workspace tag. Requires the tags:write scope.

Authentication

AuthorizationBearer

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

Path parameters

tag_idstringRequired

Request

This endpoint expects an object.
namestringOptional1-255 characters
descriptionstring or nullOptional1-2000 characters
hex_colorstring or nullOptionalformat: "^#[A-Fa-f0-9]{6}$"
auto_tagging_enabledbooleanOptional

Response headers

X-RateLimit-Limitinteger

Maximum number of authenticated requests allowed for the workspace in the current 60-second window. The limit is 1000 and applies to all /api/v2 resource routes (GET, POST, PATCH, and DELETE), shared across every credential for the workspace.

X-RateLimit-Remaininginteger
Number of requests remaining in the current window before the limit is exceeded.
X-RateLimit-Resetinteger

Unix epoch seconds when the current rate-limit window resets.

X-Api-VersionstringOptional

Response

Updated tag response.
objectenum
Allowed values:
idstringformat: "^tag_[A-Za-z0-9]+$"
namestring
created_atdatetime
updated_atdatetime
hex_colorstring or nullOptionalformat: "^#[A-Fa-f0-9]{6}$"
descriptionstring or nullOptional
auto_tagging_enabledbooleanOptional

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error