Skip to main content
PUT
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. In Settings page, navigate to the Service Tokens section.
  2. Click the “Generate Token” button to create 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).
Content-Type
string
required
Must be set to application/json for all requests.

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

Possible Errors

Quick Start Guide

1

Get your service token

In Settings page, navigate to the Service Tokens section. Click the “Generate Token” button to create a new service token if you don’t have one already.
2

Identify the Data App

Use the List Data Apps API to verify the current Data App configuration:
3

Update the Data App

Make a PUT request with the current name and the new name:
4

Verify the update

List Data Apps again to confirm the update:

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