Create bureau query configuration

POST

/v1/flows/{flowId}/phases/{phaseId}/query-config

Creates the bureau query configuration for a phase, defining the configuration title and the list of bureau/AgRisk product identifiers to be queried when a card enters the phase.

If a query configuration already exists for the phase, a new submission is treated as an update: the API returns an error (409 or 422) for this repeated method, and the update must be done by resubmitting the same payload via PUT to this same path.

We recommend reading the existing configuration (GET) before deciding whether to create or update.

This configuration is independent from the agrisk phase action, which enables the actual triggering of the queries configured here. The recommended pattern is to configure this query first, and only then create the corresponding phase action.

Requisição

Parâmetros de Caminho

Parâmetros Bodyapplication/jsonNecessário

Examples

Respostas

🟢201Configuration created

application/json

The bureau query configuration was created successfully.

Bodyapplication/json

🟠409Configuration already exists

Request Example

Shell

JavaScript

Java

Swift

curl --location '/v1/flows//phases//query-config' \
--header 'Content-Type: application/json' \
--data '{
    "title": "string",
    "products": [
        "string"
    ]
}'

Response Example

201 - Exemplo 1

{
    "id": "string",
    "title": "string",
    "products": [
        "string"
    ]
}

Modificado em 2026-07-28 20:38:32

Página anterior

Get bureau query configuration

Próxima página

Update bureau query configuration