OpenAPI 3.0.32026-08-2023066.0 KB

2489bde862fa

Fields

Atualizar campo

Atualiza as informações de um campo.

put/fields/{id}

Path parameters

idstring required

Identificador único do campo

Request body

namestring required

Nome do campo

descriptionstring required

Descrição do campo

type'text' | 'email' | 'phone' | 'number' | 'url' | 'boolean' | 'date' | 'choice' | 'multi_choice' | 'cpf' | 'cnpj'

Tipo do campo

optionsstring[]

Lista de opções para campos do tipo choice ou multi_choice

Response

Successful response

idstring required

Identificador único do campo

namestring required

Nome do campo

descriptionstring required

Descrição do campo

activeboolean

Indica se o campo está ativo

fixedboolean

type'text' | 'email' | 'phone' | 'number' | 'url' | 'boolean' | 'date' | 'choice' | 'multi_choice' | 'cpf' | 'cnpj'

Tipo do campo

optionsstring[]

Lista de opções para campos do tipo choice ou multi_choice

newboolean

Flag de compatibilidade (integrações)

workspaceIdstring required

Identificador do workspace associado

createdBystring nullable required

ID do usuário que criou o registro

updatedBystring nullable required

ID do usuário que atualizou o registro

createdAtstring date-time

Data de criação

updatedAtstring date-time

Data da última atualização