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

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

Updates all properties of a catalog item.

Use when you want to change the properties of an item, or create a new item with the given properties, in an existing catalog in your project. Note that this route will update all the properties of the defined item, which means that the properties that you will not define in the body parameters will become blank.

If you want to update only a few properties of the item and leave the rest intact, use the Catalog item (partial update) request.

Servers

Path parameters

Name Type Required Description
projectToken String Yes

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

itemId String Yes

Default value: "1"

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
properties Object Yes

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.