> ## 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. # pipedrive-sales > Pipedrive Sales - activities, pipelines, stages, products, and search **Server path:** `/pipedrive-sales` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | ----------------------------------------------------------------------------------------------------- | --------------------------------------------------------- | | [`pipedrive_sales_add_activity`](#pipedrive_sales_add_activity) | Add a new activity | | [`pipedrive_sales_add_pipeline`](#pipedrive_sales_add_pipeline) | Add a new pipeline | | [`pipedrive_sales_add_product`](#pipedrive_sales_add_product) | Add a product | | [`pipedrive_sales_add_product_field`](#pipedrive_sales_add_product_field) | Create one product field | | [`pipedrive_sales_add_product_field_options`](#pipedrive_sales_add_product_field_options) | Add product field options in bulk | | [`pipedrive_sales_add_product_follower`](#pipedrive_sales_add_product_follower) | Add a follower to a product | | [`pipedrive_sales_add_product_variation`](#pipedrive_sales_add_product_variation) | Add a product variation | | [`pipedrive_sales_add_stage`](#pipedrive_sales_add_stage) | Add a new stage | | [`pipedrive_sales_delete_activity`](#pipedrive_sales_delete_activity) | Delete an activity | | [`pipedrive_sales_delete_pipeline`](#pipedrive_sales_delete_pipeline) | Delete a pipeline | | [`pipedrive_sales_delete_product`](#pipedrive_sales_delete_product) | Delete a product | | [`pipedrive_sales_delete_product_field`](#pipedrive_sales_delete_product_field) | Delete one product field | | [`pipedrive_sales_delete_product_field_options`](#pipedrive_sales_delete_product_field_options) | Delete product field options in bulk | | [`pipedrive_sales_delete_product_follower`](#pipedrive_sales_delete_product_follower) | Delete a follower from a product | | [`pipedrive_sales_delete_product_image`](#pipedrive_sales_delete_product_image) | Delete an image of a product | | [`pipedrive_sales_delete_product_variation`](#pipedrive_sales_delete_product_variation) | Delete a product variation | | [`pipedrive_sales_delete_stage`](#pipedrive_sales_delete_stage) | Delete a stage | | [`pipedrive_sales_duplicate_product`](#pipedrive_sales_duplicate_product) | Duplicate a product | | [`pipedrive_sales_get_activities`](#pipedrive_sales_get_activities) | Get all activities | | [`pipedrive_sales_get_activity`](#pipedrive_sales_get_activity) | Get details of an activity | | [`pipedrive_sales_get_activity_field`](#pipedrive_sales_get_activity_field) | Get one activity field | | [`pipedrive_sales_get_activity_fields`](#pipedrive_sales_get_activity_fields) | Get all activity fields | | [`pipedrive_sales_get_pipeline`](#pipedrive_sales_get_pipeline) | Get one pipeline | | [`pipedrive_sales_get_pipelines`](#pipedrive_sales_get_pipelines) | Get all pipelines | | [`pipedrive_sales_get_product`](#pipedrive_sales_get_product) | Get one product | | [`pipedrive_sales_get_product_field`](#pipedrive_sales_get_product_field) | Get one product field | | [`pipedrive_sales_get_product_fields`](#pipedrive_sales_get_product_fields) | Get all product fields | | [`pipedrive_sales_get_product_followers`](#pipedrive_sales_get_product_followers) | List followers of a product | | [`pipedrive_sales_get_product_followers_changelog`](#pipedrive_sales_get_product_followers_changelog) | List followers changelog of a product | | [`pipedrive_sales_get_product_image`](#pipedrive_sales_get_product_image) | Get image of a product | | [`pipedrive_sales_get_product_variations`](#pipedrive_sales_get_product_variations) | Get all product variations | | [`pipedrive_sales_get_products`](#pipedrive_sales_get_products) | Get all products | | [`pipedrive_sales_get_stage`](#pipedrive_sales_get_stage) | Get one stage | | [`pipedrive_sales_get_stages`](#pipedrive_sales_get_stages) | Get all stages | | [`pipedrive_sales_get_user_followers`](#pipedrive_sales_get_user_followers) | List followers of a user | | [`pipedrive_sales_search_item`](#pipedrive_sales_search_item) | Perform a search from multiple item types | | [`pipedrive_sales_search_item_by_field`](#pipedrive_sales_search_item_by_field) | Perform a search using a specific field from an item type | | [`pipedrive_sales_search_products`](#pipedrive_sales_search_products) | Search products | | [`pipedrive_sales_update_activity`](#pipedrive_sales_update_activity) | Update an activity | | [`pipedrive_sales_update_pipeline`](#pipedrive_sales_update_pipeline) | Update a pipeline | | [`pipedrive_sales_update_product`](#pipedrive_sales_update_product) | Update a product | | [`pipedrive_sales_update_product_field`](#pipedrive_sales_update_product_field) | Update one product field | | [`pipedrive_sales_update_product_field_options`](#pipedrive_sales_update_product_field_options) | Update product field options in bulk | | [`pipedrive_sales_update_product_image`](#pipedrive_sales_update_product_image) | Update an image for a product | | [`pipedrive_sales_update_product_variation`](#pipedrive_sales_update_product_variation) | Update a product variation | | [`pipedrive_sales_update_stage`](#pipedrive_sales_update_stage) | Update stage details | | [`pipedrive_sales_upload_product_image`](#pipedrive_sales_upload_product_image) | Upload an image for a product | *** ## pipedrive\_sales\_add\_activity Add a new activity **Parameters:** | Parameter | Type | Required | Default | Description | | -------------------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------- | | `attendees` | object\[] | 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` | object\[] | 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "attendees": { "type": "array", "items": { "type": "object", "properties": { "email": { "type": "string", "description": "The email address of the attendee" }, "name": { "type": "string", "description": "The name of the attendee" }, "status": { "type": "string", "description": "The status of the attendee" }, "is_organizer": { "type": "boolean", "description": "Whether the attendee is the organizer or not" }, "person_id": { "type": "integer", "description": "The ID of the person if the attendee has a person record" }, "user_id": { "type": "integer", "description": "The ID of the user if the attendee is a user" } } }, "description": "The attendees of the activity" }, "busy": { "type": "boolean", "description": "Whether the activity marks the assignee as busy or not in their calendar" }, "deal_id": { "type": "integer", "description": "The ID of the deal linked to the activity" }, "done": { "type": "boolean", "description": "Whether the activity is marked as done or not" }, "due_date": { "type": "string", "description": "The due date of the activity" }, "due_time": { "type": "string", "description": "The due time of the activity" }, "duration": { "type": "string", "description": "The duration of the activity" }, "lead_id": { "type": "string", "description": "The ID of the lead linked to the activity" }, "location": { "type": "object", "description": "Location of the activity", "properties": { "value": { "type": "string", "description": "The full address of the activity" }, "country": { "type": "string", "description": "Country of the activity" }, "admin_area_level_1": { "type": "string", "description": "Admin area level 1 (e.g. state) of the activity" }, "admin_area_level_2": { "type": "string", "description": "Admin area level 2 (e.g. county) of the activity" }, "locality": { "type": "string", "description": "Locality (e.g. city) of the activity" }, "sublocality": { "type": "string", "description": "Sublocality (e.g. neighborhood) of the activity" }, "route": { "type": "string", "description": "Route (e.g. street) of the activity" }, "street_number": { "type": "string", "description": "Street number of the activity" }, "subpremise": { "type": "string", "description": "Subpremise (e.g. apartment/suite number) of the activity" }, "postal_code": { "type": "string", "description": "Postal code of the activity" } } }, "note": { "type": "string", "description": "The note of the activity" }, "org_id": { "type": "integer", "description": "The ID of the organization linked to the activity" }, "owner_id": { "type": "integer", "description": "The ID of the user who owns the activity" }, "participants": { "type": "array", "items": { "type": "object", "properties": { "person_id": { "type": "integer", "description": "The ID of the person" }, "primary": { "type": "boolean", "description": "Whether the person is the primary participant or not" } } }, "description": "The participants of the activity" }, "person_id": { "type": "integer", "description": "The ID of the person linked to the activity" }, "priority": { "type": "integer", "description": "The priority of the activity. Mappable to a specific string using activityFields API." }, "project_id": { "type": "integer", "description": "The ID of the project linked to the activity" }, "public_description": { "type": "string", "description": "The public description of the activity" }, "subject": { "type": "string", "description": "The subject of the activity" }, "type": { "type": "string", "description": "The type of the activity" } }, "required": [ "PCID" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "is_deal_probability_enabled": { "type": "boolean", "description": "Whether deal probability is disabled or enabled for this pipeline" }, "name": { "type": "string", "description": "The name of the pipeline" } }, "required": [ "PCID", "name" ] } ``` *** ## 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` | object\[] | 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 \here\.\

