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

/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.

Servers

Path parameters

Name Type Required Description
projectToken String Yes

Default value: "12345678-1234-1234-1234-123456789abc"

catalogId String Yes

Default value: "60758e2d18883e1048b817a8"

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

authorization String Yes

Default value: "Basic <APIKeyID/APISecret>"

Request body fields

Name Type Required Description
name String Yes

Default value: "new catalog name"

fields[] Array Yes
fields[].name String Yes

Default value: "field_text"

fields[].type String No

Default value: "string"

fields[].searchable String No

Default value: "true"

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.