/data/v2/projects/{projectToken}/catalogs/{catalogId}/items/{itemId}/partial-update

Updates specified properties of a catalog item.

Use when you want to change some of the properties of an item in an existing catalog in your project. The Catalog item - Partial update route compared to the Update a catalog item only updates the specified properties of the item. If a property of an item isn´t specified in the request, this property remains unchanged.

Definition

Authorization

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

Available access type

Permissions needed

Private access

Catalogs > Partial update catalog item

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

itemId

string

The ID of the desired item within an existing catalog.

Note that due to the way the endpoint is decomposed, edits using API will only work with itemIds NOT containing /.

Required

Body Parameters

Parameter

Type

Description

Required

properties

object

Specify the item's properties in the catalog's fields. These need to be in the catalog definition and a value:key format, such as:

"properties": { "name": "iMac", "manufacturer": "Apple", ... }

Note that it is not possible to create new fields this way.

Required

upsert

string (bool??)

?? Default = False

Note that if you keep this value unchanged while specifying a non-existent itemId, a new catalog item will NOT be created.

No

🚧

Properties format

The keys in the value:key format need to be of the correct type defined by the value. The key in any of the properties also cannot contain NUL, a dot (.), a dollar sign ($), or be empty.

If one of these two conditions isn’t met, it will result in a catalog schema validation error.

Furthermore, only existing fields can be updated; new fields cannot be created with this request.

Header

Parameter

Type

Description

Required

authorization

string

Used for authentication. Read more in the Authentication section.

Required

content-type

string

application/json

Required

📘

Asynchronous endpoint

Note that this endpoint is Asynchronous, which means that success response means only that the request is queued to be processed later, not that the item was successfully updated.

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