Skip to Content

Embeds

Rename an embed

Change the name and description of a dashboard embed, and optionally of its dashboard.

PUT
/api/v2/data-app/embeds/rename
curl --request PUT https://api.usedatabrain.com/api/v2/data-app/embeds/rename \  --header "Authorization: Bearer $DATABRAIN_API_TOKEN" \  --header "Content-Type: application/json" \  --data '{ "embedId": "sales-overview", "name": "Sales at a glance", "isRenameDashboard": true }'

Auth

A data app API token. See Authentication.

Authorization

DataAppApiToken
headerAuthorizationBearer <token>

A data app API token. A service token is refused.

Body

embedIdstringrequired

A dashboard embed of the data app.

namestringrequired

The new name. Cannot be empty.

The new description. "" does not clear it.

Also rename the dashboard. Every embed of that dashboard shows the new name. Send a JSON boolean.

Default: false

Response

{ "id": "sales-overview", "name": "Sales at a glance", "embedDescription": null }

Errors

Statuserror.codeWhy
400INVALID_REQUEST_BODYembedId or name is missing or empty
400INVALID_DATA_APP_API_KEYYou used a service token
400INVALID_EMBED_IDNo dashboard embed of this data app has this id
500INTERNAL_SERVER_ERRORThe rename failed

For errors that every endpoint returns, see Authentication.

Example Request
curl -X PUT 'https://api.usedatabrain.com/api/v2/data-app/embeds/rename' \  -H 'Content-Type: application/json' \  -d '{  "embedId": "sales-overview",  "name": "Sales at a glance",  "isRenameDashboard": true}'
Example Response
{  "id": "sales-overview",  "name": "Sales at a glance",  "embedDescription": null}