Atualizar campos do formulário

Substitui por completo a lista de campos (fields) do formulário inicial. É uma substituição integral — o array enviado passa a ser o conteúdo total do formulário.

Campos já existentes devem manter seu id original. Omitir o id de um campo existente faz a API interpretá-lo como um campo novo: em vez de atualizar o campo pretendido, ela cria uma duplicata fantasma (inativa, sem posição), e o campo original permanece intocado e desatualizado.

Campos novos também precisam de um identificador único (UUID) gerado no lado do cliente antes do envio — sem ele, ocorre o mesmo problema de duplicata fantasma.

Os três campos padrão do formulário (default_name, default_document, default_value) precisam continuar presentes entre os campos enviados; omitir qualquer um deles retorna erro 422.

As regras condicionais definidas anteriormente para os campos são preservadas automaticamente por esta chamada, desde que os campos referenciados nas regras continuem presentes com os mesmos identificadores.

O campo slug não deve ser enviado — é derivado automaticamente a partir de name; enviá-lo retorna erro 400.

curl --location --request PUT '/v1/flows//start-form//fields' \ --header 'Content-Type: application/json' \ --data '{ "fields": [ { "id": "string", "name": "string", "type": "shortText", "index": 0, "active": true, "editable": true, "required": true, "help": "string", "category": "default", "sectionMetadata": { "sectionId": "string", "sectionTitle": "string", "sectionIndex": 0 }, "options": [ "string" ] } ] }'

{ "fields": [ { "id": "string", "name": "string", "type": "string", "index": 0, "active": true, "editable": true, "required": true, "help": "string", "category": "string", "slug": "string", "uiComponent": "string", "sectionMetadata": {}, "options": [ "string" ] } ] }

Atualizar campos do formulário

Requisição

Respostas