Skip to main content
PATCH
Update a model

Authorizations

Authorization
string
header
required

API key authentication using Bearer token format: Bearer <basedash_api_key>

Path Parameters

orgId
string
required

Organization ID

id
string
required

Model ID

Body

application/json
name
string

Human-readable model name

Required string length: 1 - 100
referenceName
string

Stable SQL reference name for the model

Required string length: 1 - 100
description
string

Model description

Maximum string length: 10000
sqlQuery
string

SQL query that defines the reusable dataset

Required string length: 1 - 100000
measures
object[]

Ordered reusable aggregate expressions

Maximum array length: 50
segments
object[]

Ordered reusable predicate expressions

Maximum array length: 50
defaultTimeColumn
string | null

Default date result column, or null for no default

Required string length: 1 - 256
verified
boolean

Whether the model is verified

Response

Model updated successfully

data
object
required