Skip to main content
Server path: /freshsales-products | Type: Application | PCID required: Yes

Tools

ToolDescription
freshsales_products_bulk_assign_document_ownerBulk reassign CPQ document ownership
freshsales_products_bulk_assign_product_ownerBulk reassign CPQ product ownership
freshsales_products_bulk_delete_documentsBulk delete CPQ documents
freshsales_products_bulk_delete_productsBulk delete CPQ products
freshsales_products_bulk_restore_documentsBulk restore soft-deleted CPQ documents
freshsales_products_bulk_restore_productsBulk restore soft-deleted CPQ products
freshsales_products_bulk_update_documentsBulk update CPQ documents
freshsales_products_bulk_update_productsBulk update CPQ products
freshsales_products_create_documentCreate a CPQ document (proposal/quote)
freshsales_products_create_productCreate a CPQ product
freshsales_products_delete_documentSoft-delete a CPQ document
freshsales_products_delete_productSoft-delete a CPQ product
freshsales_products_delete_product_pricesDelete pricing entries for a CPQ product
freshsales_products_forget_documentPermanently delete (forget) a CPQ document
freshsales_products_get_documentGet a CPQ document by ID
freshsales_products_get_productGet a CPQ product by ID
freshsales_products_list_document_related_productsList products on a CPQ document
freshsales_products_restore_documentRestore a soft-deleted CPQ document
freshsales_products_restore_productRestore a soft-deleted CPQ product
freshsales_products_update_documentUpdate a CPQ document
freshsales_products_update_document_productsUpdate products on a CPQ document
freshsales_products_update_productUpdate a CPQ product
freshsales_products_update_product_pricesUpdate pricing for a CPQ product

freshsales_products_bulk_assign_document_owner

Bulk reassign CPQ document ownership Parameters:
ParameterTypeRequiredDefaultDescription
owner_idintegerYesUser ID of the new owner.
selected_idsinteger[]YesIDs of documents to reassign.

freshsales_products_bulk_assign_product_owner

Bulk reassign CPQ product ownership Parameters:
ParameterTypeRequiredDefaultDescription
owner_idintegerYesUser ID of the new owner.
selected_idsinteger[]YesIDs of products to reassign.

freshsales_products_bulk_delete_documents

Bulk delete CPQ documents Parameters:
ParameterTypeRequiredDefaultDescription
selected_idsinteger[]YesIDs of documents to delete.

freshsales_products_bulk_delete_products

Bulk delete CPQ products Parameters:
ParameterTypeRequiredDefaultDescription
selected_idsinteger[]YesIDs of products to delete.

freshsales_products_bulk_restore_documents

Bulk restore soft-deleted CPQ documents Parameters:
ParameterTypeRequiredDefaultDescription
selected_idsinteger[]YesIDs of documents to restore.

freshsales_products_bulk_restore_products

Bulk restore soft-deleted CPQ products Parameters:
ParameterTypeRequiredDefaultDescription
selected_idsinteger[]YesIDs of products to restore.

freshsales_products_bulk_update_documents

Bulk update CPQ documents Parameters:
ParameterTypeRequiredDefaultDescription
cpq_documentobjectYesFields to apply to all selected documents.
selected_idsinteger[]YesIDs of documents to update.

freshsales_products_bulk_update_products

Bulk update CPQ products Parameters:
ParameterTypeRequiredDefaultDescription
productobjectYesFields to apply to all selected products.
selected_idsinteger[]YesIDs of products to update.

freshsales_products_create_document

Create a CPQ document (proposal/quote) Parameters:
ParameterTypeRequiredDefaultDescription
cpq_documentobjectYesDocument fields. Common keys: name (required), deal_id, owner_id, cpq_document_template_id, custom_field (object of cf_* keys).

freshsales_products_create_product

Create a CPQ product Parameters:
ParameterTypeRequiredDefaultDescription
productobjectYesProduct fields. Common keys: name (required), category, sku, description, is_active (boolean), product_code, owner_id, custom_field (object of cf_* keys).

freshsales_products_delete_document

Soft-delete a CPQ document Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesNumeric ID of the document to soft-delete.

freshsales_products_delete_product

Soft-delete a CPQ product Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesNumeric ID of the product to soft-delete.

freshsales_products_delete_product_prices

Delete pricing entries for a CPQ product Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesNumeric ID of the product.
product_pricing_idsinteger[]YesIDs of the product pricing records to delete.

freshsales_products_forget_document

Permanently delete (forget) a CPQ document Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesNumeric ID of the document to permanently delete.

freshsales_products_get_document

Get a CPQ document by ID Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesNumeric ID of the document.
includestringNoComma-separated list of associated resources to side-load.

freshsales_products_get_product

Get a CPQ product by ID Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesNumeric ID of the product.
includestringNoComma-separated list of associated resources to side-load.

List products on a CPQ document Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesNumeric ID of the document.
pageintegerNoPage number for paginated results (default 1).

freshsales_products_restore_document

Restore a soft-deleted CPQ document Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesNumeric ID of the document to restore.

freshsales_products_restore_product

Restore a soft-deleted CPQ product Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesNumeric ID of the product to restore.

freshsales_products_update_document

Update a CPQ document Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesNumeric ID of the document to update.
cpq_documentobjectYesPartial document fields to update. Any key accepted by createDocument is accepted here.

freshsales_products_update_document_products

Update products on a CPQ document Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesNumeric ID of the document.
productsobject[]YesArray of product line items. Each item: {product_id, quantity, discount, …}. Additional fields depend on your Freshsales configuration.

freshsales_products_update_product

Update a CPQ product Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesNumeric ID of the product to update.
productobjectYesPartial product fields to update. Any key accepted by createProduct is accepted here.

freshsales_products_update_product_prices

Update pricing for a CPQ product Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesNumeric ID of the product.
product_pricingsobject[]YesArray of pricing entries. Each item: {currency_id, unit_price, …}. Additional fields depend on your Freshsales configuration.