Skip to main content
curl --request PUT \
  --url https://api.usedatabrain.com/api/v2/data-app \
  --header 'Authorization: Bearer service_token_xyz...' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "Customer Analytics",
    "updateName": "Updated Customer Analytics"
  }'

{
  "name": "Updated Customer Analytics"
}
PUT
https://api.usedatabrain.com
/
api
/
v2
/
data-app
curl --request PUT \
  --url https://api.usedatabrain.com/api/v2/data-app \
  --header 'Authorization: Bearer service_token_xyz...' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "Customer Analytics",
    "updateName": "Updated Customer Analytics"
  }'

{
  "name": "Updated Customer Analytics"
}
Update the name and configuration of an existing Data App. This is useful for renaming Data Apps or updating their settings.
Updating a Data App name will not affect existing embed configurations or API tokens. They will continue to work with the renamed Data App.
Authentication Requirement: This endpoint requires a service token (not a data app API key). Service tokens have elevated permissions to manage Data Apps across your organization.

​
Endpoint Formats

​
Authentication

This endpoint requires a service token in the Authorization header. Service tokens differ from data app API keys and provide organization-level permissions. To access your service token:
  1. Go to your Databrain dashboard and open Settings.
  2. Navigate to Settings.
  3. Find the Service Tokens section.
  4. Click the “Generate Token” button to generate a new service token if you don’t have one already.
Use this token as the Bearer value in your Authorization header.

​
Headers

​
Authorization
string
required
Bearer token for API authentication. Use your service token (not data app API key).
Authorization: Bearer service_token_xyz...
​
Content-Type
string
required
Must be set to application/json for all requests.
Content-Type: application/json

​
Request Body

​
name
string
required
The current name of the Data App to update. This must exactly match an existing Data App name.
​
updateName
string
required
The new name for the Data App. This name must be unique within your organization.

​
Response

​
name
string
The updated name of the Data App.
​
error
object
Error object returned only when the request fails. Not included in successful responses.

​
Examples

​
HTTP Status Code Summary

Status CodeDescription
200OK - Data App updated successfully
400Bad Request - Invalid request parameters
500Internal Server Error - Server error occurred

​
Possible Errors

Error CodeHTTP StatusDescription
INVALID_REQUEST_BODY400Missing or invalid parameters
DATA_APP_NOT_FOUND400Data App with specified name not found
AUTHENTICATION_ERROR400Invalid or missing service token
INTERNAL_SERVER_ERROR500Server error

​
Quick Start Guide

1

Get your service token

Go to your Databrain dashboard, navigate to Settings > Service Tokens, and generate a new service token if you don’t have one.
2

Identify the Data App

Use the List Data Apps API to verify the current Data App configuration:
curl --request GET \
  --url 'https://api.usedatabrain.com/api/v2/data-app' \
  --header 'Authorization: Bearer service_token_xyz...'
3

Update the Data App

Make a PUT request with the current name and the new name:
curl --request PUT \
  --url https://api.usedatabrain.com/api/v2/data-app \
  --header 'Authorization: Bearer service_token_xyz...' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "Current Data App Name",
    "updateName": "New Data App Name"
  }'
4

Verify the update

List Data Apps again to confirm the update:
curl --request GET \
  --url 'https://api.usedatabrain.com/api/v2/data-app' \
  --header 'Authorization: Bearer service_token_xyz...'

​
Next Steps

List Data Apps

View all Data Apps in your organization

Create Data App

Create new Data Apps for your organization

Delete Data App

Remove Data Apps you no longer need

Create API Token

Generate API tokens for your Data Apps