API Reference / Predefined Items
/predefined_items/{predefined_item_id} Update a specific predefined item
Updates a predefined item. Requires the deal items permission. Pass partial=true to leave omitted fields untouched; without it, an omitted description, cost or price is reset to its default.
Path parameters
| Name | Type | Description |
|---|---|---|
predefined_item_id req | string | Predefined Item ID |
Request body
namestringName of the predefined item
descriptionstringDescription text of the predefined item
costnumberfloatCost of the predefined item (if deals costs are enabled)
pricenumberfloatPrice of the predefined item
Responses
200 OK
statusintegerint32Response code
messagestringResponse message
timestampintegerunix-timestampResponse time
dataobjectobject fields →
predefined_itemobjectA user-configured item which can aid in the creation of deal items
object fields →
idstringbson-idID of the predefined item
namestringName of the predefined item
descriptionstringDescription text of the predefined item
costnumberfloatCost of the predefined item
pricenumberfloatPrice of the predefined item
positionintegerint32Position of the predefined item in the items list
item_group_idstringbson-idID of the predefined item group (or empty if the item is not in a group)
Standard error responses: 400 · 401 · 403 · 404 · 409 · 500 — shared across the API. See Errors.