Update flow

Updates the data of an existing flow.

This endpoint behaves as a full replacement, not a partial update: the payload must contain the entire flow on every call, even when the goal is to change a single field — for example, only labelOptions.

The name, description, createCardLabel, and cardCountLabel fields are always required on this operation, even when their values are not changing. Sending description missing or empty returns a 400 error.

The color and icon fields must also be resent on every call, even without changes — omitting color returns the 400 error "color must be either a valid hexadecimal color (e.g., #FF5733) or one of the following: turquoise, blue, orange, violet, pink, purple, light_blue".

Warning: omitting createCardLabel or cardCountLabel does NOT raise an error — instead, the API silently resets those fields to their default values ('Novo Card' and 'cards', respectively), overwriting any previous customization without notice. We recommend always fetching the current flow via GET before building the PUT payload, resending all existing fields.

curl --location --request PUT '/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