---
updatedAt: 2026-05-21T18:12:22.000Z
---

# Update a model.

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

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "version": "1.0.0",
    "description": "IBM Verify API",
    "title": "IBM Verify API"
  },
  "servers": [
    {
      "url": "https://{tenanturl}",
      "variables": {
        "tenanturl": {
          "default": "{tenant_url}",
          "description": "URL of your IBM Security Verify tenant"
        }
      }
    }
  ],
  "tags": [
    {
      "name": "Flow management",
      "description": "Operations related to Flow management."
    }
  ],
  "paths": {
    "/v1.0/config/models/{reference}": {
      "put": {
        "tags": [
          "Flow management"
        ],
        "summary": "Update a model.",
        "description": "Updates an existing model by its reference, allowing updates to name, description, or model. <br>**Entitlement required:** manageFlows.",
        "parameters": [
          {
            "name": "reference",
            "in": "path",
            "description": "Unique reference of the model.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "autoConnect",
            "in": "query",
            "description": "If set to true, tasks are connected automatically using these rules:<br>1. If a task does not have a `next` property, it is automatically linked to the immediate next node's id.<br>2. If any task (except the End node) is the last in sequence, no `next` property is added.<br><br>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.",
            "schema": {
              "type": "boolean",
              "default": false
            }
          },
          {
            "name": "showErrors",
            "in": "query",
            "description": "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.",
            "schema": {
              "type": "boolean",
              "default": false
            }
          }
        ],
        "requestBody": {
          "content": {
            "multipart/form-data": {
              "schema": {
                "type": "object",
                "properties": {
                  "name": {
                    "type": "string",
                    "description": "Updated name of the model."
                  },
                  "description": {
                    "type": "string",
                    "description": "Updated description of the model."
                  },
                  "model": {
                    "type": "string",
                    "description": "File containing the updated model. Only JSON format is supported.",
                    "format": "binary"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "The 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.",
            "headers": {
              "Location": {
                "description": "URI of the updated model",
                "schema": {
                  "type": "string"
                }
              }
            },
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ModelAddedResponse"
                },
                "example": {
                  "errors": [
                    {
                      "messageDescription": "<validation_error_description>"
                    },
                    {
                      "messageDescription": "<validation_error_description>",
                      "nodeId": "<invalid_node_id>",
                      "nodeName": "<invalid_node_name>"
                    }
                  ]
                }
              }
            }
          },
          "400": {
            "description": "Bad request.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessageWithPotentialError"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage_1"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage_1"
                }
              }
            }
          },
          "404": {
            "description": "Model not found.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage_1"
                }
              }
            }
          },
          "500": {
            "description": "Internal server error.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage_1"
                }
              }
            }
          }
        },
        "x-category": "IBM Verify API",
        "x-publicAPI": "true"
      }
    }
  },
  "components": {
    "schemas": {
      "ErrorMessageWithPotentialError": {
        "required": [
          "messageDescription",
          "messageId"
        ],
        "type": "object",
        "properties": {
          "messageId": {
            "type": "string",
            "description": "Error code",
            "example": "<error_message_id>"
          },
          "messageDescription": {
            "type": "string",
            "description": "Description of the error.",
            "example": "<error_message>"
          },
          "errors": {
            "type": "array",
            "nullable": true,
            "items": {
              "required": [
                "messageDescription"
              ],
              "type": "object",
              "properties": {
                "messageDescription": {
                  "type": "string",
                  "description": "Description of the specific validation error.",
                  "example": "<validation_error_description>"
                },
                "nodeId": {
                  "type": "string",
                  "description": "Id of the node associated with the error, if applicable. This field is nullable.",
                  "nullable": true,
                  "example": "<invalid_node_id>"
                },
                "nodeName": {
                  "type": "string",
                  "description": "Name of the node associated with the error, if applicable. This field is nullable.",
                  "nullable": true,
                  "example": "<invalid_node_name>"
                }
              }
            }
          }
        }
      },
      "ModelAddedResponse": {
        "type": "object",
        "properties": {
          "errors": {
            "type": "array",
            "description": "Array of model issues.",
            "items": {
              "$ref": "#/components/schemas/ResponseWithValidationErrors"
            }
          }
        }
      },
      "ResponseWithValidationErrors": {
        "type": "object",
        "properties": {
          "messageDescription": {
            "type": "string",
            "description": "Description of the error.",
            "example": "<validation_error_description>"
          },
          "messageId": {
            "type": "string",
            "description": "Error code",
            "example": "<error_message_id>"
          },
          "nodeId": {
            "type": "string",
            "description": "Id of the task associated with the error, may be omitted entirely or set to null.",
            "nullable": true,
            "example": "<invalid_node_id>"
          },
          "nodeName": {
            "type": "string",
            "description": "Name of the node associated with the error, may be omitted entirely or set to null if it matches nodeId or is not provided.",
            "nullable": true,
            "example": "<invalid_node_name>"
          }
        }
      },
      "ErrorMessage_1": {
        "type": "object",
        "properties": {
          "messageDescription": {
            "type": "string",
            "description": "Description of the error.",
            "example": "<error_message>"
          },
          "messageId": {
            "type": "string",
            "description": "Error code",
            "example": "<error_message_id>"
          }
        }
      }
    }
  },
  "x-original-swagger-version": "2.0",
  "x-explorer-enabled": false
}
```