Update a line item

PUT /crm-objects/v1/objects/line_items/:id

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:

PUT

Content Type:

application/json

Response Format:

json

Requires Authentication?

Yes

Rate Limited?

Yes

Headers

User-Agent

Products:

Sales Professional

Required Scope:

e-commerce

Update an existing line item by its ID.

The request body must be a list of properties you want to update, with each entry including the internal name of the property you want to update, and the new value for that property. See the example 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 :id
Used in the request URL
The ID of the line item you want to update.

Optional Parameters How to use Description
Property List Used in the request body. A list of properties you want to update. Each entry must include the name of the property and the value you want to update to. See the example for more details.