Rename model

curl --request PATCH \
  --url https://{instance}.omniapp.co/api/v1/models/{modelId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "customer_metrics_v2"
}
'

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "baseModelId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "connectionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "modelKind": "<string>",
  "name": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "deletedAt": "2023-11-07T05:31:56Z"
}

Models

Rename model

Renames a model by updating its name. 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.

Supported model kinds:

SCHEMA - Schema models
SHARED - Shared models
SHARED_EXTENSION - Shared extension models
BRANCH - Branch models

Workbook models and query models cannot be renamed via this endpoint and will return a 400 error.

Authorization:

For SCHEMA models: requires MANAGE_MODEL permission
For all other supported models: requires UPDATE permission

Uniqueness constraints: 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

models

{modelId}

Rename model

curl --request PATCH \
  --url https://{instance}.omniapp.co/api/v1/models/{modelId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "customer_metrics_v2"
}
'

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "baseModelId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "connectionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "modelKind": "<string>",
  "name": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "deletedAt": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization

string

header

required

Can be either an Organization API Key or Personal Access Token (PAT).

Include in the Authorization header as: Bearer YOUR_TOKEN

Path Parameters

modelId

string<uuid>

required

ID of the model to rename.

Body

application/json

name

string

required

The new name for the model.

Example:

"customer_metrics_v2"

Response

Model renamed successfully

string<uuid>

ID of the model.

baseModelId

string<uuid> | null

ID of the base model, if applicable.

connectionId

string<uuid> | null

ID of the connection the model is based on.

modelKind

string | null

The type of model.

name

string | null

The name of the model.

createdAt

string<date-time>

The time the model was created.

updatedAt

string<date-time>

The time the model was last updated.

deletedAt

string<date-time> | null

The time the model was deleted, if applicable.

Create model

Delete branch

⌘I

Getting started

Endpoints

Rename model

Authorizations

Path Parameters

Body

Response