/pipedrive-sales | Type: Application | PCID required: Yes
Tools
pipedrive_sales_add_activity
Add a new activity Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
attendees | any[] | No | — | The attendees of the activity |
busy | boolean | No | — | Whether the activity marks the assignee as busy or not in their calendar |
deal_id | integer | No | — | The ID of the deal linked to the activity |
done | boolean | No | — | Whether the activity is marked as done or not |
due_date | string | No | — | The due date of the activity |
due_time | string | No | — | The due time of the activity |
duration | string | No | — | The duration of the activity |
lead_id | string | No | — | The ID of the lead linked to the activity |
location | object | No | — | Location of the activity |
note | string | No | — | The note of the activity |
org_id | integer | No | — | The ID of the organization linked to the activity |
owner_id | integer | No | — | The ID of the user who owns the activity |
participants | any[] | No | — | The participants of the activity |
person_id | integer | No | — | The ID of the person linked to the activity |
priority | integer | No | — | The priority of the activity. Mappable to a specific string using activityFields API. |
project_id | integer | No | — | The ID of the project linked to the activity |
public_description | string | No | — | The public description of the activity |
subject | string | No | — | The subject of the activity |
type | string | No | — | The type of the activity |
pipedrive_sales_add_pipeline
Add a new pipeline Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
is_deal_probability_enabled | boolean | No | — | Whether deal probability is disabled or enabled for this pipeline |
name | string | Yes | — | The name of the pipeline |
pipedrive_sales_add_product
Add a product Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
billing_frequency | string | No | — | Only available in Growth and above plans How often a customer is billed for access to a service or product |
billing_frequency_cycles | integer | No | — | Only available in Growth and above plans The number of times the billing frequency repeats for a product in a deal When billing_frequency is set to one-time, this field must be null When billing_frequency is set to weekly, this field cannot be null For all the other values of billing_frequency, null represents a product billed indefinitely Must be a positive integer less or equal to 208 |
category | number | No | — | The category of the product |
code | string | No | — | The product code |
custom_fields | object | No | — | An object where each key represents a custom field. All custom fields are referenced as randomly generated 40-character hashes |
description | string | No | — | The product description |
is_linkable | boolean | No | — | Whether this product can be added to a deal or not |
name | string | Yes | — | The name of the product. Cannot be an empty string |
owner_id | integer | No | — | The ID of the user who will be marked as the owner of this product. When omitted, the authorized user ID will be used |
prices | any[] | No | — | An array of objects, each containing: currency (string), price (number), cost (number, optional), direct_cost (number, optional). Note that there can only be one price per product per currency. When prices is omitted altogether, a default price of 0 and the user’s default currency will be assigned. |
tax | number | No | — | The tax percentage |
unit | string | No | — | The unit in which this product is sold |
visible_to | number | No | — | The visibility of the product. If omitted, the visibility will be set to the default visibility setting of this item type for the authorized user. Read more about visibility groups <a href=“https://support.pipedrive.com/en/article/visibility-groups” target=“_blank” rel=“noopener noreferrer”>here</a>.<h4>Light / Growth and Professional plans</h4><table><tr><th style=“width: 40px”>Value</th><th>Description</th></tr><tr><td>1</td><td>Owner & followers</td><tr><td>3</td><td>Entire company</td></tr></table><h4>Premium / Ultimate plan</h4><table><tr><th style=“width: 40px”>Value</th><th>Description</th></tr><tr><td>1</td><td>Owner only</td><tr><td>3</td><td>Owner’s visibility group</td></tr><tr><td>5</td><td>Owner’s visibility group and sub-groups</td></tr><tr><td>7</td><td>Entire company</td></tr></table> |
pipedrive_sales_add_product_field
Create one product field Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
field_name | string | Yes | — | Field name |
field_type | string | Yes | — | The type of the field<table><tr><th>Value</th><th>Description</th></tr><tr><td>varchar</td><td>Text (up to 255 characters)</td><tr><td>varchar_auto</td><td>Autocomplete text (up to 255 characters)</td><tr><td>text</td><td>Long text (up to 65k characters)</td><tr><td>double</td><td>Numeric value</td><tr><td>monetary</td><td>Monetary field (has a numeric value and a currency value)</td><tr><td>date</td><td>Date (format YYYY-MM-DD)</td><tr><td>set</td><td>Options field with a possibility of having multiple chosen options</td><tr><td>enum</td><td>Options field with a single possible chosen option</td><tr><td>user</td><td>User field (contains a user ID of another Pipedrive user)</td><tr><td>org</td><td>Organization field (contains an organization ID which is stored on the same account)</td><tr><td>people</td><td>Person field (contains a person ID which is stored on the same account)</td><tr><td>phone</td><td>Phone field (up to 255 numbers and/or characters)</td><tr><td>time</td><td>Time field (format HH:MM:SS)</td><tr><td>timerange</td><td>Time-range field (has a start time and end time value, both HH:MM:SS)</td><tr><td>daterange</td><td>Date-range field (has a start date and end date value, both YYYY-MM-DD)</td><tr><td>address</td><td>Address field</dd></table> |
options | any[] | No | — | Field options (required for enum and set field types) |
ui_visibility | object | No | — | UI visibility settings for the field. Controls where the field appears in the Pipedrive web UI. Note that products have a simpler visibility model than other entity types. |
pipedrive_sales_add_product_field_options
Add product field options in bulk Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
field_code | string | Yes | — | The unique code identifying the field |
body | any[] | Yes | — | Array of options to add. Each item must contain a label. At least one option is required. |
pipedrive_sales_add_product_follower
Add a follower to a product Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The ID of the product |
user_id | integer | Yes | — | The ID of the user to add as a follower |
pipedrive_sales_add_product_variation
Add a product variation Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The ID of the product |
name | string | Yes | — | The name of the product variation. The maximum length is 255 characters. |
prices | any[] | No | — | Array of objects, each containing: currency (string), price (number), cost (number, optional), direct_cost (number, optional), notes (string, optional). When prices is omitted altogether, a default price of 0, a default cost of 0, a default direct_cost of 0 and the user’s default currency will be assigned. |
pipedrive_sales_add_stage
Add a new stage Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
days_to_rotten | integer | No | — | The number of days the deals not updated in this stage would become rotten. Applies only if the is_deal_rot_enabled is set. |
deal_probability | integer | No | — | The success probability percentage of the deal. Used/shown when deal weighted values are used. |
is_deal_rot_enabled | boolean | No | — | Whether deals in this stage can become rotten |
name | string | Yes | — | The name of the stage |
pipeline_id | integer | Yes | — | The ID of the pipeline to add stage to |
pipedrive_sales_delete_activity
Delete an activity Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The ID of the activity |
pipedrive_sales_delete_pipeline
Delete a pipeline Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The ID of the pipeline |
pipedrive_sales_delete_product
Delete a product Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The ID of the product |
pipedrive_sales_delete_product_field
Delete one product field Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
field_code | string | Yes | — | The unique code identifying the field |
pipedrive_sales_delete_product_field_options
Delete product field options in bulk Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
field_code | string | Yes | — | The unique code identifying the field |
body | any[] | Yes | — | Array of option IDs to delete. Each item must contain an ID of the option to delete. At least one option ID is required. The entire request fails if any option does not exist. |
pipedrive_sales_delete_product_follower
Delete a follower from a product Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The ID of the product |
follower_id | integer | Yes | — | The ID of the following user |
pipedrive_sales_delete_product_image
Delete an image of a product Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The ID of the product |
pipedrive_sales_delete_product_variation
Delete a product variation Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The ID of the product |
product_variation_id | integer | Yes | — | The ID of the product variation |
pipedrive_sales_delete_stage
Delete a stage Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The ID of the stage |
pipedrive_sales_duplicate_product
Duplicate a product Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The ID of the product |
pipedrive_sales_get_activities
Get all activities Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
filter_id | integer | No | — | If supplied, only activities matching the specified filter are returned |
ids | string | No | — | Optional comma separated string array of up to 100 entity ids to fetch. If filter_id is provided, this is ignored. If any of the requested entities do not exist or are not visible, they are not included in the response. |
owner_id | integer | No | — | If supplied, only activities owned by the specified user are returned. If filter_id is provided, this is ignored. |
deal_id | integer | No | — | If supplied, only activities linked to the specified deal are returned. If filter_id is provided, this is ignored. |
lead_id | string | No | — | If supplied, only activities linked to the specified lead are returned. If filter_id is provided, this is ignored. |
person_id | integer | No | — | If supplied, only activities whose primary participant is the given person are returned. If filter_id is provided, this is ignored. |
org_id | integer | No | — | If supplied, only activities linked to the specified organization are returned. If filter_id is provided, this is ignored. |
done | boolean | No | — | If supplied, only activities with specified ‘done’ flag value are returned |
updated_since | string | No | — | If set, only activities with an update_time later than or equal to this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z. |
updated_until | string | No | — | If set, only activities with an update_time earlier than this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z. |
sort_by | string | No | — | The field to sort by. Supported fields: id, update_time, add_time, due_date. |
sort_direction | string | No | — | The sorting direction. Supported values: asc, desc. |
include_fields | string | No | — | Optional comma separated string array of additional fields to include Valid values: attendees |
limit | integer | No | — | For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed. |
cursor | string | No | — | For pagination, the marker (an opaque string value) representing the first item on the next page |
pipedrive_sales_get_activity
Get details of an activity Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The ID of the activity |
include_fields | string | No | — | Optional comma separated string array of additional fields to include Valid values: attendees |
pipedrive_sales_get_activity_field
Get one activity field Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
field_code | string | Yes | — | The unique code identifying the field |
include_fields | string | No | — | Optional comma separated string array of additional data namespaces to include in response Valid values: ui_visibility |
pipedrive_sales_get_activity_fields
Get all activity fields Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
include_fields | string | No | — | Optional comma separated string array of additional data namespaces to include in response Valid values: ui_visibility |
limit | integer | No | — | For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed. |
cursor | string | No | — | For pagination, the marker (an opaque string value) representing the first item on the next page |
pipedrive_sales_get_pipeline
Get one pipeline Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The ID of the pipeline |
pipedrive_sales_get_pipelines
Get all pipelines Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
sort_by | string | No | — | The field to sort by. Supported fields: id, update_time, add_time. |
sort_direction | string | No | — | The sorting direction. Supported values: asc, desc. |
limit | integer | No | — | For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed. |
cursor | string | No | — | For pagination, the marker (an opaque string value) representing the first item on the next page |
pipedrive_sales_get_product
Get one product Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The ID of the product |
pipedrive_sales_get_product_field
Get one product field Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
field_code | string | Yes | — | The unique code identifying the field |
include_fields | string | No | — | Optional comma separated string array of additional data namespaces to include in response Valid values: ui_visibility |
pipedrive_sales_get_product_fields
Get all product fields Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
include_fields | string | No | — | Optional comma separated string array of additional data namespaces to include in response Valid values: ui_visibility |
limit | integer | No | — | For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed. |
cursor | string | No | — | For pagination, the marker (an opaque string value) representing the first item on the next page |
pipedrive_sales_get_product_followers
List followers of a product Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The ID of the product |
limit | integer | No | — | For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed. |
cursor | string | No | — | For pagination, the marker (an opaque string value) representing the first item on the next page |
pipedrive_sales_get_product_followers_changelog
List followers changelog of a product Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The ID of the product |
limit | integer | No | — | For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed. |
cursor | string | No | — | For pagination, the marker (an opaque string value) representing the first item on the next page |
pipedrive_sales_get_product_image
Get image of a product Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The ID of the product |
pipedrive_sales_get_product_variations
Get all product variations Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The ID of the product |
cursor | string | No | — | For pagination, the marker (an opaque string value) representing the first item on the next page |
limit | integer | No | — | For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed. |
pipedrive_sales_get_products
Get all products Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
owner_id | integer | No | — | If supplied, only products owned by the given user will be returned |
ids | string | No | — | Optional comma separated string array of up to 100 entity ids to fetch. If filter_id is provided, this is ignored. If any of the requested entities do not exist or are not visible, they are not included in the response. |
filter_id | integer | No | — | The ID of the filter to use |
cursor | string | No | — | For pagination, the marker (an opaque string value) representing the first item on the next page |
limit | integer | No | — | For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed. |
sort_by | string | No | — | The field to sort by. Supported fields: id, name, add_time, update_time. |
sort_direction | string | No | — | The sorting direction. Supported values: asc, desc. |
custom_fields | string | No | — | Comma separated string array of custom fields keys to include. If you are only interested in a particular set of custom fields, please use this parameter for a smaller response.<br/>A maximum of 15 keys is allowed. |
pipedrive_sales_get_stage
Get one stage Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The ID of the stage |
pipedrive_sales_get_stages
Get all stages Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
pipeline_id | integer | No | — | The ID of the pipeline to fetch stages for. If omitted, stages for all pipelines will be fetched. |
sort_by | string | No | — | The field to sort by. Supported fields: id, update_time, add_time, order_nr. |
sort_direction | string | No | — | The sorting direction. Supported values: asc, desc. |
limit | integer | No | — | For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed. |
cursor | string | No | — | For pagination, the marker (an opaque string value) representing the first item on the next page |
pipedrive_sales_get_user_followers
List followers of a user Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The ID of the user |
limit | integer | No | — | For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed. |
cursor | string | No | — | For pagination, the marker (an opaque string value) representing the first item on the next page |
pipedrive_sales_search_item
Perform a search from multiple item types Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
term | string | Yes | — | The search term to look for. Minimum 2 characters (or 1 if using exact_match). Please note that the search term has to be URL encoded. |
item_types | string | No | — | A comma-separated string array. The type of items to perform the search from. Defaults to all. Valid values: deal, person, organization, product, lead, file, mail_attachment, project |
fields | string | No | — | A comma-separated string array. The fields to perform the search from. Defaults to all. Relevant for each item type are:<br> <table> <tr><th><b>Item type</b></th><th><b>Field</b></th></tr> <tr><td>Deal</td><td>custom_fields, notes, title</td></tr> <tr><td>Person</td><td>custom_fields, email, name, notes, phone</td></tr> <tr><td>Organization</td><td>address, custom_fields, name, notes</td></tr> <tr><td>Product</td><td>code, custom_fields, name</td></tr> <tr><td>Lead</td><td>custom_fields, notes, title</td></tr> <tr><td>File</td><td>name</td></tr> <tr><td>Mail attachment</td><td>name</td></tr> <tr><td>Project</td><td> custom_fields, notes, title, description </td></tr> </table> <br> Only the following custom field types are searchable: address, varchar, text, varchar_auto, double, monetary and phone. Read more about searching by custom fields <a href=“https://support.pipedrive.com/en/article/search-finding-what-you-need#searching-by-custom-fields” target=“_blank” rel=“noopener noreferrer”>here</a>. |
search_for_related_items | boolean | No | — | When enabled, the response will include up to 100 newest related leads and 100 newest related deals for each found person and organization and up to 100 newest related persons for each found organization |
exact_match | boolean | No | — | When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive. |
include_fields | string | No | — | A comma-separated string array. Supports including optional fields in the results which are not provided by default. Valid values: deal.cc_email, person.picture, product.price |
limit | integer | No | — | For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 100 is allowed. |
cursor | string | No | — | For pagination, the marker (an opaque string value) representing the first item on the next page |
pipedrive_sales_search_item_by_field
Perform a search using a specific field from an item type Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
term | string | Yes | — | The search term to look for. Minimum 2 characters (or 1 if match is exact). Please note that the search term has to be URL encoded. |
entity_type | string | Yes | — | The type of the field to perform the search from |
match | string | No | — | The type of match used against the term. The search <b>is</b> case sensitive.<br/><br/> E.g. in case of searching for a value monkey, <ul> <li>with exact match, you will only find it if term is monkey</li> <li>with beginning match, you will only find it if the term matches the beginning or the whole string, e.g. monk and monkey</li> <li>with middle match, you will find the it if the term matches any substring of the value, e.g. onk and ke</li> </ul>. |
field | string | Yes | — | The key of the field to search from. The field key can be obtained by fetching the list of the fields using any of the fields’ API GET methods (dealFields, personFields, etc.). Only the following custom field types are searchable: address, varchar, text, varchar_auto, double, monetary and phone. Read more about searching by custom fields <a href=“https://support.pipedrive.com/en/article/search-finding-what-you-need#searching-by-custom-fields” target=“_blank” rel=“noopener noreferrer”>here</a>. |
limit | integer | No | — | For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed. |
cursor | string | No | — | For pagination, the marker (an opaque string value) representing the first item on the next page |
pipedrive_sales_search_products
Search products Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
term | string | Yes | — | The search term to look for. Minimum 2 characters (or 1 if using exact_match). Please note that the search term has to be URL encoded. |
fields | string | No | — | A comma-separated string array. The fields to perform the search from. Defaults to all of them. Only the following custom field types are searchable: address, varchar, text, varchar_auto, double, monetary and phone. Read more about searching by custom fields <a href=“https://support.pipedrive.com/en/article/search-finding-what-you-need#searching-by-custom-fields” target=“_blank” rel=“noopener noreferrer”>here</a>. Valid values: code, custom_fields, name |
exact_match | boolean | No | — | When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive. |
include_fields | string | No | — | Supports including optional fields in the results which are not provided by default Valid values: product.price |
limit | integer | No | — | For pagination, the limit of entries to be returned. If not provided, 100 items will be returned. Please note that a maximum value of 500 is allowed. |
cursor | string | No | — | For pagination, the marker (an opaque string value) representing the first item on the next page |
pipedrive_sales_update_activity
Update an activity Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The ID of the activity |
attendees | any[] | No | — | The attendees of the activity |
busy | boolean | No | — | Whether the activity marks the assignee as busy or not in their calendar |
deal_id | integer | No | — | The ID of the deal linked to the activity |
done | boolean | No | — | Whether the activity is marked as done or not |
due_date | string | No | — | The due date of the activity |
due_time | string | No | — | The due time of the activity |
duration | string | No | — | The duration of the activity |
lead_id | string | No | — | The ID of the lead linked to the activity |
location | object | No | — | Location of the activity |
note | string | No | — | The note of the activity |
org_id | integer | No | — | The ID of the organization linked to the activity |
owner_id | integer | No | — | The ID of the user who owns the activity |
participants | any[] | No | — | The participants of the activity |
person_id | integer | No | — | The ID of the person linked to the activity |
priority | integer | No | — | The priority of the activity. Mappable to a specific string using activityFields API. |
project_id | integer | No | — | The ID of the project linked to the activity |
public_description | string | No | — | The public description of the activity |
subject | string | No | — | The subject of the activity |
type | string | No | — | The type of the activity |
pipedrive_sales_update_pipeline
Update a pipeline Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The ID of the pipeline |
is_deal_probability_enabled | boolean | No | — | Whether deal probability is disabled or enabled for this pipeline |
name | string | No | — | The name of the pipeline |
pipedrive_sales_update_product
Update a product Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The ID of the product |
billing_frequency | string | No | — | Only available in Growth and above plans How often a customer is billed for access to a service or product |
billing_frequency_cycles | integer | No | — | Only available in Growth and above plans The number of times the billing frequency repeats for a product in a deal When billing_frequency is set to one-time, this field must be null When billing_frequency is set to weekly, this field cannot be null For all the other values of billing_frequency, null represents a product billed indefinitely Must be a positive integer less or equal to 208 |
category | number | No | — | The category of the product |
code | string | No | — | The product code |
custom_fields | object | No | — | An object where each key represents a custom field. All custom fields are referenced as randomly generated 40-character hashes |
description | string | No | — | The product description |
is_linkable | boolean | No | — | Whether this product can be added to a deal or not |
name | string | No | — | The name of the product. Cannot be an empty string |
owner_id | integer | No | — | The ID of the user who will be marked as the owner of this product. When omitted, the authorized user ID will be used |
prices | any[] | No | — | An array of objects, each containing: currency (string), price (number), cost (number, optional), direct_cost (number, optional). Note that there can only be one price per product per currency. When prices is omitted altogether, a default price of 0 and the user’s default currency will be assigned. |
tax | number | No | — | The tax percentage |
unit | string | No | — | The unit in which this product is sold |
visible_to | number | No | — | The visibility of the product. If omitted, the visibility will be set to the default visibility setting of this item type for the authorized user. Read more about visibility groups <a href=“https://support.pipedrive.com/en/article/visibility-groups” target=“_blank” rel=“noopener noreferrer”>here</a>.<h4>Light / Growth and Professional plans</h4><table><tr><th style=“width: 40px”>Value</th><th>Description</th></tr><tr><td>1</td><td>Owner & followers</td><tr><td>3</td><td>Entire company</td></tr></table><h4>Premium / Ultimate plan</h4><table><tr><th style=“width: 40px”>Value</th><th>Description</th></tr><tr><td>1</td><td>Owner only</td><tr><td>3</td><td>Owner’s visibility group</td></tr><tr><td>5</td><td>Owner’s visibility group and sub-groups</td></tr><tr><td>7</td><td>Entire company</td></tr></table> |
pipedrive_sales_update_product_field
Update one product field Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
field_code | string | Yes | — | The unique code identifying the field |
field_name | string | No | — | Field name |
ui_visibility | object | No | — | UI visibility settings for the field. Controls where the field appears in the Pipedrive web UI. Note that products have a simpler visibility model than other entity types. |
pipedrive_sales_update_product_field_options
Update product field options in bulk Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
field_code | string | Yes | — | The unique code identifying the field |
body | any[] | Yes | — | Array of options to update. Each item must contain an ID and the updated label. At least one option is required. The entire request fails if any option does not exist. |
pipedrive_sales_update_product_image
Update an image for a product Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The ID of the product |
data | string | Yes | — | One image supplied in the multipart/form-data encoding |
pipedrive_sales_update_product_variation
Update a product variation Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The ID of the product |
product_variation_id | integer | Yes | — | The ID of the product variation |
name | string | No | — | The name of the product variation. The maximum length is 255 characters. |
prices | any[] | No | — | Array of objects, each containing: currency (string), price (number), cost (number, optional), direct_cost (number, optional), notes (string, optional). When prices is omitted altogether, a default price of 0, a default cost of 0, a default direct_cost of 0 and the user’s default currency will be assigned. |
pipedrive_sales_update_stage
Update stage details Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The ID of the stage |
days_to_rotten | integer | No | — | The number of days the deals not updated in this stage would become rotten. Applies only if the is_deal_rot_enabled is set. |
deal_probability | integer | No | — | The success probability percentage of the deal. Used/shown when deal weighted values are used. |
is_deal_rot_enabled | boolean | No | — | Whether deals in this stage can become rotten |
name | string | No | — | The name of the stage |
pipeline_id | integer | No | — | The ID of the pipeline to add stage to |
pipedrive_sales_upload_product_image
Upload an image for a product Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | integer | Yes | — | The ID of the product |
data | string | Yes | — | One image supplied in the multipart/form-data encoding |

