Pular para o conteúdo
Healthing CRM

Create Custom Field

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

Cria um novo campo personalizado.

A key deve começar com ‘cf_’ e ser única para a entidade.

Authorizations

Seção intitulada “Authorizations ”

Parameters

Seção intitulada “ Parameters ”

Path Parameters

Seção intitulada “Path Parameters ”
entity
required
Entity
string

Header Parameters

Seção intitulada “Header Parameters ”
x-tenant-id
Any of:
integer

Request Body required

Seção intitulada “Request Body required ”
CustomFieldCreate

Schema para criar campo personalizado.

object
entity
required
CustomFieldEntity

Entidades que suportam campos personalizados.

string
Allowed values: contacts companies deals
key
required
Key

Chave única do campo (deve começar com cf_)

string
>= 4 characters <= 50 characters
label
required
Label
string
>= 1 characters <= 100 characters
description
Any of:
string
<= 255 characters
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
Any of:
Array<object>
SelectOption

Opção para campos select/multi_select.

object
value
required
Value
string
label
required
Label
string
color
Any of:
string
icon
Any of:
string
validation
Any of:
ValidationConfig

Configuração de validação.

object
required
Any of:
boolean
min
Any of:
number
max
Any of:
number
min_length
Any of:
integer
max_length
Any of:
integer
pattern
Any of:
string
pattern_message
Any of:
string
is_required
Is Required
boolean
is_unique
Is Unique
boolean
placeholder
Any of:
string
<= 100 characters
default_value
Any of:
show_in_table
Show In Table
boolean
default: true
show_in_form
Show In Form
boolean
default: true
show_in_card
Show In Card
boolean
display_order
Display Order
integer
0
is_searchable
Is Searchable
boolean
default: true
is_filterable
Is Filterable
boolean
default: true
is_sortable
Is Sortable
boolean
default: true

Responses

Seção intitulada “ Responses ”

201

Seção intitulada “201 ”

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
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>
SelectOption

Opção para campos select/multi_select.

object
value
required
Value
string
label
required
Label
string
color
Any of:
string
icon
Any of:
string
validation
required
Any of:
ValidationConfig

Configuração de validação.

object
required
Any of:
boolean
min
Any of:
number
max
Any of:
number
min_length
Any of:
integer
max_length
Any of:
integer
pattern
Any of:
string
pattern_message
Any of:
string
placeholder
required
Any of:
string
default_value
required
Any of:
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
created_at
required
Created At
string format: date-time
updated_at
required
Updated At
string format: date-time
frontend_type
Any of:
string

422

Seção intitulada “422 ”

Validation Error

HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string