POST
/
api
/
v2
/
dataApp
/
embed
/
update
{
  "embedId": "string",
  "accessSettings": {
    "datamartName": "string",
    "isAllowAipilot": true,
    "isAllowEmailReports": false,
    "isAllowManageMetrics": true,
    "isAllowMetricCreation": true,
    "isAllowMetricDeletion": true,
    "isAllowMetricLayoutChange": true,
    "isAllowMetricUpdate": true,
    "isAllowUnderlyingData": false,
    "metricCreationMode": "DRAG_DROP" | "CHAT",
    "tableList": [
      {
        "clientColumn": "string",
        "name": "string"
      }
    ]
  }
}

{
  "id": "string",
  "error": null
}
Update the accessSettings for an existing embed.

​
Headers

​
Authorization
string
required
Bearer API TOKEN

​
POST /update

Update the accessSettings for an existing embed.

​
Request Body

​
embedId
string
required
ID of the embed configuration to update.
​
accessSettings
object
Settings to be updated in the embed configuration.
​
accessSettings.datamartName
string
Name of the datamart used in the embed.
​
accessSettings.isAllowAipilot
boolean
Allow AI pilot features.
​
accessSettings.isAllowEmailReports
boolean
Allow email reports.
​
accessSettings.isAllowManageMetrics
boolean
Allow metric management.
​
accessSettings.isAllowMetricCreation
boolean
Allow metric creation.
​
accessSettings.isAllowMetricDeletion
boolean
Allow metric deletion.
​
accessSettings.isAllowMetricLayoutChange
boolean
Allow metric layout change.
​
accessSettings.isAllowMetricUpdate
boolean
Allow metric updates.
​
accessSettings.isAllowUnderlyingData
boolean
Allow access to underlying data.
​
accessSettings.metricCreationMode
'DRAG_DROP' | 'CHAT'
Mode of metric creation allowed.
​
accessSettings.tableList
array
List of accessible tables.
​
accessSettings.tableList[].clientColumn
string
Client-level column for tenancy.
​
accessSettings.tableList[].name
string
Name of the table.
{
  "embedId": "string",
  "accessSettings": {
    "datamartName": "string",
    "isAllowAipilot": true,
    "isAllowEmailReports": false,
    "isAllowManageMetrics": true,
    "isAllowMetricCreation": true,
    "isAllowMetricDeletion": true,
    "isAllowMetricLayoutChange": true,
    "isAllowMetricUpdate": true,
    "isAllowUnderlyingData": false,
    "metricCreationMode": "DRAG_DROP" | "CHAT",
    "tableList": [
      {
        "clientColumn": "string",
        "name": "string"
      }
    ]
  }
}
All accessSettings fields are optional; only provided fields will be updated.

​
Response

{
  "id": "string",
  "error": null
}

​
Possible Errors

CodeMessageHTTP Status
INVALID_DATA_APP_API_KEYMissing or invalid data app400
INVALID_EMBED_IDEmbed ID not found400
INVALID_REQUEST_BODYAccess settings empty or malformed400
INTERNAL_SERVER_ERRORUnexpected failure500