Skip to main content
Server path: /pipedrive-sales | Type: Application | PCID required: Yes

Tools

ToolDescription
pipedrive_sales_add_activityAdd a new activity
pipedrive_sales_add_pipelineAdd a new pipeline
pipedrive_sales_add_productAdd a product
pipedrive_sales_add_product_fieldCreate one product field
pipedrive_sales_add_product_field_optionsAdd product field options in bulk
pipedrive_sales_add_product_followerAdd a follower to a product
pipedrive_sales_add_product_variationAdd a product variation
pipedrive_sales_add_stageAdd a new stage
pipedrive_sales_delete_activityDelete an activity
pipedrive_sales_delete_pipelineDelete a pipeline
pipedrive_sales_delete_productDelete a product
pipedrive_sales_delete_product_fieldDelete one product field
pipedrive_sales_delete_product_field_optionsDelete product field options in bulk
pipedrive_sales_delete_product_followerDelete a follower from a product
pipedrive_sales_delete_product_imageDelete an image of a product
pipedrive_sales_delete_product_variationDelete a product variation
pipedrive_sales_delete_stageDelete a stage
pipedrive_sales_duplicate_productDuplicate a product
pipedrive_sales_get_activitiesGet all activities
pipedrive_sales_get_activityGet details of an activity
pipedrive_sales_get_activity_fieldGet one activity field
pipedrive_sales_get_activity_fieldsGet all activity fields
pipedrive_sales_get_pipelineGet one pipeline
pipedrive_sales_get_pipelinesGet all pipelines
pipedrive_sales_get_productGet one product
pipedrive_sales_get_product_fieldGet one product field
pipedrive_sales_get_product_fieldsGet all product fields
pipedrive_sales_get_product_followersList followers of a product
pipedrive_sales_get_product_followers_changelogList followers changelog of a product
pipedrive_sales_get_product_imageGet image of a product
pipedrive_sales_get_product_variationsGet all product variations
pipedrive_sales_get_productsGet all products
pipedrive_sales_get_stageGet one stage
pipedrive_sales_get_stagesGet all stages
pipedrive_sales_get_user_followersList followers of a user
pipedrive_sales_search_itemPerform a search from multiple item types
pipedrive_sales_search_item_by_fieldPerform a search using a specific field from an item type
pipedrive_sales_search_productsSearch products
pipedrive_sales_update_activityUpdate an activity
pipedrive_sales_update_pipelineUpdate a pipeline
pipedrive_sales_update_productUpdate a product
pipedrive_sales_update_product_fieldUpdate one product field
pipedrive_sales_update_product_field_optionsUpdate product field options in bulk
pipedrive_sales_update_product_imageUpdate an image for a product
pipedrive_sales_update_product_variationUpdate a product variation
pipedrive_sales_update_stageUpdate stage details
pipedrive_sales_upload_product_imageUpload an image for a product

pipedrive_sales_add_activity

Add a new activity Parameters:
ParameterTypeRequiredDefaultDescription
attendeesany[]NoThe attendees of the activity
busybooleanNoWhether the activity marks the assignee as busy or not in their calendar
deal_idintegerNoThe ID of the deal linked to the activity
donebooleanNoWhether the activity is marked as done or not
due_datestringNoThe due date of the activity
due_timestringNoThe due time of the activity
durationstringNoThe duration of the activity
lead_idstringNoThe ID of the lead linked to the activity
locationobjectNoLocation of the activity
notestringNoThe note of the activity
org_idintegerNoThe ID of the organization linked to the activity
owner_idintegerNoThe ID of the user who owns the activity
participantsany[]NoThe participants of the activity
person_idintegerNoThe ID of the person linked to the activity
priorityintegerNoThe priority of the activity. Mappable to a specific string using activityFields API.
project_idintegerNoThe ID of the project linked to the activity
public_descriptionstringNoThe public description of the activity
subjectstringNoThe subject of the activity
typestringNoThe type of the activity

pipedrive_sales_add_pipeline

Add a new pipeline Parameters:
ParameterTypeRequiredDefaultDescription
is_deal_probability_enabledbooleanNoWhether deal probability is disabled or enabled for this pipeline
namestringYesThe name of the pipeline

