API: Add product form item

addProductFormItem

Add a new item (option) to an existing product form component, e.g. a new value for select, radio or multicheckbox field. Returns the ID of the created item. To update existing items use editProductForm. For items with pricing (Regular or Once), pass pricing=1 and paytype or prices will not be saved.

Required parameters

Parameter	Description
id	Form field ID
name	Item label

Optional parameters

Parameter	Description
variable_id	Item variable identifier or value passed to modules (defaults to name)
description	Item description
sort_order	Item position, by default the item is added as the last one
paytype	Item pricing model: Free, Once, Regular. Required when pricing is set
pricing	Set to 1 for items with pricing (Regular or Once paytype). Required for prices to be saved. Omit for Free items.
m	Monthly price (Regular paytype)
q	Quarterly price (Regular paytype)
s	Semi-annual price (Regular paytype)
a	Annual price (Regular paytype)
b	Biennial price (Regular paytype)
t	Triennial price (Regular paytype)
d	Daily price (Regular paytype)
w	Weekly price (Regular paytype)
m_setup	Monthly setup fee (Regular paytype)
a_setup	Annual setup fee (Regular paytype)
m1	One-time price (Once paytype)
m_setup1	One-time setup fee (Once paytype)

Request

GET /admin/api.php?api_id=API_ID&api_key=API_KEY&call=addProductFormItem&id=ID&name=NAME

PHP Samples

PHP Samples: Add free item

PHP Samples: Add item with Regular pricing

PHP Samples: Add item with one-time (Once) pricing

Response

{
    "success": true,
    "item_id": 104,
    "call": "addProductFormItem",
    "server_time": 1706614584
}