Create opinion configuration

Creates the technical opinion configuration for a flow, enabling the collection of a structured opinion on analysis phases.

The payload accepts exactly two top-level keys: title (the opinion label shown to analysts) and fields (the list of complementary fields). Any other top-level key — such as description, blocksMovement, slug, uiComponent, active, or rules — is rejected with a 400 error.

As soon as the configuration is saved, the API automatically creates three native fields: the status set by the analyst (approved or rejected), the approved credit limit (a monetary value), and the analyst's opinion text. Do not include any field in fields that serves the same purpose — names such as 'Approved', 'Rejected', 'Analyst Opinion', 'Conclusion', 'Recommendation', or 'Justification' duplicate the native fields, resulting in duplicated display in the interface. Use fields only for information specific to the analysis, such as guarantees offered, guarantee expiration date, or an internal score.

Each item in fields requires name, type, index (display position), and editable. For select-type fields (select, radio, or checkList), the options in options must be a plain list of strings — not an object with label and value. The help parameter is optional and adds supporting text to the field. Do not include the active key inside fields items — it is rejected with a 400 error; each field's activation state is managed by the API itself.

The opinion configuration is unique per flow, regardless of the phase informed in the path. If the flow already has a configuration, submitting again through this path behaves as an update of the existing configuration.

Creating this configuration alone is not enough for the opinion to appear to users on the phase — the module must also be enabled through the corresponding phase action (action: opinion), the same way as the flow's other modules.

application/json

The opinion configuration was created successfully, already including the three native fields generated automatically by the API.

Bodyapplication/json

curl --location '/v1/flows//phases//opinion-config' \ --header 'Content-Type: application/json' \ --data '{ "title": "string", "fields": [ { "name": "string", "type": "shortText", "help": "string", "index": 0, "editable": true, "options": [ "string" ] } ] }'

{ "id": "string", "title": "string", "fields": [ { "id": "string", "name": "string", "type": "string", "active": true, "index": 0, "editable": true, "help": "string", "options": [ "string" ] } ] }

Create opinion configuration

Requisição

Respostas