/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.
Definition
Authorization
In this API call, you must use the following authorization access and permissions:
| Available access type | Permissions needed |
|---|---|
| Private access | Catalogs > Create or 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 |
Properties format
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 containNUL, 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.
Header
| Parameter | Type | Description | Required |
|---|---|---|---|
| authorization | string | Used for authentication. Read more in the Authentication section. | Required |
| content-type | string | application/json | Required |
Additional payload and response example
{
"properties": {
"name": "iMac",
"manufacturer": "Apple"
}
}
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.