POST /predefined_items

Create a new predefined item

Creates a predefined item. name is required and must be unique on the account; description, cost and price are optional. Requires the deal items permission. Accounts are capped at 1000 predefined items.

Request body

namestring
Name of the predefined item
descriptionstring
Description text of the predefined item
costnumberfloat
Cost of the predefined item (if deals costs are enabled)
pricenumberfloat
Price of the predefined item

Responses

201 Created

statusintegerint32
Response code
messagestring
Response message
timestampintegerunix-timestamp
Response time
dataobject
object fields →
- predefined_itemobject
  A user-configured item which can aid in the creation of deal items
  object fields →
  idstringbson-id
  ID of the predefined item
  namestring
  Name of the predefined item
  descriptionstring
  Description text of the predefined item
  costnumberfloat
  Cost of the predefined item
  pricenumberfloat
  Price of the predefined item
  positionintegerint32
  Position of the predefined item in the items list
  item_group_idstringbson-id
  ID 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.

Related guides

POST /predefined_items

curl -X POST "https://app.onepagecrm.com/api/v3/predefined_items" \
  -u $user_id:$api_key \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Solar panels",
    "description": "Photovoltaic solar panels (2019 model)",
    "cost": 95,
    "price": 149.99
  }'

201 example response

{
  "status": 0,
  "message": "OK",
  "timestamp": 1528373119,
  "data": {
    "predefined_item": {
      "id": "5c79510e9007ba3f7519e819",
      "name": "Solar panels",
      "description": "Photovoltaic solar panels (2019 model)",
      "cost": 95,
      "price": 149.99,
      "position": 1,
      "item_group_id": "5c9a53599007ba58f13c8119"
    }
  }
}