Criar formulário inicial

Cria o formulário inicial (ficha de cadastro) de um flow que ainda não possui um. O formulário inicial é a etapa preenchida por quem solicita, e sua submissão é o que gera um novo card no flow.

O campo startFormPhaseId é obrigatório e deve apontar para a fase inicial do flow (a fase marcada como fase de início).

O campo createButtonLabel é obrigatório e não pode ser uma string vazia — mesmo sendo tecnicamente opcional no schema, sua ausência retorna erro 400.

O título enviado neste payload de criação é ignorado pela API: a resposta sempre retorna o título padrão "Ficha Cadastral". Para personalizar o título, é necessário atualizar o formulário em uma chamada subsequente.

O formulário deve conter, simultaneamente, um campo de cada um dos três tipos padrão: default_name (nome do cliente), default_document (CPF/CNPJ) e default_value (valor solicitado). A ausência de qualquer um deles retorna erro 422. Esses três tipos são exclusivos: no máximo um campo de cada um pode existir no formulário — para campos de documento adicionais, utilize o tipo document (sem limite de quantidade).

Campos do tipo select, radio e checkList recebem as opções em options como uma lista simples de strings — nunca pares de rótulo e valor.

Os campos slug e uiComponent não devem ser enviados: são derivados automaticamente pela API a partir de name e type, respectivamente. Regras condicionais (rules) também não são aceitas neste endpoint — configure-as através do endpoint de regras dedicado, após a criação do formulário.

curl --location '/v1/flows//start-form' \ --header 'Content-Type: application/json' \ --data '{ "title": "string", "description": "string", "logoUrl": "string", "backgroundColor": "string", "createButtonLabel": "string", "startFormPhaseId": "string", "fields": [ { "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" ] } ] }'

{ "id": "string", "title": "string", "description": "string", "logoUrl": "string", "backgroundColor": "string", "createButtonLabel": "string", "startFormPhaseId": "string", "flowId": "string", "fields": [ { "id": "string", "name": "string", "type": "string", "index": 0, "active": true, "editable": true, "required": true, "help": "string", "description": "string", "category": "string", "slug": "string", "uiComponent": "string", "sectionMetadata": {}, "options": [ "string" ] } ] }

Criar formulário inicial

Requisição

Respostas