Create start form

Creates the start form (initial application form) for a flow that does not have one yet. The start form is the step filled out by the requester, and submitting it is what generates a new card in the flow.

The startFormPhaseId field is required and must point to the flow's start phase (the phase marked as the initial phase).

The createButtonLabel field is required and cannot be an empty string — even though it is technically optional in the schema, its absence returns a 400 error.

The title sent in this creation payload is ignored by the API: the response always returns the default title "Ficha Cadastral". To customize the title, a subsequent update call is required.

The form must contain, simultaneously, one field of each of the three default types: default_name (client name), default_document (tax ID) and default_value (requested amount). Missing any of them returns a 422 error. These three types are exclusive: at most one field of each may exist in the form — for additional document fields, use type document (unlimited).

Fields of type select, radio and checkList receive their options in options as a plain list of strings — never label/value pairs.

The slug and uiComponent fields must not be sent: they are derived automatically by the API from name and type, respectively. Conditional rules (rules) are also not accepted on this endpoint — configure them through this domain's dedicated rules endpoint, after the form has been created.

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" ] } ] }

Create start form

Requisição

Respostas