Endpoint

PUT /updateCatalog

Envie variableIds ou variables — nunca os dois juntos.

Parâmetros

catalogId
string (UUID)
required

ID do formulário a ser atualizado.

hostId
string (UUID)

ID do host. Se omitido, é derivado do token.

name
string

Novo nome do formulário.

description
string

Nova descrição.

generalInstructions
string

Novas instruções gerais para a IA.

variableIds
array de UUIDs

IDs de variáveis existentes a associar. Substitui a lista atual.

variables
array

Lista completa de variáveis com configurações de campo. Cria variáveis novas ou atualiza existentes.

Cada item pode conter:

  • id (para atualizar variável existente) ou keyName + dataType + scope (para criar)
  • label, description, validators, required
  • field: configurações do campo no formulário (orderIndex, captureStrategy, mappingKey, helpText, requiredOverride)

Exemplos

curl -X PUT {BASE_URL}/updateCatalog \
  -H "Authorization: Bearer {TOKEN}" \
  -H "Content-Type: application/json" \
  -d '{
    "catalogId": "uuid-do-formulario",
    "name": "Formulário de Contato v2",
    "variableIds": ["uuid1", "uuid2", "uuid3"]
  }'

Resposta

Retorna o formulário atualizado com os mesmos campos de Criar Catálogo.

Erros

CódigoDescrição
400catalogId ausente, formulário não encontrado ou variáveis inválidas
401Token inválido ou ausente
500Erro interno do servidor