O título enviado na criação (POST) é ignorado pela API, que sempre retorna "Ficha Cadastral". Para personalizar o título, é necessário atualizar o formulário depois de criado — a partir da atualização, o título passa a ser respeitado.
createButtonLabel é obrigatório tanto na criação quanto na atualização de metadados, e não pode ser uma string vazia.
backgroundColor deve ser enviado explicitamente em toda atualização de metadados — se omitido, a API redefine a cor para o padrão da plataforma, descartando a cor personalizada da empresa sem aviso.
Ao atualizar os campos do formulário, cada campo já existente deve manter seu id original. Omiti-lo faz a API tratar o campo como novo, criando uma duplicata inativa em vez de atualizar o campo pretendido. Campos novos também precisam de um identificador (UUID) gerado no lado do cliente antes do envio.
As opções de campos do tipo seleção (select, radio, checkList) são sempre uma lista simples de strings — nunca pares de rótulo e valor.
O agrupamento visual em seções é feito por campo, através de sectionMetadata — não existe um array de seções separado.
As regras condicionais (mostrar, ocultar, tornar obrigatório, tornar opcional, limpar valor, preencher valor, ou calcular automaticamente) são definidas em uma chamada dedicada, e são preservadas nas atualizações de campos subsequentes, desde que os identificadores dos campos referenciados não mudem.
Definir novas regras condicionais apaga o texto de ajuda (help) de todos os campos do formulário, como efeito colateral. Recomendamos encerrar a configuração do formulário sempre com uma atualização de campos que inclua o texto de ajuda.
Se o valor usado em uma condição não corresponder exatamente a uma opção cadastrada em um campo de seleção (incluindo acentuação e espaços), a regra correspondente nunca disparará, sem gerar qualquer erro.
A consulta da versão pública do formulário é o único endpoint deste domínio acessível fora de uma sessão de usuário autenticada, e requer o cabeçalho ag-flow-id com o identificador do flow.
A remoção do formulário é destrutiva: o flow fica sem formulário de entrada até que um novo seja criado. Antes de remover, recomendamos verificar triggers, motores de crédito/decisão e templates de documento que referenciem campos do formulário.
