> ## Documentation Index
> Fetch the complete documentation index at: https://developers.vendaze.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Update a tag
> Updates a tag by its `id` (UUID) or `key` (string). Only fields included in the body are modified.
`tags:write`
## OpenAPI
````yaml /en/api-reference/openapi.json patch /v1/tags/{identifier}
openapi: 3.1.0
info:
title: OAuth 2.1
description: Endpoints for registering applications and managing OAuth 2.1 tokens.
version: 1.0.0
contact:
name: Vendaze Support
email: suporte@vendaze.com
servers:
- url: https://api.vendaze.com
description: Production
security:
- bearerAuth: []
tags:
- name: OAuth
- name: People
- name: Companies
- name: Deals
- name: Pipelines
- name: Tasks
- name: Task Types
- name: Products
- name: Tags
- name: Lists
- name: Custom Fields
- name: Webhooks
paths:
/v1/tags/{identifier}:
patch:
tags:
- Tags
summary: Update a tag
description: >-
Updates a tag by its `id` (UUID) or `key` (string). Only fields included
in the body are modified.
`tags:write`
operationId: updateTag
parameters:
- $ref: '#/components/parameters/identifier'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateTagRequest'
responses:
'200':
description: Tag updated successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/TagResponse'
'400':
$ref: '#/components/responses/BadRequest'
'401':
$ref: '#/components/responses/Unauthorized'
'403':
$ref: '#/components/responses/InsufficientScope'
'404':
$ref: '#/components/responses/NotFound'
'422':
$ref: '#/components/responses/ValidationError'
'429':
$ref: '#/components/responses/RateLimitExceeded'
'500':
$ref: '#/components/responses/InternalError'
components:
parameters:
identifier:
name: identifier
in: path
required: true
schema:
type: string
description: Custom field `id` (UUID) or `key` (string). Both formats are accepted.
schemas:
UpdateTagRequest:
type: object
description: All fields are optional. Only fields included in the body are modified.
properties:
name:
type: string
minLength: 1
maxLength: 30
description: New display name.
example: Cold Lead
color_text:
type: string
nullable: true
pattern: ^#[0-9a-fA-F]{6}$
description: >-
New text color in hex RGB format. Send `null` to revert to the
workspace default.
example: '#374152'
color_background:
type: string
nullable: true
pattern: ^#[0-9a-fA-F]{6}$
description: >-
New background color in hex RGB format. Send `null` to revert to the
workspace default.
example: '#e4e6eb'
TagResponse:
type: object
properties:
data:
$ref: '#/components/schemas/Tag'
Tag:
type: object
properties:
id:
type: string
format: uuid
description: Unique identifier of the tag.
name:
type: string
maxLength: 30
description: Display name of the tag.
example: Hot Lead
key:
type: string
maxLength: 30
description: >-
Unique key within the workspace. Lowercase letters, digits, and
underscores only (e.g. `hot_lead`). Used to reference the tag in
association arrays.
example: hot_lead
color_text:
type: string
nullable: true
pattern: ^#[0-9a-fA-F]{6}$
description: >-
Text color in hex RGB format. `null` means the workspace default is
applied.
example: '#ffffff'
color_background:
type: string
nullable: true
pattern: ^#[0-9a-fA-F]{6}$
description: >-
Background color in hex RGB format. `null` means the workspace
default is applied.
example: '#ef4444'
created_at:
type: string
format: date-time
description: ISO 8601 UTC timestamp of when the tag was created.
ErrorResponse:
type: object
properties:
error:
type: object
properties:
code:
type: string
message:
type: string
request_id:
type: string
format: uuid
ValidationErrorResponse:
type: object
properties:
error:
type: object
properties:
code:
type: string
example: validation_error
message:
type: string
example: Validation failed.
fields:
type: object
additionalProperties:
type: string
request_id:
type: string
format: uuid
responses:
BadRequest:
description: 'Malformed request body or empty update. Error code: `bad_request`.'
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
error:
code: bad_request
message: Request body must be valid JSON.
request_id: 550e8400-e29b-41d4-a716-446655440000
Unauthorized:
description: >-
Token missing, invalid, or expired. Possible error codes:
`unauthorized`, `token_expired`.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
error:
code: unauthorized
message: Missing or invalid Authorization header.
request_id: 550e8400-e29b-41d4-a716-446655440000
InsufficientScope:
description: 'Token lacks the required scope. Error code: `insufficient_scope`.'
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
error:
code: insufficient_scope
message: This endpoint requires the 'webhooks:read' scope.
request_id: 550e8400-e29b-41d4-a716-446655440000
NotFound:
description: >-
Webhook not found or belongs to another integration. Error code:
`not_found`. Message: `"Webhook not found."`
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
error:
code: not_found
message: Webhook not found.
request_id: 550e8400-e29b-41d4-a716-446655440000
ValidationError:
description: >-
Input validation failed. Error code: `validation_error`. The `fields`
object maps each invalid field to a description of the problem.
content:
application/json:
schema:
$ref: '#/components/schemas/ValidationErrorResponse'
example:
error:
code: validation_error
message: Validation failed.
fields:
url: url must use HTTPS.
events: At least one event is required.
request_id: 550e8400-e29b-41d4-a716-446655440000
RateLimitExceeded:
description: 'Rate limit exceeded. Error code: `rate_limit_exceeded`.'
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
error:
code: rate_limit_exceeded
message: Rate limit exceeded. Try again in 60 seconds.
request_id: 550e8400-e29b-41d4-a716-446655440000
InternalError:
description: 'Unexpected server error. Error code: `internal_error`.'
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
example:
error:
code: internal_error
message: An unexpected error occurred.
request_id: 550e8400-e29b-41d4-a716-446655440000
securitySchemes:
bearerAuth:
type: http
scheme: bearer
description: OAuth 2.1 access token.
````