Update a model.

put

https://{tenanturl}/v1.0/config/models/{reference}

Updates an existing model by its reference, allowing updates to name, description, or model.
Entitlement required: manageFlows.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

reference

string

required

Unique reference of the model.

Query Params

autoConnect

boolean

Defaults to false

If set to true, tasks are connected automatically using these rules:
1. If a task does not have a next property, it is automatically linked to the immediate next node's id.
2. If any task (except the End node) is the last in sequence, no next property is added.

If set to false, task without a next property remains disconnected. This is allowed when creating or updating a model, but while publishing, the disconnected nodes cause validation errors.

showErrors

boolean

Defaults to false

If set to true, returns issues pertaining the model. The model can still be saved in draft mode. However, all issues need to be fixed before publishing the model.

Body Params

name

string

Updated name of the model.

description

string

Updated description of the model.

model

file

File containing the updated model. Only JSON format is supported.

Responses

`showErrors=true`, issues are returned in the response. If `showErrors=false`, the response is empty.

Language

URL

Loading…

Response

Choose an example:

application/json

200The Model is updated successfully, however, it may contain issues. If showErrors=true, issues are returned in the response. If showErrors=false, the response is empty.

400Bad request.

401Unauthorized.

403Forbidden.

404Model not found.

500Internal server error.

`showErrors=true`, issues are returned in the response. If `showErrors=false`, the response is empty.