v1
latestOpenAPI 3.1.02026-07-2618690613.4 KBModels
Rename model
<Warning> Workbook models and query models cannot be renamed via this endpoint. </Warning>Rename a model. This endpoint allows you to programmatically rename models without using the UI, which is particularly useful for bulk operations on shared extension models created via POST /api/v1/models.
The new name must be unique among active models with the same modelKind and baseModelId.
Branch-specific constraints:
- Name must match git-compatible regex: [\w\-/]+
- No git ref path conflicts (e.g., cannot rename to team if team/project exists)
- Cannot rename branches with an open pull request (when pullRequestUrl is set) — renaming would desync Omni from the git remote
patch/v1/models/{modelId}
Path parameters
modelIdstring uuid required
ID of the model to rename.
Request body
Example request
{
"name": "customer_metrics_v2"
}Response
Model renamed successfully