Pular para o conteúdo principal
PUT
/
fields
/
{id}
Atualizar campo
curl --request PUT \
  --url https://api.meuassistente.rdstationmentoria.com.br/rest/fields/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "type": "text",
  "options": []
}
'
{
  "id": "<string>",
  "name": "<string>",
  "description": "<string>",
  "workspaceId": "<string>",
  "createdBy": "<string>",
  "updatedBy": "<string>",
  "active": true,
  "fixed": false,
  "type": "text",
  "options": [],
  "createdAt": "2025-11-26T20:01:11.949Z",
  "updatedAt": "2025-11-26T20:01:11.949Z"
}

Autorizações

Authorization
string
header
obrigatório

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Parâmetros de caminho

id
string
obrigatório

Identificador único do campo

Corpo

application/json
name
string
obrigatório

Nome do campo

description
string
obrigatório

Descrição do campo

type
enum<string>
padrão:text

Tipo do campo

Opções disponíveis:
text,
email,
phone,
number,
url,
boolean,
date,
choice,
multi_choice,
cpf,
cnpj
options
string[]

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

Resposta

Successful response

id
string
obrigatório

Identificador único do campo

name
string
obrigatório

Nome do campo

description
string
obrigatório

Descrição do campo

workspaceId
string
obrigatório

Identificador do workspace associado

createdBy
string | null
obrigatório

ID do usuário que criou o registro

updatedBy
string | null
obrigatório

ID do usuário que atualizou o registro

active
boolean
padrão:true

Indica se o campo está ativo

fixed
boolean
padrão:false
type
enum<string>
padrão:text

Tipo do campo

Opções disponíveis:
text,
email,
phone,
number,
url,
boolean,
date,
choice,
multi_choice,
cpf,
cnpj
options
string[]

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

createdAt
string<date-time>
padrão:2025-11-26T20:01:11.949Z

Data de criação

updatedAt
string<date-time>
padrão:2025-11-26T20:01:11.949Z

Data da última atualização