pipedrive_sales_add_product

Add a product Parameters:
ParameterTypeRequiredDefaultDescription
billing_frequencystringNoOnly available in Growth and above plans How often a customer is billed for access to a service or product
billing_frequency_cyclesintegerNoOnly 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
categorynumberNoThe category of the product
codestringNoThe product code
custom_fieldsobjectNoAn object where each key represents a custom field. All custom fields are referenced as randomly generated 40-character hashes
descriptionstringNoThe product description
is_linkablebooleanNoWhether this product can be added to a deal or not
namestringYesThe name of the product. Cannot be an empty string
owner_idintegerNoThe ID of the user who will be marked as the owner of this product. When omitted, the authorized user ID will be used
pricesany[]NoAn 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.
taxnumberNoThe tax percentage
unitstringNoThe unit in which this product is sold
visible_tonumberNoThe 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:
ParameterTypeRequiredDefaultDescription
field_namestringYesField name
field_typestringYesThe 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>
optionsany[]NoField options (required for enum and set field types)
ui_visibilityobjectNoUI 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:
ParameterTypeRequiredDefaultDescription
field_codestringYesThe unique code identifying the field
bodyany[]YesArray 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:
ParameterTypeRequiredDefaultDescription
idintegerYesThe ID of the product
user_idintegerYesThe ID of the user to add as a follower

pipedrive_sales_add_product_variation

Add a product variation Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe ID of the product
namestringYesThe name of the product variation. The maximum length is 255 characters.
pricesany[]NoArray 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:
ParameterTypeRequiredDefaultDescription
days_to_rottenintegerNoThe number of days the deals not updated in this stage would become rotten. Applies only if the is_deal_rot_enabled is set.
deal_probabilityintegerNoThe success probability percentage of the deal. Used/shown when deal weighted values are used.
is_deal_rot_enabledbooleanNoWhether deals in this stage can become rotten
namestringYesThe name of the stage
pipeline_idintegerYesThe ID of the pipeline to add stage to

pipedrive_sales_delete_activity

Delete an activity Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe ID of the activity

pipedrive_sales_delete_pipeline

Delete a pipeline Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe ID of the pipeline

pipedrive_sales_delete_product

Delete a product Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe ID of the product

pipedrive_sales_delete_product_field

Delete one product field Parameters:
ParameterTypeRequiredDefaultDescription
field_codestringYesThe unique code identifying the field

pipedrive_sales_delete_product_field_options

Delete product field options in bulk Parameters:
ParameterTypeRequiredDefaultDescription
field_codestringYesThe unique code identifying the field
bodyany[]YesArray 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:
ParameterTypeRequiredDefaultDescription
idintegerYesThe ID of the product
follower_idintegerYesThe ID of the following user

pipedrive_sales_delete_product_image

Delete an image of a product Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe ID of the product

pipedrive_sales_delete_product_variation

Delete a product variation Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe ID of the product
product_variation_idintegerYesThe ID of the product variation

pipedrive_sales_delete_stage

Delete a stage Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe ID of the stage

pipedrive_sales_duplicate_product

Duplicate a product Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe ID of the product

pipedrive_sales_get_activities

Get all activities Parameters:
ParameterTypeRequiredDefaultDescription
filter_idintegerNoIf supplied, only activities matching the specified filter are returned
idsstringNoOptional 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_idintegerNoIf supplied, only activities owned by the specified user are returned. If filter_id is provided, this is ignored.
deal_idintegerNoIf supplied, only activities linked to the specified deal are returned. If filter_id is provided, this is ignored.
lead_idstringNoIf supplied, only activities linked to the specified lead are returned. If filter_id is provided, this is ignored.
person_idintegerNoIf supplied, only activities whose primary participant is the given person are returned. If filter_id is provided, this is ignored.
org_idintegerNoIf supplied, only activities linked to the specified organization are returned. If filter_id is provided, this is ignored.
donebooleanNoIf supplied, only activities with specified ‘done’ flag value are returned
updated_sincestringNoIf 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_untilstringNoIf set, only activities with an update_time earlier than this time are returned. In RFC3339 format, e.g. 2025-01-01T10:20:00Z.
sort_bystringNoThe field to sort by. Supported fields: id, update_time, add_time, due_date.
sort_directionstringNoThe sorting direction. Supported values: asc, desc.
include_fieldsstringNoOptional comma separated string array of additional fields to include Valid values: attendees
limitintegerNoFor 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.
cursorstringNoFor 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:
ParameterTypeRequiredDefaultDescription
idintegerYesThe ID of the activity
include_fieldsstringNoOptional comma separated string array of additional fields to include Valid values: attendees

