Update Custom Field

PUT

/api/v1/fields/{entity}/custom/{field_id}

• API de Produção

Atualiza um campo personalizado.

Nota: O tipo do campo (field_type) não pode ser alterado após criação para não quebrar dados existentes.

Authorizations

• HTTPBearer

Parameters

Path Parameters

entity

required

Entity

string

field_id

required

Field Id

integer

Header Parameters

x-tenant-id

Any of:

integer

integer

null

null

Request Body ^required

CustomFieldUpdate

Schema para atualizar campo personalizado.

object

label

Any of:

string

string

>= 1 characters <= 100 characters

null

null

description

Any of:

string

string

<= 255 characters

null

null

options

Any of:

Array<object>

Array<object>

SelectOption

Opção para campos select/multi_select.

object

value

required

Value

string

label

required

Label

string

color

Any of:

string

string

null

null

icon

Any of:

string

string

null

null

null

null

validation

Any of:

ValidationConfig

ValidationConfig

Configuração de validação.

object

required

Any of:

boolean

boolean

null

null

min

Any of:

number

number

null

null

max

Any of:

number

number

null

null

min_length

Any of:

integer

integer

null

null

max_length

Any of:

integer

integer

null

null

pattern

Any of:

string

string

null

null

pattern_message

Any of:

string

string

null

null

null

null

is_required

Any of:

boolean

boolean

null

null

placeholder

Any of:

string

string

<= 100 characters

null

null

default_value

Any of:

unknown

null

null

show_in_table

Any of:

boolean

boolean

null

null

show_in_form

Any of:

boolean

boolean

null

null

show_in_card

Any of:

boolean

boolean

null

null

display_order

Any of:

integer

integer

null

null

is_searchable

Any of:

boolean

boolean

null

null

is_filterable

Any of:

boolean

boolean

null

null

is_sortable

Any of:

boolean

boolean

null

null

is_active

Any of:

boolean

boolean

null

null

Responses

200

Successful Response

CustomFieldResponse

Schema de resposta para campo personalizado.

object

id

required

Id

integer

entity

required

CustomFieldEntity

Entidades que suportam campos personalizados.

string

Allowed values: contacts companies deals

key

required

Key

string

label

required

Label

string

description

required

Any of:

string

string

null

null

field_type

required

CustomFieldType

Tipos de campo suportados.

string

Allowed values: text textarea number decimal currency date datetime boolean select multi_select tags email phone url user

options

required

Any of:

Array<object>

Array<object>

SelectOption

Opção para campos select/multi_select.

object

value

required

Value

string

label

required

Label

string

color

Any of:

string

string

null

null

icon

Any of:

string

string

null

null

null

null

validation

required

Any of:

ValidationConfig

ValidationConfig

Configuração de validação.

object

required

Any of:

boolean

boolean

null

null

min

Any of:

number

number

null

null

max

Any of:

number

number

null

null

min_length

Any of:

integer

integer

null

null

max_length

Any of:

integer

integer

null

null

pattern

Any of:

string

string

null

null

pattern_message

Any of:

string

string

null

null

null

null

placeholder

required

Any of:

string

string

null

null

default_value

required

Any of:

unknown

null

null

show_in_table

required

Show In Table

boolean

show_in_form

required

Show In Form

boolean

show_in_card

required

Show In Card

boolean

display_order

required

Display Order

integer

is_active

required

Is Active

boolean

is_required

required

Is Required

boolean

is_unique

required

Is Unique

boolean

is_searchable

required

Is Searchable

boolean

is_filterable

required

Is Filterable

boolean

is_sortable

required

Is Sortable

boolean

created_by_id

required

Any of:

integer

integer

null

null

created_at

required

Created At

string format: date-time

updated_at

required

Updated At

string format: date-time

frontend_type

Any of:

string

string

null

null

422

Validation Error

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string