Create flow

Creates a new flow (business process) inside the authenticated company.

Before the first flow of a company can be created, the tenant must already have a logo on file — without it, creation returns a 404 error stating that the company logo was not found.

The createButtonLabel field is not accepted on this endpoint — it belongs to the start form, not to the flow itself. Sending it returns a 400 error. Use createCardLabel for the card-creation button label.

The createCardLabel and cardCountLabel fields are required in practice, even though the formal schema definition does not mark them as such: omitting them, or sending them as an empty string, returns a 400 error.

The color field (the flow's display color) accepts either a hexadecimal code (#RRGGBB) or one of 7 fixed named values: turquoise, blue, orange, violet, pink, purple, light_blue.

The color of each labelOptions item, however, must always be a hexadecimal code (#RRGGBB) — named values such as blue are rejected specifically on this field, unlike the rule applied to the flow's color.

curl --location '/v1/flows' \ --header 'Content-Type: application/json' \ --data '{ "name": "string", "description": "string", "icon": "money", "color": "string", "createCardLabel": "string", "cardCountLabel": "string", "labelOptions": [ { "label": "string", "color": "string" } ] }'

{ "id": "string", "name": "string", "description": "string", "icon": "string", "color": "string", "createCardLabel": "string", "cardCountLabel": "string", "labelOptions": [ {} ] }

Requisição

Respostas