Light / Growth and Professional plans\

\\\\\\\\\\\\\
Value\Description\
`1`\Owner & followers\
`3`\Entire company\
\

Premium / Ultimate plan\

\\\\\\\\\\\\\\\\\\\\\
Value\Description\
`1`\Owner only\
`3`\Owner's visibility group\
`5`\Owner's visibility group and sub-groups\
`7`\Entire company\
| ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "billing_frequency": { "type": "string", "description": "Only available in Growth and above plans How often a customer is billed for access to a service or product", "enum": [ "one-time", "annually", "semi-annually", "quarterly", "monthly", "weekly" ] }, "billing_frequency_cycles": { "type": "integer", "description": "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": { "type": "number", "description": "The category of the product" }, "code": { "type": "string", "description": "The product code" }, "custom_fields": { "type": "object", "description": "An object where each key represents a custom field. All custom fields are referenced as randomly generated 40-character hashes" }, "description": { "type": "string", "description": "The product description" }, "is_linkable": { "type": "boolean", "description": "Whether this product can be added to a deal or not" }, "name": { "type": "string", "description": "The name of the product. Cannot be an empty string" }, "owner_id": { "type": "integer", "description": "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": { "type": "array", "items": { "type": "object" }, "description": "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": { "type": "number", "description": "The tax percentage" }, "unit": { "type": "string", "description": "The unit in which this product is sold" }, "visible_to": { "type": "number", "description": "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 here.

Light / Growth and Professional plans

ValueDescription
`1`Owner & followers
`3`Entire company

Premium / Ultimate plan

ValueDescription
`1`Owner only
`3`Owner's visibility group
`5`Owner's visibility group and sub-groups
`7`Entire company
" } }, "required": [ "PCID", "name" ] } ``` *** ## 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\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\
Value\Description\
`varchar`\Text (up to 255 characters)\
`varchar_auto`\Autocomplete text (up to 255 characters)\
`text`\Long text (up to 65k characters)\
`double`\Numeric value\
`monetary`\Monetary field (has a numeric value and a currency value)\
`date`\Date (format YYYY-MM-DD)\
`set`\Options field with a possibility of having multiple chosen options\
`enum`\Options field with a single possible chosen option\
`user`\User field (contains a user ID of another Pipedrive user)\
`org`\Organization field (contains an organization ID which is stored on the same account)\
`people`\Person field (contains a person ID which is stored on the same account)\
`phone`\Phone field (up to 255 numbers and/or characters)\
`time`\Time field (format HH:MM:SS)\
`timerange`\Time-range field (has a start time and end time value, both HH:MM:SS)\
`daterange`\Date-range field (has a start date and end date value, both YYYY-MM-DD)\
`address`\Address field\\
| | `options` | object\[] | 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "field_name": { "type": "string", "description": "Field name" }, "field_type": { "type": "string", "description": "The type of the field
ValueDescription
`varchar`Text (up to 255 characters)
`varchar_auto`Autocomplete text (up to 255 characters)
`text`Long text (up to 65k characters)
`double`Numeric value
`monetary`Monetary field (has a numeric value and a currency value)
`date`Date (format YYYY-MM-DD)
`set`Options field with a possibility of having multiple chosen options
`enum`Options field with a single possible chosen option
`user`User field (contains a user ID of another Pipedrive user)
`org`Organization field (contains an organization ID which is stored on the same account)
`people`Person field (contains a person ID which is stored on the same account)
`phone`Phone field (up to 255 numbers and/or characters)
`time`Time field (format HH:MM:SS)
`timerange`Time-range field (has a start time and end time value, both HH:MM:SS)
`daterange`Date-range field (has a start date and end date value, both YYYY-MM-DD)
`address`Address field
", "enum": [ "varchar", "text", "double", "phone", "date", "daterange", "time", "timerange", "set", "enum", "varchar_auto", "address", "monetary", "org", "people", "user" ] }, "options": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "description": "The option label" } }, "required": [ "label" ] }, "description": "Field options (required for enum and set field types)" }, "ui_visibility": { "type": "object", "description": "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.", "properties": { "add_visible_flag": { "type": "boolean", "description": "Whether the field is shown in the add product modal. Default is false. Cannot be set to false for the 'name' system field." }, "details_visible_flag": { "type": "boolean", "description": "Whether the field is shown in the product details view. Default is true." } } } }, "required": [ "PCID", "field_name", "field_type" ] } ``` *** ## 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` | object\[] | Yes | — | Array of options to add. Each item must contain a label. At least one option is required. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "field_code": { "type": "string", "description": "The unique code identifying the field" }, "body": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "description": "The display label for the new option" } }, "required": [ "label" ] }, "description": "Array of options to add. Each item must contain a label. At least one option is required." } }, "required": [ "PCID", "field_code", "body" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "The ID of the product" }, "user_id": { "type": "integer", "description": "The ID of the user to add as a follower" } }, "required": [ "PCID", "id", "user_id" ] } ``` *** ## 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` | object\[] | 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "The ID of the product" }, "name": { "type": "string", "description": "The name of the product variation. The maximum length is 255 characters." }, "prices": { "type": "array", "items": { "type": "object" }, "description": "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." } }, "required": [ "PCID", "id", "name" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "days_to_rotten": { "type": "integer", "description": "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": { "type": "integer", "description": "The success probability percentage of the deal. Used/shown when deal weighted values are used." }, "is_deal_rot_enabled": { "type": "boolean", "description": "Whether deals in this stage can become rotten" }, "name": { "type": "string", "description": "The name of the stage" }, "pipeline_id": { "type": "integer", "description": "The ID of the pipeline to add stage to" } }, "required": [ "PCID", "name", "pipeline_id" ] } ``` *** ## pipedrive\_sales\_delete\_activity Delete an activity **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------- | -------- | ------- | ---------------------- | | `id` | integer | Yes | — | The ID of the activity | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "The ID of the activity" } }, "required": [ "PCID", "id" ] } ``` *** ## pipedrive\_sales\_delete\_pipeline Delete a pipeline **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------- | -------- | ------- | ---------------------- | | `id` | integer | Yes | — | The ID of the pipeline | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "The ID of the pipeline" } }, "required": [ "PCID", "id" ] } ``` *** ## pipedrive\_sales\_delete\_product Delete a product **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------- | -------- | ------- | --------------------- | | `id` | integer | Yes | — | The ID of the product | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "The ID of the product" } }, "required": [ "PCID", "id" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "field_code": { "type": "string", "description": "The unique code identifying the field" } }, "required": [ "PCID", "field_code" ] } ``` *** ## 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` | object\[] | 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "field_code": { "type": "string", "description": "The unique code identifying the field" }, "body": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "description": "The unique identifier of the option to delete" } }, "required": [ "id" ] }, "description": "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." } }, "required": [ "PCID", "field_code", "body" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "The ID of the product" }, "follower_id": { "type": "integer", "description": "The ID of the following user" } }, "required": [ "PCID", "id", "follower_id" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "The ID of the product" } }, "required": [ "PCID", "id" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "The ID of the product" }, "product_variation_id": { "type": "integer", "description": "The ID of the product variation" } }, "required": [ "PCID", "id", "product_variation_id" ] } ``` *** ## pipedrive\_sales\_delete\_stage Delete a stage **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------- | -------- | ------- | ------------------- | | `id` | integer | Yes | — | The ID of the stage | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "The ID of the stage" } }, "required": [ "PCID", "id" ] } ``` *** ## pipedrive\_sales\_duplicate\_product Duplicate a product **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------- | -------- | ------- | --------------------- | | `id` | integer | Yes | — | The ID of the product | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "The ID of the product" } }, "required": [ "PCID", "id" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "filter_id": { "type": "integer", "description": "If supplied, only activities matching the specified filter are returned" }, "ids": { "type": "string", "description": "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": { "type": "integer", "description": "If supplied, only activities owned by the specified user are returned. If filter_id is provided, this is ignored." }, "deal_id": { "type": "integer", "description": "If supplied, only activities linked to the specified deal are returned. If filter_id is provided, this is ignored." }, "lead_id": { "type": "string", "description": "If supplied, only activities linked to the specified lead are returned. If filter_id is provided, this is ignored." }, "person_id": { "type": "integer", "description": "If supplied, only activities whose primary participant is the given person are returned. If filter_id is provided, this is ignored." }, "org_id": { "type": "integer", "description": "If supplied, only activities linked to the specified organization are returned. If filter_id is provided, this is ignored." }, "done": { "type": "boolean", "description": "If supplied, only activities with specified 'done' flag value are returned" }, "updated_since": { "type": "string", "description": "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": { "type": "string", "description": "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": { "type": "string", "description": "The field to sort by. Supported fields: `id`, `update_time`, `add_time`, `due_date`.", "enum": [ "id", "update_time", "add_time", "due_date" ] }, "sort_direction": { "type": "string", "description": "The sorting direction. Supported values: `asc`, `desc`.", "enum": [ "asc", "desc" ] }, "include_fields": { "type": "string", "description": "Optional comma separated string array of additional fields to include Valid values: attendees" }, "limit": { "type": "integer", "description": "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": { "type": "string", "description": "For pagination, the marker (an opaque string value) representing the first item on the next page" } }, "required": [ "PCID" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "The ID of the activity" }, "include_fields": { "type": "string", "description": "Optional comma separated string array of additional fields to include Valid values: attendees" } }, "required": [ "PCID", "id" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "field_code": { "type": "string", "description": "The unique code identifying the field" }, "include_fields": { "type": "string", "description": "Optional comma separated string array of additional data namespaces to include in response Valid values: ui_visibility" } }, "required": [ "PCID", "field_code" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "include_fields": { "type": "string", "description": "Optional comma separated string array of additional data namespaces to include in response Valid values: ui_visibility" }, "limit": { "type": "integer", "description": "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": { "type": "string", "description": "For pagination, the marker (an opaque string value) representing the first item on the next page" } }, "required": [ "PCID" ] } ``` *** ## pipedrive\_sales\_get\_pipeline Get one pipeline **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------- | -------- | ------- | ---------------------- | | `id` | integer | Yes | — | The ID of the pipeline | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "The ID of the pipeline" } }, "required": [ "PCID", "id" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "sort_by": { "type": "string", "description": "The field to sort by. Supported fields: `id`, `update_time`, `add_time`.", "enum": [ "id", "update_time", "add_time" ] }, "sort_direction": { "type": "string", "description": "The sorting direction. Supported values: `asc`, `desc`.", "enum": [ "asc", "desc" ] }, "limit": { "type": "integer", "description": "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": { "type": "string", "description": "For pagination, the marker (an opaque string value) representing the first item on the next page" } }, "required": [ "PCID" ] } ``` *** ## pipedrive\_sales\_get\_product Get one product **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------- | -------- | ------- | --------------------- | | `id` | integer | Yes | — | The ID of the product | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "The ID of the product" } }, "required": [ "PCID", "id" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "field_code": { "type": "string", "description": "The unique code identifying the field" }, "include_fields": { "type": "string", "description": "Optional comma separated string array of additional data namespaces to include in response Valid values: ui_visibility" } }, "required": [ "PCID", "field_code" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "include_fields": { "type": "string", "description": "Optional comma separated string array of additional data namespaces to include in response Valid values: ui_visibility" }, "limit": { "type": "integer", "description": "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": { "type": "string", "description": "For pagination, the marker (an opaque string value) representing the first item on the next page" } }, "required": [ "PCID" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "The ID of the product" }, "limit": { "type": "integer", "description": "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": { "type": "string", "description": "For pagination, the marker (an opaque string value) representing the first item on the next page" } }, "required": [ "PCID", "id" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "The ID of the product" }, "limit": { "type": "integer", "description": "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": { "type": "string", "description": "For pagination, the marker (an opaque string value) representing the first item on the next page" } }, "required": [ "PCID", "id" ] } ``` *** ## pipedrive\_sales\_get\_product\_image Get image of a product **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------- | -------- | ------- | --------------------- | | `id` | integer | Yes | — | The ID of the product | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "The ID of the product" } }, "required": [ "PCID", "id" ] } ``` *** ## 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "The ID of the product" }, "cursor": { "type": "string", "description": "For pagination, the marker (an opaque string value) representing the first item on the next page" }, "limit": { "type": "integer", "description": "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." } }, "required": [ "PCID", "id" ] } ``` *** ## 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.\
A maximum of 15 keys is allowed. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "owner_id": { "type": "integer", "description": "If supplied, only products owned by the given user will be returned" }, "ids": { "type": "string", "description": "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": { "type": "integer", "description": "The ID of the filter to use" }, "cursor": { "type": "string", "description": "For pagination, the marker (an opaque string value) representing the first item on the next page" }, "limit": { "type": "integer", "description": "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": { "type": "string", "description": "The field to sort by. Supported fields: `id`, `name`, `add_time`, `update_time`.", "enum": [ "id", "name", "add_time", "update_time" ] }, "sort_direction": { "type": "string", "description": "The sorting direction. Supported values: `asc`, `desc`.", "enum": [ "asc", "desc" ] }, "custom_fields": { "type": "string", "description": "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.
A maximum of 15 keys is allowed." } }, "required": [ "PCID" ] } ``` *** ## pipedrive\_sales\_get\_stage Get one stage **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------- | -------- | ------- | ------------------- | | `id` | integer | Yes | — | The ID of the stage | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "The ID of the stage" } }, "required": [ "PCID", "id" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "pipeline_id": { "type": "integer", "description": "The ID of the pipeline to fetch stages for. If omitted, stages for all pipelines will be fetched." }, "sort_by": { "type": "string", "description": "The field to sort by. Supported fields: `id`, `update_time`, `add_time`, `order_nr`.", "enum": [ "id", "update_time", "add_time", "order_nr" ] }, "sort_direction": { "type": "string", "description": "The sorting direction. Supported values: `asc`, `desc`.", "enum": [ "asc", "desc" ] }, "limit": { "type": "integer", "description": "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": { "type": "string", "description": "For pagination, the marker (an opaque string value) representing the first item on the next page" } }, "required": [ "PCID" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "The ID of the user" }, "limit": { "type": "integer", "description": "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": { "type": "string", "description": "For pagination, the marker (an opaque string value) representing the first item on the next page" } }, "required": [ "PCID", "id" ] } ``` *** ## 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:\
\ \\\\ \\\\ \\\\ \\\\ \\\\ \\\\ \\\\ \\\\ \\\\ \
\Item type\\\Field\\
Deal\`custom_fields`, `notes`, `title`\
Person\`custom_fields`, `email`, `name`, `notes`, `phone`\
Organization\`address`, `custom_fields`, `name`, `notes`\
Product\`code`, `custom_fields`, `name`\
Lead\`custom_fields`, `notes`, `title`\
File\`name`\
Mail attachment\`name`\
Project\ `custom_fields`, `notes`, `title`, `description` \
\
Only the following custom field types are searchable: `address`, `varchar`, `text`, `varchar_auto`, `double`, `monetary` and `phone`. Read more about searching by custom fields \here\. | | `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 \not\ 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "term": { "type": "string", "description": "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": { "type": "string", "description": "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": { "type": "string", "description": "A comma-separated string array. The fields to perform the search from. Defaults to all. Relevant for each item type are:
Item typeField
Deal`custom_fields`, `notes`, `title`
Person`custom_fields`, `email`, `name`, `notes`, `phone`
Organization`address`, `custom_fields`, `name`, `notes`
Product`code`, `custom_fields`, `name`
Lead`custom_fields`, `notes`, `title`
File`name`
Mail attachment`name`
Project `custom_fields`, `notes`, `title`, `description`

Only the following custom field types are searchable: `address`, `varchar`, `text`, `varchar_auto`, `double`, `monetary` and `phone`. Read more about searching by custom fields here." }, "search_for_related_items": { "type": "boolean", "description": "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": { "type": "boolean", "description": "When enabled, only full exact matches against the given term are returned. It is not case sensitive." }, "include_fields": { "type": "string", "description": "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": { "type": "integer", "description": "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": { "type": "string", "description": "For pagination, the marker (an opaque string value) representing the first item on the next page" } }, "required": [ "PCID", "term" ] } ``` *** ## 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 \is\ case sensitive.\
\
E.g. in case of searching for a value `monkey`, \. | | `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 \here\. | | `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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "term": { "type": "string", "description": "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": { "type": "string", "description": "The type of the field to perform the search from", "enum": [ "deal", "lead", "person", "organization", "product", "project" ] }, "match": { "type": "string", "description": "The type of match used against the term. The search is case sensitive.

E.g. in case of searching for a value `monkey`, .", "enum": [ "exact", "beginning", "middle" ] }, "field": { "type": "string", "description": "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 here." }, "limit": { "type": "integer", "description": "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": { "type": "string", "description": "For pagination, the marker (an opaque string value) representing the first item on the next page" } }, "required": [ "PCID", "term", "entity_type", "field" ] } ``` *** ## 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 \here\. Valid values: code, custom\_fields, name | | `exact_match` | boolean | No | — | When enabled, only full exact matches against the given term are returned. It is \not\ 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "term": { "type": "string", "description": "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": { "type": "string", "description": "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 here. Valid values: code, custom_fields, name" }, "exact_match": { "type": "boolean", "description": "When enabled, only full exact matches against the given term are returned. It is not case sensitive." }, "include_fields": { "type": "string", "description": "Supports including optional fields in the results which are not provided by default Valid values: product.price" }, "limit": { "type": "integer", "description": "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": { "type": "string", "description": "For pagination, the marker (an opaque string value) representing the first item on the next page" } }, "required": [ "PCID", "term" ] } ``` *** ## pipedrive\_sales\_update\_activity Update an activity **Parameters:** | Parameter | Type | Required | Default | Description | | -------------------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------- | | `id` | integer | Yes | — | The ID of the activity | | `attendees` | object\[] | 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` | object\[] | 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "The ID of the activity" }, "attendees": { "type": "array", "items": { "type": "object", "properties": { "email": { "type": "string", "description": "The email address of the attendee" }, "name": { "type": "string", "description": "The name of the attendee" }, "status": { "type": "string", "description": "The status of the attendee" }, "is_organizer": { "type": "boolean", "description": "Whether the attendee is the organizer or not" }, "person_id": { "type": "integer", "description": "The ID of the person if the attendee has a person record" }, "user_id": { "type": "integer", "description": "The ID of the user if the attendee is a user" } } }, "description": "The attendees of the activity" }, "busy": { "type": "boolean", "description": "Whether the activity marks the assignee as busy or not in their calendar" }, "deal_id": { "type": "integer", "description": "The ID of the deal linked to the activity" }, "done": { "type": "boolean", "description": "Whether the activity is marked as done or not" }, "due_date": { "type": "string", "description": "The due date of the activity" }, "due_time": { "type": "string", "description": "The due time of the activity" }, "duration": { "type": "string", "description": "The duration of the activity" }, "lead_id": { "type": "string", "description": "The ID of the lead linked to the activity" }, "location": { "type": "object", "description": "Location of the activity", "properties": { "value": { "type": "string", "description": "The full address of the activity" }, "country": { "type": "string", "description": "Country of the activity" }, "admin_area_level_1": { "type": "string", "description": "Admin area level 1 (e.g. state) of the activity" }, "admin_area_level_2": { "type": "string", "description": "Admin area level 2 (e.g. county) of the activity" }, "locality": { "type": "string", "description": "Locality (e.g. city) of the activity" }, "sublocality": { "type": "string", "description": "Sublocality (e.g. neighborhood) of the activity" }, "route": { "type": "string", "description": "Route (e.g. street) of the activity" }, "street_number": { "type": "string", "description": "Street number of the activity" }, "subpremise": { "type": "string", "description": "Subpremise (e.g. apartment/suite number) of the activity" }, "postal_code": { "type": "string", "description": "Postal code of the activity" } } }, "note": { "type": "string", "description": "The note of the activity" }, "org_id": { "type": "integer", "description": "The ID of the organization linked to the activity" }, "owner_id": { "type": "integer", "description": "The ID of the user who owns the activity" }, "participants": { "type": "array", "items": { "type": "object", "properties": { "person_id": { "type": "integer", "description": "The ID of the person" }, "primary": { "type": "boolean", "description": "Whether the person is the primary participant or not" } } }, "description": "The participants of the activity" }, "person_id": { "type": "integer", "description": "The ID of the person linked to the activity" }, "priority": { "type": "integer", "description": "The priority of the activity. Mappable to a specific string using activityFields API." }, "project_id": { "type": "integer", "description": "The ID of the project linked to the activity" }, "public_description": { "type": "string", "description": "The public description of the activity" }, "subject": { "type": "string", "description": "The subject of the activity" }, "type": { "type": "string", "description": "The type of the activity" } }, "required": [ "PCID", "id" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "The ID of the pipeline" }, "is_deal_probability_enabled": { "type": "boolean", "description": "Whether deal probability is disabled or enabled for this pipeline" }, "name": { "type": "string", "description": "The name of the pipeline" } }, "required": [ "PCID", "id" ] } ``` *** ## 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` | object\[] | 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 \here\.\

Light / Growth and Professional plans\

\\\\\\\\\\\\\
Value\Description\
`1`\Owner & followers\
`3`\Entire company\
\

Premium / Ultimate plan\

\\\\\\\\\\\\\\\\\\\\\
Value\Description\
`1`\Owner only\
`3`\Owner's visibility group\
`5`\Owner's visibility group and sub-groups\
`7`\Entire company\
| ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "The ID of the product" }, "billing_frequency": { "type": "string", "description": "Only available in Growth and above plans How often a customer is billed for access to a service or product", "enum": [ "one-time", "annually", "semi-annually", "quarterly", "monthly", "weekly" ] }, "billing_frequency_cycles": { "type": "integer", "description": "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": { "type": "number", "description": "The category of the product" }, "code": { "type": "string", "description": "The product code" }, "custom_fields": { "type": "object", "description": "An object where each key represents a custom field. All custom fields are referenced as randomly generated 40-character hashes" }, "description": { "type": "string", "description": "The product description" }, "is_linkable": { "type": "boolean", "description": "Whether this product can be added to a deal or not" }, "name": { "type": "string", "description": "The name of the product. Cannot be an empty string" }, "owner_id": { "type": "integer", "description": "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": { "type": "array", "items": { "type": "object" }, "description": "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": { "type": "number", "description": "The tax percentage" }, "unit": { "type": "string", "description": "The unit in which this product is sold" }, "visible_to": { "type": "number", "description": "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 here.

Light / Growth and Professional plans

ValueDescription
`1`Owner & followers
`3`Entire company

Premium / Ultimate plan

ValueDescription
`1`Owner only
`3`Owner's visibility group
`5`Owner's visibility group and sub-groups
`7`Entire company
" } }, "required": [ "PCID", "id" ] } ``` *** ## 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "field_code": { "type": "string", "description": "The unique code identifying the field" }, "field_name": { "type": "string", "description": "Field name" }, "ui_visibility": { "type": "object", "description": "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.", "properties": { "add_visible_flag": { "type": "boolean", "description": "Whether the field is shown in the add product modal. Default is false. Cannot be set to false for the 'name' system field." }, "details_visible_flag": { "type": "boolean", "description": "Whether the field is shown in the product details view. Default is true." } } } }, "required": [ "PCID", "field_code" ] } ``` *** ## 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` | object\[] | 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "field_code": { "type": "string", "description": "The unique code identifying the field" }, "body": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "description": "The unique identifier of the option to update" }, "label": { "type": "string", "description": "The new display label for the option" } }, "required": [ "id", "label" ] }, "description": "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." } }, "required": [ "PCID", "field_code", "body" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "The ID of the product" }, "data": { "type": "string", "description": "One image supplied in the multipart/form-data encoding" } }, "required": [ "PCID", "id", "data" ] } ``` *** ## 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` | object\[] | 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. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "The ID of the product" }, "product_variation_id": { "type": "integer", "description": "The ID of the product variation" }, "name": { "type": "string", "description": "The name of the product variation. The maximum length is 255 characters." }, "prices": { "type": "array", "items": { "type": "object" }, "description": "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." } }, "required": [ "PCID", "id", "product_variation_id" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "The ID of the stage" }, "days_to_rotten": { "type": "integer", "description": "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": { "type": "integer", "description": "The success probability percentage of the deal. Used/shown when deal weighted values are used." }, "is_deal_rot_enabled": { "type": "boolean", "description": "Whether deals in this stage can become rotten" }, "name": { "type": "string", "description": "The name of the stage" }, "pipeline_id": { "type": "integer", "description": "The ID of the pipeline to add stage to" } }, "required": [ "PCID", "id" ] } ``` *** ## 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 | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "The ID of the product" }, "data": { "type": "string", "description": "One image supplied in the multipart/form-data encoding" } }, "required": [ "PCID", "id", "data" ] } ```