Seções agrupam campos visualmente no formulário de cadastro. A ordem das seções entre si segue o índice definido na criação; a ordem dos campos dentro de uma seção segue a ordem em que foram associados a ela.
Campos são os dados efetivamente coletados — nome, tipo, se é obrigatório, texto de ajuda, opções (quando aplicável) e comportamento (fixo ou condicional). Um campo pode existir sem seção (nesse caso, sua posição segue um índice próprio) ou associado a uma seção.
Regras definem comportamento condicional associado a um campo específico: exibir ou ocultar outros campos com base no valor preenchido, ou calcular automaticamente o valor de um campo a partir de outros.
Uma configuração por empresa. O escopo é companyId, não flowId. Antes de criar uma configuração nova, consulte GET /v1/client-config/companies/{companyId}: uma resposta 200 indica que a empresa já possui configuração, e novos campos devem ser adicionados por meio da criação de campos ou de seções, nunca por uma nova criação de configuração.
description e help são obrigatórios em todo campo. Em qualquer operação de escrita — criação de configuração, criação de campos ou atualização de campo — a ausência de um texto não vazio em description ou help retorna erro 400 apontando o campo específico.
O tipo do campo pertence a um conjunto fechado de 27 valores. Enviar um type fora desse conjunto (ou omitir o campo) retorna 400 com a lista completa de valores aceitos. O conjunto é o mesmo utilizado pelo formulário de início de flow, acrescido do tipo cep.
options é sempre uma lista simples de textos. Para campos do tipo select ou checkList, as opções nunca devem ser enviadas como uma lista de objetos com rótulo e valor separados.
index e name devem ser únicos dentro de cada chamada em lote. Ao criar múltiplos campos ou seções em uma mesma requisição, valores repetidos de índice ou de nome são rejeitados.
PUT substitui integralmente; PATCH altera parcialmente. Em seções, campos e regras, a atualização completa (PUT) exige o reenvio de todos os atributos originais — a omissão de um atributo obrigatório retorna 400. A atualização parcial (PATCH) aceita apenas os atributos a serem alterados, preservando os demais.
Associar um campo a uma seção altera seu índice. Ao informar section com o identificador de uma seção em um campo, o índice individual desse campo é automaticamente definido como nulo pela API, e sua posição dentro da seção passa a seguir a ordem em que foi associado a ela — não um valor numérico configurável. Enviar section como nulo remove o campo da seção e restabelece seu índice individual.
Regras são avaliadas na interface do usuário. A API armazena a definição de uma regra (condição de exibição ou expressão de cálculo), mas não a executa sobre registros de clientes criados ou atualizados diretamente: o comportamento de mostrar, ocultar ou calcular só é observável ao preencher o formulário de cadastro pela interface.
Remover uma configuração, seção ou campo é uma operaç ão destrutiva. A remoção de uma configuração de cliente elimina permanentemente todas as suas seções, campos e regras. A remoção de um campo elimina também as regras associadas a ele. Registros de clientes já preenchidos mantêm o dado histórico, mas o campo removido deixa de existir no schema da empresa.
