Update a catalog name

/data/v2/projects/{projectToken}/catalogs/{catalogId}

Updates the name of a catalog.

Rename a single catalog in your project using the API or create a new property within the catalog. To create a new property in the API payload, specify all existing properties and add the new one.

Definition

Authorization

In this API call you must use the following authorization access and permissions:

Available access typePermissions needed
Private accessCatalogs > Update catalog

Read more about:

Path parameters

ParameterTypeDescriptionRequired
projectTokenstringThe ID of your project.Required
catalogIdstringThe ID of the desired existing catalog.Required

Body Parameters

ParameterTypeDescriptionRequired
namestringNew name for the catalog.Required
fieldsarray of objectsExisting list of columns and definitions of the catalog. These fields have to match the existing fields in the catalog. (see the Create a catalog method for details)Required

Header

ParameterTypeDescriptionRequired
authorizationstringUsed for authentication. Read more in the Authentication section.Required
content-typestringapplication/jsonRequired

Limitations

You must use the same definition of fields as when you created the catalog. Fields cannot be updated by this method. Only the name can be updated.

Language
Click Try It! to start a request and see the response here!