pipedrive_sales_get_activity_field

Get one activity field Parameters:
ParameterTypeRequiredDefaultDescription
field_codestringYesThe unique code identifying the field
include_fieldsstringNoOptional 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:
ParameterTypeRequiredDefaultDescription
include_fieldsstringNoOptional comma separated string array of additional data namespaces to include in response Valid values: ui_visibility
limitintegerNoFor 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.
cursorstringNoFor pagination, the marker (an opaque string value) representing the first item on the next page

pipedrive_sales_get_pipeline

Get one pipeline Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe ID of the pipeline

pipedrive_sales_get_pipelines

Get all pipelines Parameters:
ParameterTypeRequiredDefaultDescription
sort_bystringNoThe field to sort by. Supported fields: id, update_time, add_time.
sort_directionstringNoThe sorting direction. Supported values: asc, desc.
limitintegerNoFor 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.
cursorstringNoFor pagination, the marker (an opaque string value) representing the first item on the next page

pipedrive_sales_get_product

Get one product Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe ID of the product

pipedrive_sales_get_product_field

Get one product field Parameters:
ParameterTypeRequiredDefaultDescription
field_codestringYesThe unique code identifying the field
include_fieldsstringNoOptional 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:
ParameterTypeRequiredDefaultDescription
include_fieldsstringNoOptional comma separated string array of additional data namespaces to include in response Valid values: ui_visibility
limitintegerNoFor 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.
cursorstringNoFor 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:
ParameterTypeRequiredDefaultDescription
idintegerYesThe ID of the product
limitintegerNoFor 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.
cursorstringNoFor 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:
ParameterTypeRequiredDefaultDescription
idintegerYesThe ID of the product
limitintegerNoFor 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.
cursorstringNoFor 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:
ParameterTypeRequiredDefaultDescription
idintegerYesThe ID of the product

pipedrive_sales_get_product_variations

Get all product variations Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe ID of the product
cursorstringNoFor pagination, the marker (an opaque string value) representing the first item on the next page
limitintegerNoFor 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:
ParameterTypeRequiredDefaultDescription
owner_idintegerNoIf supplied, only products owned by the given user will be returned
idsstringNoOptional 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_idintegerNoThe ID of the filter to use
cursorstringNoFor pagination, the marker (an opaque string value) representing the first item on the next page
limitintegerNoFor 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_bystringNoThe field to sort by. Supported fields: id, name, add_time, update_time.
sort_directionstringNoThe sorting direction. Supported values: asc, desc.
custom_fieldsstringNoComma 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:
ParameterTypeRequiredDefaultDescription
idintegerYesThe ID of the stage

pipedrive_sales_get_stages

Get all stages Parameters:
ParameterTypeRequiredDefaultDescription
pipeline_idintegerNoThe ID of the pipeline to fetch stages for. If omitted, stages for all pipelines will be fetched.
sort_bystringNoThe field to sort by. Supported fields: id, update_time, add_time, order_nr.
sort_directionstringNoThe sorting direction. Supported values: asc, desc.
limitintegerNoFor 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.
cursorstringNoFor 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:
ParameterTypeRequiredDefaultDescription
idintegerYesThe ID of the user
limitintegerNoFor 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.
cursorstringNoFor 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:
ParameterTypeRequiredDefaultDescription
termstringYesThe 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_typesstringNoA 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
fieldsstringNoA 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_itemsbooleanNoWhen 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_matchbooleanNoWhen enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
include_fieldsstringNoA 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
limitintegerNoFor 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.
cursorstringNoFor 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:
ParameterTypeRequiredDefaultDescription
termstringYesThe 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_typestringYesThe type of the field to perform the search from
matchstringNoThe 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>.
fieldstringYesThe 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>.
limitintegerNoFor 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.
cursorstringNoFor pagination, the marker (an opaque string value) representing the first item on the next page

