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

Updates the name of a catalog.

Use when you want to rename a single existing catalog in your project.

Definition

Authorization

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

Available access type

Permissions needed

Private access

Catalogs > Update catalog

Read more about:

Path parameters

Parameter

Type

Description

Required

projectToken

string

The ID of your project.

Required

catalogId

string

The ID of the desired existing catalog.

Required

Body Parameters

Parameter

Type

Description

Required

name

string

New name for the catalog.

Required

fields

array of objects

Existing 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

Parameter

Type

Description

Required

authorization

string

Used for authentication. Read more in the Authentication section.

Required

content-type

string

application/json

Required

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!