Update a group of products

This endpoint is part of our developer preview program, and should be considered as a non-stable release that will be subject to bugs and breaking changes while under development. Please take this into account as you build against a release. Please subscribe to our changelog for updates.

Method Details

HTTP Methods:

POST

Content Type:

application/json

Response Format:

json

Requires Authentication?

Yes

Rate Limited?

Headers

Products:

Sales Professional

Required Scope:

Update a group of existing products. Up to 100 products can be updated in a single request.

The request body will be an array, with each element containing the ID of the product to update and a list of properties to update for that product. See the examples for details.

Required Parameters	How to use	Description
OAuth Access Token or API Key	Authorization: Bearer {token} header or hapikey={key} query parameter.	Used to authenticate the request. Please see this page for more details about authentication.
Product ID	"objectId": Used in the request body.	The ID of the product you want to update.

Optional Parameters	How to use	Description
Product properties	"properties": [] Used in the request body.	A list of properties to update for the given product. Each entry must include the name of the property and the new value of the property. See the example for details.

JSON

Example POST URL: https://api.hubapi.com/crm-objects/v1/objects/products/batch-update?hapikey=demo Example POST data (updating 2 properties each for 2 products): [ { "objectId": 1642796, "properties": [ { "name": "price", "value": "85.00" }, { "name": "description", "value": "This is an updated product, it's getting a price change." } ] }, { "objectId": 1645187, "properties": [ { "name": "name", "value": "Updated product name now with discount" }, { "name": "discount", "value": "20" } ] } ] Example Response: [ { "objectType": "PRODUCT", "portalId": 62515, "objectId": 1642796, "properties": { "hs_lastmodifieddate": { "versions": [ { "name": "hs_lastmodifieddate", "value": "0", "timestamp": 0, "source": "CALCULATED", "sourceVid": [] } ], "value": "0", "timestamp": 0, "source": "CALCULATED", "sourceId": null }, "price": { "versions": [ { "name": "price", "value": "85.00", "timestamp": 1525292253568, "source": "API", "sourceVid": [] }, { "name": "price", "value": "75.00", "timestamp": 1525289943771, "source": "API", "sourceVid": [] } ], "value": "85.00", "timestamp": 1525292253568, "source": "API", "sourceId": null }, "description": { "versions": [ { "name": "description", "value": "This is an updated product, it's getting a price change.", "timestamp": 1525292253568, "source": "API", "sourceVid": [] }, { "name": "description", "value": "A description the second new product.", "timestamp": 1525289943771, "source": "API", "sourceVid": [] } ], "value": "This is an updated product, it's getting a price change.", "timestamp": 1525292253568, "source": "API", "sourceId": null } }, "version": 0, "isDeleted": false }, { "objectType": "PRODUCT", "portalId": 62515, "objectId": 1645187, "properties": { "hs_lastmodifieddate": { "versions": [ { "name": "hs_lastmodifieddate", "value": "0", "timestamp": 0, "source": "CALCULATED", "sourceVid": [] } ], "value": "0", "timestamp": 0, "source": "CALCULATED", "sourceId": null }, "name": { "versions": [ { "name": "name", "value": "Updated product name now with discount", "timestamp": 1525292253568, "source": "API", "sourceVid": [] }, { "name": "name", "value": "Another new product", "timestamp": 1525289943771, "source": "API", "sourceVid": [] } ], "value": "Updated product name now with discount", "timestamp": 1525292253568, "source": "API", "sourceId": null }, "discount": { "versions": [ { "name": "discount", "value": "20", "timestamp": 1525292253568, "source": "API", "sourceVid": [] } ], "value": "20", "timestamp": 1525292253568, "source": "API", "sourceId": null } }, "version": 0, "isDeleted": false } ]