pipedrive_sales_search_products

Search products Parameters:
ParameterTypeRequiredDefaultDescription
termstringYesThe 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.
fieldsstringNoA 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_matchbooleanNoWhen enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
include_fieldsstringNoSupports including optional fields in the results which are not provided by default Valid values: product.price
limitintegerNoFor 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.
cursorstringNoFor pagination, the marker (an opaque string value) representing the first item on the next page

pipedrive_sales_update_activity

Update an activity Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe ID of the activity
attendeesany[]NoThe attendees of the activity
busybooleanNoWhether the activity marks the assignee as busy or not in their calendar
deal_idintegerNoThe ID of the deal linked to the activity
donebooleanNoWhether the activity is marked as done or not
due_datestringNoThe due date of the activity
due_timestringNoThe due time of the activity
durationstringNoThe duration of the activity
lead_idstringNoThe ID of the lead linked to the activity
locationobjectNoLocation of the activity
notestringNoThe note of the activity
org_idintegerNoThe ID of the organization linked to the activity
owner_idintegerNoThe ID of the user who owns the activity
participantsany[]NoThe participants of the activity
person_idintegerNoThe ID of the person linked to the activity
priorityintegerNoThe priority of the activity. Mappable to a specific string using activityFields API.
project_idintegerNoThe ID of the project linked to the activity
public_descriptionstringNoThe public description of the activity
subjectstringNoThe subject of the activity
typestringNoThe type of the activity

pipedrive_sales_update_pipeline

Update a pipeline Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe ID of the pipeline
is_deal_probability_enabledbooleanNoWhether deal probability is disabled or enabled for this pipeline
namestringNoThe name of the pipeline

pipedrive_sales_update_product

Update a product Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe ID of the product
billing_frequencystringNoOnly available in Growth and above plans How often a customer is billed for access to a service or product
billing_frequency_cyclesintegerNoOnly 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
categorynumberNoThe category of the product
codestringNoThe product code
custom_fieldsobjectNoAn object where each key represents a custom field. All custom fields are referenced as randomly generated 40-character hashes
descriptionstringNoThe product description
is_linkablebooleanNoWhether this product can be added to a deal or not
namestringNoThe name of the product. Cannot be an empty string
owner_idintegerNoThe ID of the user who will be marked as the owner of this product. When omitted, the authorized user ID will be used
pricesany[]NoAn 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.
taxnumberNoThe tax percentage
unitstringNoThe unit in which this product is sold
visible_tonumberNoThe 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:
ParameterTypeRequiredDefaultDescription
field_codestringYesThe unique code identifying the field
field_namestringNoField name
ui_visibilityobjectNoUI 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:
ParameterTypeRequiredDefaultDescription
field_codestringYesThe unique code identifying the field
bodyany[]YesArray 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:
ParameterTypeRequiredDefaultDescription
idintegerYesThe ID of the product
datastringYesOne image supplied in the multipart/form-data encoding

pipedrive_sales_update_product_variation

Update a product variation Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe ID of the product
product_variation_idintegerYesThe ID of the product variation
namestringNoThe name of the product variation. The maximum length is 255 characters.
pricesany[]NoArray 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:
ParameterTypeRequiredDefaultDescription
idintegerYesThe ID of the stage
days_to_rottenintegerNoThe number of days the deals not updated in this stage would become rotten. Applies only if the is_deal_rot_enabled is set.
deal_probabilityintegerNoThe success probability percentage of the deal. Used/shown when deal weighted values are used.
is_deal_rot_enabledbooleanNoWhether deals in this stage can become rotten
namestringNoThe name of the stage
pipeline_idintegerNoThe ID of the pipeline to add stage to

pipedrive_sales_upload_product_image

Upload an image for a product Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesThe ID of the product
datastringYesOne image supplied in the multipart/form-data encoding