Skip to main content
PATCH
Update a tag
Updates the supplied fields of one tag. Omitted fields keep their current values. Branded and Non-branded are reserved system tag names, whatever the case. You cannot update one of these two system tags or rename another tag to either name. Requires an active Business, Agency Business or Enterprise plan. Use an API token with write access enabled. See Writing data for idempotency, conditional requests and error handling.
string
required
Bearer token for your team.
string
required
Copy the complete ETag from the latest GET, including its quotes.
string
required
Workspace identifier. The workspace must belong to the token’s team.
string
required
Tag identifier within this workspace.
string
Tag name, 1 to 120 characters after trimming.
string | null
A six-digit hex color, such as #7B3AEE. Set null to clear it.
Supply at least one of name or color.

Response

Returns 200 with a tag object in the same shape as Get a tag and a new ETag. The mutation response has no top-level success field. Treat versions as opaque values, not counters.

Synthetic request and response

Read the current tag first. This example assumes its ETag is "4".

Errors

See Error codes for authentication, plan, idempotency and server errors. On 429, honor Retry-After; writes can return 503 SERVICE_UNAVAILABLE if the write limiter is unavailable.