Update credit engine configuration

PUT

/v1/flows/{flowId}/credit-engine-config/{id}

Updates the flow's existing credit engine configuration, fully replacing the submitted input[]/output[].

As with creation, the fields title, description and hasValue remain required at the root level of the payload. The companyId field, required on create, must be OMITTED here — sending it returns a 400 error.

The id and path fields, when present in output[].segments[].fields[] (for example, when copying the structure from another configuration), must be removed before submitting — the API rejects these nested fields on update.

Requisição

Parâmetros de Caminho

Parâmetros Bodyapplication/jsonNecessário

Examples

Respostas

🟢200Configuration updated

application/json

The credit engine configuration was updated successfully.

Bodyapplication/json

🟠400Invalid payload

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PUT '/v1/flows//credit-engine-config/' \
--header 'Content-Type: application/json' \
--data '{
    "title": "string",
    "description": "string",
    "hasValue": true,
    "policyId": "string",
    "input": [
        {
            "key": "string",
            "title": "string",
            "type": "string",
            "path": "string",
            "reference": "string",
            "required": true,
            "description": "string"
        }
    ],
    "output": [
        {
            "description": "string",
            "segments": [
                {
                    "description": "string",
                    "fields": [
                        {
                            "key": "string",
                            "title": "string",
                            "description": "string",
                            "type": "string",
                            "weight": 0,
                            "aggregates": [
                                {
                                    "key": "string",
                                    "path": "string",
                                    "description": "string"
                                }
                            ]
                        }
                    ]
                }
            ]
        }
    ]
}'

Response Example

200 - Exemplo 1

{
    "id": "string",
    "policyId": "string",
    "title": "string",
    "description": "string",
    "hasValue": true,
    "input": [
        {}
    ],
    "output": [
        {}
    ]
}

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

Página anterior

List credit policies applicable to a card

Próxima página

Delete credit engine configuration