Documentation Index
Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt
Use this file to discover all available pages before exploring further.
Server path: /freshsales-products | Type: Application | PCID required: Yes
freshsales_products_bulk_assign_document_owner
Bulk reassign CPQ document ownership
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
owner_id | integer | Yes | — | User ID of the new owner. |
selected_ids | integer[] | Yes | — | IDs of documents to reassign. |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"owner_id": {
"type": "integer",
"description": "User ID of the new owner."
},
"selected_ids": {
"type": "array",
"items": {
"type": "integer"
},
"description": "IDs of documents to reassign."
}
},
"required": [
"PCID",
"owner_id",
"selected_ids"
]
}
freshsales_products_bulk_assign_product_owner
Bulk reassign CPQ product ownership
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
owner_id | integer | Yes | — | User ID of the new owner. |
selected_ids | integer[] | Yes | — | IDs of products to reassign. |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"owner_id": {
"type": "integer",
"description": "User ID of the new owner."
},
"selected_ids": {
"type": "array",
"items": {
"type": "integer"
},
"description": "IDs of products to reassign."
}
},
"required": [
"PCID",
"owner_id",
"selected_ids"
]
}
freshsales_products_bulk_delete_documents
Bulk delete CPQ documents
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
selected_ids | integer[] | Yes | — | IDs of documents to delete. |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"selected_ids": {
"type": "array",
"items": {
"type": "integer"
},
"description": "IDs of documents to delete."
}
},
"required": [
"PCID",
"selected_ids"
]
}
freshsales_products_bulk_delete_products
Bulk delete CPQ products
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
selected_ids | integer[] | Yes | — | IDs of products to delete. |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"selected_ids": {
"type": "array",
"items": {
"type": "integer"
},
"description": "IDs of products to delete."
}
},
"required": [
"PCID",
"selected_ids"
]
}
freshsales_products_bulk_restore_documents
Bulk restore soft-deleted CPQ documents
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
selected_ids | integer[] | Yes | — | IDs of documents to restore. |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"selected_ids": {
"type": "array",
"items": {
"type": "integer"
},
"description": "IDs of documents to restore."
}
},
"required": [
"PCID",
"selected_ids"
]
}
freshsales_products_bulk_restore_products
Bulk restore soft-deleted CPQ products
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
selected_ids | integer[] | Yes | — | IDs of products to restore. |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"selected_ids": {
"type": "array",
"items": {
"type": "integer"
},
"description": "IDs of products to restore."
}
},
"required": [
"PCID",
"selected_ids"
]
}
freshsales_products_bulk_update_documents
Bulk update CPQ documents
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
cpq_document | object | Yes | — | Fields to apply to all selected documents. |
selected_ids | integer[] | Yes | — | IDs of documents to update. |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"cpq_document": {
"type": "object",
"description": "Fields to apply to all selected documents."
},
"selected_ids": {
"type": "array",
"items": {
"type": "integer"
},
"description": "IDs of documents to update."
}
},
"required": [
"PCID",
"cpq_document",
"selected_ids"
]
}
freshsales_products_bulk_update_products
Bulk update CPQ products
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
product | object | Yes | — | Fields to apply to all selected products. |
selected_ids | integer[] | Yes | — | IDs of products to update. |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"product": {
"type": "object",
"description": "Fields to apply to all selected products."
},
"selected_ids": {
"type": "array",
"items": {
"type": "integer"
},
"description": "IDs of products to update."
}
},
"required": [
"PCID",
"product",
"selected_ids"
]
}
freshsales_products_create_document
Create a CPQ document (proposal/quote)
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
cpq_document | object | Yes | — | Document fields. Common keys: name (required), deal_id, owner_id, cpq_document_template_id, custom_field (object of cf_* keys). |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"cpq_document": {
"type": "object",
"description": "Document fields. Common keys: name (required), deal_id, owner_id, cpq_document_template_id, custom_field (object of cf_* keys)."
}
},
"required": [
"PCID",
"cpq_document"
]
}
freshsales_products_create_product
Create a CPQ product
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
product | object | Yes | — | Product fields. Common keys: name (required), category, sku, description, is_active (boolean), product_code, owner_id, custom_field (object of cf_* keys). |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"product": {
"type": "object",
"description": "Product fields. Common keys: name (required), category, sku, description, is_active (boolean), product_code, owner_id, custom_field (object of cf_* keys)."
}
},
"required": [
"PCID",
"product"
]
}
freshsales_products_delete_document
Soft-delete a CPQ document
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
id | integer | Yes | — | Numeric ID of the document to soft-delete. |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Numeric ID of the document to soft-delete."
}
},
"required": [
"PCID",
"id"
]
}
freshsales_products_delete_product
Soft-delete a CPQ product
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
id | integer | Yes | — | Numeric ID of the product to soft-delete. |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Numeric ID of the product to soft-delete."
}
},
"required": [
"PCID",
"id"
]
}
freshsales_products_delete_product_prices
Delete pricing entries for a CPQ product
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
id | integer | Yes | — | Numeric ID of the product. |
product_pricing_ids | integer[] | Yes | — | IDs of the product pricing records to delete. |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Numeric ID of the product."
},
"product_pricing_ids": {
"type": "array",
"items": {
"type": "integer"
},
"description": "IDs of the product pricing records to delete."
}
},
"required": [
"PCID",
"id",
"product_pricing_ids"
]
}
freshsales_products_forget_document
Permanently delete (forget) a CPQ document
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
id | integer | Yes | — | Numeric ID of the document to permanently delete. |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Numeric ID of the document to permanently delete."
}
},
"required": [
"PCID",
"id"
]
}
freshsales_products_get_document
Get a CPQ document by ID
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
id | integer | Yes | — | Numeric ID of the document. |
include | string | No | — | Comma-separated list of associated resources to side-load. |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Numeric ID of the document."
},
"include": {
"type": "string",
"description": "Comma-separated list of associated resources to side-load."
}
},
"required": [
"PCID",
"id"
]
}
freshsales_products_get_product
Get a CPQ product by ID
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
id | integer | Yes | — | Numeric ID of the product. |
include | string | No | — | Comma-separated list of associated resources to side-load. |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Numeric ID of the product."
},
"include": {
"type": "string",
"description": "Comma-separated list of associated resources to side-load."
}
},
"required": [
"PCID",
"id"
]
}
List products on a CPQ document
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
id | integer | Yes | — | Numeric ID of the document. |
page | integer | No | — | Page number for paginated results (default 1). |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Numeric ID of the document."
},
"page": {
"type": "integer",
"description": "Page number for paginated results (default 1)."
}
},
"required": [
"PCID",
"id"
]
}
freshsales_products_restore_document
Restore a soft-deleted CPQ document
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
id | integer | Yes | — | Numeric ID of the document to restore. |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Numeric ID of the document to restore."
}
},
"required": [
"PCID",
"id"
]
}
freshsales_products_restore_product
Restore a soft-deleted CPQ product
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
id | integer | Yes | — | Numeric ID of the product to restore. |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Numeric ID of the product to restore."
}
},
"required": [
"PCID",
"id"
]
}
freshsales_products_update_document
Update a CPQ document
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
id | integer | Yes | — | Numeric ID of the document to update. |
cpq_document | object | Yes | — | Partial document fields to update. Any key accepted by createDocument is accepted here. |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Numeric ID of the document to update."
},
"cpq_document": {
"type": "object",
"description": "Partial document fields to update. Any key accepted by createDocument is accepted here."
}
},
"required": [
"PCID",
"id",
"cpq_document"
]
}
freshsales_products_update_document_products
Update products on a CPQ document
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
id | integer | Yes | — | Numeric ID of the document. |
products | object[] | Yes | — | Array of product line items. Each item: {product_id, quantity, discount, …}. Additional fields depend on your Freshsales configuration. |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Numeric ID of the document."
},
"products": {
"type": "array",
"items": {
"type": "object"
},
"description": "Array of product line items. Each item: {product_id, quantity, discount, ...}. Additional fields depend on your Freshsales configuration."
}
},
"required": [
"PCID",
"id",
"products"
]
}
freshsales_products_update_product
Update a CPQ product
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
id | integer | Yes | — | Numeric ID of the product to update. |
product | object | Yes | — | Partial product fields to update. Any key accepted by createProduct is accepted here. |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Numeric ID of the product to update."
},
"product": {
"type": "object",
"description": "Partial product fields to update. Any key accepted by createProduct is accepted here."
}
},
"required": [
"PCID",
"id",
"product"
]
}
freshsales_products_update_product_prices
Update pricing for a CPQ product
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
id | integer | Yes | — | Numeric ID of the product. |
product_pricings | object[] | Yes | — | Array of pricing entries. Each item: {currency_id, unit_price, …}. Additional fields depend on your Freshsales configuration. |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"id": {
"type": "integer",
"description": "Numeric ID of the product."
},
"product_pricings": {
"type": "array",
"items": {
"type": "object"
},
"description": "Array of pricing entries. Each item: {currency_id, unit_price, ...}. Additional fields depend on your Freshsales configuration."
}
},
"required": [
"PCID",
"id",
"product_pricings"
]
}
