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:
|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
|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:|
Note that it is not possible to create new fields this way.
|upsert||string (bool??)||?? Default = |
Note that if you keep this value unchanged while specifying a non-existent itemId, a new catalog item will NOT be created.
The keys in the
value:keyformat 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.
Date field format
Catalog fields with Date data-type only accepts UNIX timestamps via API.
|authorization||string||Used for authentication. Read more in the Authentication section.||Required|
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.