Update a group of line items

POST /crm-objects/v1/objects/line_items/batch-update

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?

Yes

Headers

User-Agent

Products:

Sales Professional

Required Scope:

e-commerce

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

The request body will be an array, with each element containing the ID of the line item to update and a list of properties to update for that line item. 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.
Line item ID "objectId":
Used in the request body.
The ID of the line item you want to update.

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