> ## 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 custom field
> Updates a custom field by its `id` (UUID) or `key` (string). Only fields included in the body are modified.
`custom_fields:write`
## OpenAPI
````yaml /en/api-reference/openapi.json patch /v1/custom-fields/{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/custom-fields/{identifier}:
patch:
tags:
- Custom Fields
summary: Update a custom field
description: >-
Updates a custom field by its `id` (UUID) or `key` (string). Only fields
included in the body are modified.
`custom_fields:write`
operationId: updateCustomField
parameters:
- $ref: '#/components/parameters/identifier'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateCustomFieldRequest'
responses:
'200':
description: Custom field updated successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/CustomFieldResponse'
'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:
UpdateCustomFieldRequest:
type: object
description: All fields are optional. Only fields included in the body are modified.
properties:
label:
type: string
minLength: 1
maxLength: 40
description: New display label.
example: Federal Tax ID
type:
type: string
enum:
- text
- long_text
- select
- multi_select
- cpf
- cnpj
- date
- number
- link
- address
description: New field type.
value:
description: >-
Updates the options for `select` and `multi_select` fields. Replaces
the entire existing list. Must be omitted for all other field types.
example:
select_list:
- key: sl_option_a
option: Option A
- key: sl_option_b
option: Option B
- key: sl_option_c
option: Option C
properties:
select_list:
type: array
items:
type: object
required:
- key
- option
properties:
key:
type: string
description: >-
Unique identifier for the option. Lowercase letters,
digits, and underscores only.
example: sl_option_a
option:
type: string
description: Display text shown to the user.
example: Option A
required:
type: boolean
description: Update required flag.
example: true
show_people:
type: boolean
description: Update visibility on people records.
example: true
show_companies:
type: boolean
description: Update visibility on company records.
example: false
show_deals:
type: boolean
description: Update visibility on deal records.
example: true
CustomFieldResponse:
type: object
properties:
data:
$ref: '#/components/schemas/CustomField'
CustomField:
type: object
properties:
id:
type: string
format: uuid
description: Unique identifier.
label:
type: string
maxLength: 40
description: Display label shown in the interface.
example: Tax ID
key:
type: string
maxLength: 35
description: >-
Unique key within the workspace. Used to reference the field when
associating values with records.
example: tax_id
type:
type: string
enum:
- text
- long_text
- select
- multi_select
- cpf
- cnpj
- date
- number
- link
- address
description: Field type. Determines the expected value format.
value:
description: >-
For `select` and `multi_select` fields only: the available options.
`null` for all other field types.
nullable: true
example:
select_list:
- key: sl_option_a
option: Option A
- key: sl_option_b
option: Option B
required:
type: boolean
description: Whether the field is required when creating or editing a record.
show_people:
type: boolean
description: Whether this field appears on people records.
show_companies:
type: boolean
description: Whether this field appears on company records.
show_deals:
type: boolean
description: Whether this field appears on deal records.
created_at:
type: string
format: date-time
description: ISO 8601 UTC creation timestamp.
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.
````