pipedrive-deals

Pipedrive Deals - manage deals, deal fields, leads, and conversions

Server path: /pipedrive-deals | Type: Application | PCID required: Yes

Tools

Tool	Description
pipedrive_deals_add_deal	Add a new deal
pipedrive_deals_add_deal_field	Create one deal field
pipedrive_deals_add_deal_field_options	Add deal field options in bulk
pipedrive_deals_add_deal_follower	Add a follower to a deal
pipedrive_deals_add_deal_product	Add a product to a deal
pipedrive_deals_add_many_deal_products	Add multiple products to a deal
pipedrive_deals_convert_deal_to_lead	Convert a deal to a lead
pipedrive_deals_convert_lead_to_deal	Convert a lead to a deal
pipedrive_deals_delete_additional_discount	Delete a discount from a deal
pipedrive_deals_delete_deal	Delete a deal
pipedrive_deals_delete_deal_field	Delete one deal field
pipedrive_deals_delete_deal_field_options	Delete deal field options in bulk
pipedrive_deals_delete_deal_follower	Delete a follower from a deal
pipedrive_deals_delete_deal_product	Delete an attached product from a deal
pipedrive_deals_delete_installment	Delete an installment from a deal
pipedrive_deals_delete_many_deal_products	Delete many products from a deal
pipedrive_deals_get_additional_discounts	List discounts added to a deal
pipedrive_deals_get_archived_deals	Get all archived deals
pipedrive_deals_get_deal	Get details of a deal
pipedrive_deals_get_deal_conversion_status	Get Deal conversion status
pipedrive_deals_get_deal_field	Get one deal field
pipedrive_deals_get_deal_fields	Get all deal fields
pipedrive_deals_get_deal_followers	List followers of a deal
pipedrive_deals_get_deal_followers_changelog	List followers changelog of a deal
pipedrive_deals_get_deal_products	List products attached to a deal
pipedrive_deals_get_deals	Get all deals
pipedrive_deals_get_installments	List installments added to a list of deals
pipedrive_deals_get_lead_conversion_status	Get Lead conversion status
pipedrive_deals_get_products	Get deal products of several deals
pipedrive_deals_post_additional_discount	Add a discount to a deal
pipedrive_deals_post_installment	Add an installment to a deal
pipedrive_deals_search_deals	Search deals
pipedrive_deals_search_leads	Search leads
pipedrive_deals_update_additional_discount	Update a discount added to a deal
pipedrive_deals_update_deal	Update a deal
pipedrive_deals_update_deal_field	Update one deal field
pipedrive_deals_update_deal_field_options	Update deal field options in bulk
pipedrive_deals_update_deal_product	Update the product attached to a deal
pipedrive_deals_update_installment	Update an installment added to a deal

---

pipedrive_deals_add_deal

Add a new deal

Parameters:

Parameter	Type	Required	Default	Description
archive_time	string	No	—	The optional date and time of archiving the deal in UTC. Format: YYYY-MM-DD HH:MM:SS. If omitted and is_archived is true, it will be set to the current date and time.
close_time	string	null	No	—	The date and time of closing the deal. Can only be set if deal status is won or lost.
currency	string	No	—	The currency associated with the deal
custom_fields	object	No	—	An object where each key represents a custom field. All custom fields are referenced as randomly generated 40-character hashes
expected_close_date	string	No	—	The expected close date of the deal
is_archived	boolean	No	—	Whether the deal is archived or not
is_deleted	boolean	No	—	Whether the deal is deleted or not
label_ids	integer[]	No	—	The IDs of labels assigned to the deal
lost_reason	string	null	No	—	The reason for losing the deal. Can only be set if deal status is lost.
lost_time	string	No	—	The date and time of changing the deal status as lost. Can only be set if deal status is lost.
org_id	integer	No	—	The ID of the organization linked to the deal
owner_id	integer	No	—	The ID of the user who owns the deal
person_id	integer	No	—	The ID of the person linked to the deal
pipeline_id	integer	No	—	The ID of the pipeline associated with the deal
probability	number	null	No	—	The success probability percentage of the deal
stage_id	integer	No	—	The ID of the deal stage
status	string	No	—	The status of the deal
title	string	Yes	—	The title of the deal
value	number	No	—	The value of the deal
visible_to	integer	No	—	The visibility of the deal
won_time	string	No	—	The date and time of changing the deal status as won. Can only be set if deal status is won.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "archive_time": {
      "type": "string",
      "description": "The optional date and time of archiving the deal in UTC. Format: YYYY-MM-DD HH:MM:SS. If omitted and `is_archived` is true, it will be set to the current date and time."
    },
    "close_time": {
      "type": [
        "string",
        "null"
      ],
      "description": "The date and time of closing the deal. Can only be set if deal status is won or lost."
    },
    "currency": {
      "type": "string",
      "description": "The currency associated with the deal"
    },
    "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"
    },
    "expected_close_date": {
      "type": "string",
      "description": "The expected close date of the deal"
    },
    "is_archived": {
      "type": "boolean",
      "description": "Whether the deal is archived or not"
    },
    "is_deleted": {
      "type": "boolean",
      "description": "Whether the deal is deleted or not"
    },
    "label_ids": {
      "type": "array",
      "items": {
        "type": "integer"
      },
      "description": "The IDs of labels assigned to the deal"
    },
    "lost_reason": {
      "type": [
        "string",
        "null"
      ],
      "description": "The reason for losing the deal. Can only be set if deal status is lost."
    },
    "lost_time": {
      "type": "string",
      "description": "The date and time of changing the deal status as lost. Can only be set if deal status is lost."
    },
    "org_id": {
      "type": "integer",
      "description": "The ID of the organization linked to the deal"
    },
    "owner_id": {
      "type": "integer",
      "description": "The ID of the user who owns the deal"
    },
    "person_id": {
      "type": "integer",
      "description": "The ID of the person linked to the deal"
    },
    "pipeline_id": {
      "type": "integer",
      "description": "The ID of the pipeline associated with the deal"
    },
    "probability": {
      "type": [
        "number",
        "null"
      ],
      "description": "The success probability percentage of the deal"
    },
    "stage_id": {
      "type": "integer",
      "description": "The ID of the deal stage"
    },
    "status": {
      "type": "string",
      "description": "The status of the deal"
    },
    "title": {
      "type": "string",
      "description": "The title of the deal"
    },
    "value": {
      "type": "number",
      "description": "The value of the deal"
    },
    "visible_to": {
      "type": "integer",
      "description": "The visibility of the deal"
    },
    "won_time": {
      "type": "string",
      "description": "The date and time of changing the deal status as won. Can only be set if deal status is won."
    }
  },
  "required": [
    "PCID",
    "title"
  ]
}

---

pipedrive_deals_add_deal_field

Create one deal field

Parameters:

Parameter	Type	Required	Default	Description
description	string	null	No	—	Field description
field_name	string	Yes	—	Field name
field_type	string	Yes	—	The type of the field<table><tr><th>Value</th><th>Description</th></tr><tr><td>varchar</td><td>Text (up to 255 characters)</td><tr><td>varchar_auto</td><td>Autocomplete text (up to 255 characters)</td><tr><td>text</td><td>Long text (up to 65k characters)</td><tr><td>double</td><td>Numeric value</td><tr><td>monetary</td><td>Monetary field (has a numeric value and a currency value)</td><tr><td>date</td><td>Date (format YYYY-MM-DD)</td><tr><td>set</td><td>Options field with a possibility of having multiple chosen options</td><tr><td>enum</td><td>Options field with a single possible chosen option</td><tr><td>user</td><td>User field (contains a user ID of another Pipedrive user)</td><tr><td>org</td><td>Organization field (contains an organization ID which is stored on the same account)</td><tr><td>people</td><td>Person field (contains a person ID which is stored on the same account)</td><tr><td>phone</td><td>Phone field (up to 255 numbers and/or characters)</td><tr><td>time</td><td>Time field (format HH:MM:SS)</td><tr><td>timerange</td><td>Time-range field (has a start time and end time value, both HH:MM:SS)</td><tr><td>daterange</td><td>Date-range field (has a start date and end date value, both YYYY-MM-DD)</td><tr><td>address</td><td>Address field</dd></table>
important_fields	object	No	—	Configuration for highlighting the field at specific stages.
options	object[]	No	—	Field options (required for enum and set field types)
required_fields	object	No	—	Required fields configuration for marking the field as mandatory when interacted with in the Pipedrive web UI.
ui_visibility	object	No	—	UI visibility settings for the field. Controls where the field appears in the Pipedrive web UI.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "description": "Field description"
    },
    "field_name": {
      "type": "string",
      "description": "Field name"
    },
    "field_type": {
      "type": "string",
      "description": "The type of the field<table><tr><th>Value</th><th>Description</th></tr><tr><td>`varchar`</td><td>Text (up to 255 characters)</td><tr><td>`varchar_auto`</td><td>Autocomplete text (up to 255 characters)</td><tr><td>`text`</td><td>Long text (up to 65k characters)</td><tr><td>`double`</td><td>Numeric value</td><tr><td>`monetary`</td><td>Monetary field (has a numeric value and a currency value)</td><tr><td>`date`</td><td>Date (format YYYY-MM-DD)</td><tr><td>`set`</td><td>Options field with a possibility of having multiple chosen options</td><tr><td>`enum`</td><td>Options field with a single possible chosen option</td><tr><td>`user`</td><td>User field (contains a user ID of another Pipedrive user)</td><tr><td>`org`</td><td>Organization field (contains an organization ID which is stored on the same account)</td><tr><td>`people`</td><td>Person field (contains a person ID which is stored on the same account)</td><tr><td>`phone`</td><td>Phone field (up to 255 numbers and/or characters)</td><tr><td>`time`</td><td>Time field (format HH:MM:SS)</td><tr><td>`timerange`</td><td>Time-range field (has a start time and end time value, both HH:MM:SS)</td><tr><td>`daterange`</td><td>Date-range field (has a start date and end date value, both YYYY-MM-DD)</td><tr><td>`address`</td><td>Address field</dd></table>",
      "enum": [
        "varchar",
        "text",
        "double",
        "phone",
        "date",
        "daterange",
        "time",
        "timerange",
        "set",
        "enum",
        "varchar_auto",
        "address",
        "monetary",
        "org",
        "people",
        "user"
      ]
    },
    "important_fields": {
      "type": "object",
      "description": "Configuration for highlighting the field at specific stages.",
      "properties": {
        "enabled": {
          "type": "boolean",
          "description": "Whether the field is marked as important. When false, the field is not highlighted. When true with empty stage_ids, the field is important everywhere. When true with specific stage_ids, the field is important only at those stages. Default is false."
        },
        "stage_ids": {
          "type": "array",
          "items": {
            "type": "integer"
          },
          "description": "Array of deal stage IDs where this field should be highlighted as important. Must reference valid, active deal stages. Empty array when enabled is false. The stages must be in pipelines where this field is visible (show_in_pipelines)."
        }
      }
    },
    "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)"
    },
    "required_fields": {
      "type": "object",
      "description": "Required fields configuration for marking the field as mandatory when interacted with in the Pipedrive web UI.",
      "properties": {
        "enabled": {
          "type": "boolean",
          "description": "Whether the field is required. When false, the field is optional. When true with empty stage_ids, the field is required everywhere. When true with specific stage_ids, the field is required only at those stages. Default is false."
        },
        "stage_ids": {
          "type": "array",
          "items": {
            "type": "integer"
          },
          "description": "Array of deal stage IDs where this field is required. Must reference valid, active deal stages. Empty array when enabled is false. The stages must be in pipelines where this field is visible (show_in_pipelines)."
        },
        "statuses": {
          "type": "object",
          "description": "Pipeline-specific status requirements for when deals are won or lost. Keys are pipeline IDs (as strings), values are arrays of status strings ('won', 'lost'). Example - {\"1\":[\"won\",\"lost\"],\"2\":[\"won\"]} means the field is required when marking deals as won or lost in pipeline 1, and only when won in pipeline 2. Must reference valid, active pipelines."
        }
      }
    },
    "ui_visibility": {
      "type": "object",
      "description": "UI visibility settings for the field. Controls where the field appears in the Pipedrive web UI.",
      "properties": {
        "add_visible_flag": {
          "type": "boolean",
          "description": "Whether the field is shown in the add deal modal. Default is false. Cannot be set to false for required system fields (title, pipeline, stage_id, probability)."
        },
        "details_visible_flag": {
          "type": "boolean",
          "description": "Whether the field is shown in the deal details view. Default is true."
        },
        "projects_detail_visible_flag": {
          "type": "boolean",
          "description": "Whether the field is shown in the project details view when the deal is linked to a project. Default is false."
        },
        "show_in_pipelines": {
          "type": "object",
          "description": "Controls which pipelines display this field. Default is show_in_all=true. Note that fields marked as important or required must be visible in the pipelines where they are configured."
        }
      }
    }
  },
  "required": [
    "PCID",
    "field_name",
    "field_type"
  ]
}

---

pipedrive_deals_add_deal_field_options

Add deal 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.

Show inputSchema

{
  "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_deals_add_deal_follower

Add a follower to a deal

Parameters:

Parameter	Type	Required	Default	Description
id	integer	Yes	—	The ID of the deal
user_id	integer	Yes	—	The ID of the user to add as a follower

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "integer",
      "description": "The ID of the deal"
    },
    "user_id": {
      "type": "integer",
      "description": "The ID of the user to add as a follower"
    }
  },
  "required": [
    "PCID",
    "id",
    "user_id"
  ]
}

---

pipedrive_deals_add_deal_product

Add a product to a deal

Parameters:

Parameter	Type	Required	Default	Description
id	integer	Yes	—	The ID of the deal
billing_frequency	string	No	—	Only available in Growth and above plans How often a customer is billed for access to a service or product To set billing_frequency different than one-time, the deal must not have installments associated A deal can have up to 20 products attached with billing_frequency different than one-time
billing_frequency_cycles	integer	null	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
billing_start_date	string	null	No	—	Only available in Growth and above plans The billing start date. Must be between 10 years in the past and 10 years in the future
comments	string	No	—	The comments of the product
discount	number	No	—	The value of the discount. The discount_type field can be used to specify whether the value is an amount or a percentage
discount_type	string	No	—	The value of the discount. The discount_type field can be used to specify whether the value is an amount or a percentage
is_enabled	boolean	No	—	Whether this product is enabled for the deal Not possible to disable the product if the deal has installments associated and the product is the last one enabled Not possible to enable the product if the deal has installments associated and the product is recurring
item_price	number	Yes	—	The price value of the product
product_id	integer	Yes	—	The ID of the product
product_variation_id	integer	null	No	—	The ID of the product variation
quantity	number	Yes	—	The quantity of the product
tax	number	No	—	The product tax
tax_method	string	No	—	The tax option to be applied to the products. When using inclusive, the tax percentage will already be included in the price. When using exclusive, the tax will not be included in the price. When using none, no tax will be added. Use the tax field for defining the tax percentage amount. By default, the user setting value for tax options will be used. Changing this in one product affects the rest of the products attached to the deal

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "integer",
      "description": "The ID of the deal"
    },
    "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  To set `billing_frequency` different than `one-time`, the deal must not have installments associated  A deal can have up to 20 products attached with `billing_frequency` different than `one-time`",
      "enum": [
        "one-time",
        "annually",
        "semi-annually",
        "quarterly",
        "monthly",
        "weekly"
      ]
    },
    "billing_frequency_cycles": {
      "type": [
        "integer",
        "null"
      ],
      "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"
    },
    "billing_start_date": {
      "type": [
        "string",
        "null"
      ],
      "description": "Only available in Growth and above plans  The billing start date. Must be between 10 years in the past and 10 years in the future"
    },
    "comments": {
      "type": "string",
      "description": "The comments of the product"
    },
    "discount": {
      "type": "number",
      "description": "The value of the discount. The `discount_type` field can be used to specify whether the value is an amount or a percentage"
    },
    "discount_type": {
      "type": "string",
      "description": "The value of the discount. The `discount_type` field can be used to specify whether the value is an amount or a percentage",
      "enum": [
        "percentage",
        "amount"
      ]
    },
    "is_enabled": {
      "type": "boolean",
      "description": "Whether this product is enabled for the deal  Not possible to disable the product if the deal has installments associated and the product is the last one enabled  Not possible to enable the product if the deal has installments associated and the product is recurring"
    },
    "item_price": {
      "type": "number",
      "description": "The price value of the product"
    },
    "product_id": {
      "type": "integer",
      "description": "The ID of the product"
    },
    "product_variation_id": {
      "type": [
        "integer",
        "null"
      ],
      "description": "The ID of the product variation"
    },
    "quantity": {
      "type": "number",
      "description": "The quantity of the product"
    },
    "tax": {
      "type": "number",
      "description": "The product tax"
    },
    "tax_method": {
      "type": "string",
      "description": "The tax option to be applied to the products. When using `inclusive`, the tax percentage will already be included in the price. When using `exclusive`, the tax will not be included in the price. When using `none`, no tax will be added. Use the `tax` field for defining the tax percentage amount. By default, the user setting value for tax options will be used. Changing this in one product affects the rest of the products attached to the deal",
      "enum": [
        "exclusive",
        "inclusive",
        "none"
      ]
    }
  },
  "required": [
    "PCID",
    "id",
    "item_price",
    "product_id",
    "quantity"
  ]
}

---

pipedrive_deals_add_many_deal_products

Add multiple products to a deal

Parameters:

Parameter	Type	Required	Default	Description
id	integer	Yes	—	The ID of the deal
data	any[]	Yes	—	Array of products to attach to the deal. Each product object may have the following properties.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "integer",
      "description": "The ID of the deal"
    },
    "data": {
      "type": "array",
      "description": "Array of products to attach to the deal. Each product object may have the following properties."
    }
  },
  "required": [
    "PCID",
    "id",
    "data"
  ]
}

---

pipedrive_deals_convert_deal_to_lead

Convert a deal to a lead

Parameters:

Parameter	Type	Required	Default	Description
id	integer	Yes	—	The ID of the deal to convert

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "integer",
      "description": "The ID of the deal to convert"
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

pipedrive_deals_convert_lead_to_deal

Convert a lead to a deal

Parameters:

Parameter	Type	Required	Default	Description
id	string	Yes	—	The ID of the lead to convert
pipeline_id	integer	No	—	The ID of a pipeline the created deal will be added to. By default, the deal will be added to the first stage of the specified pipeline. Please note that pipeline_id and stage_id should not be used together as pipeline_id will be ignored.
stage_id	integer	No	—	The ID of a stage the created deal will be added to. Please note that a pipeline will be assigned automatically based on the stage_id. If omitted, the deal will be placed in the first stage of the default pipeline.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "The ID of the lead to convert"
    },
    "pipeline_id": {
      "type": "integer",
      "description": "The ID of a pipeline the created deal will be added to. By default, the deal will be added to the first stage of the specified pipeline. Please note that `pipeline_id` and `stage_id` should not be used together as `pipeline_id` will be ignored."
    },
    "stage_id": {
      "type": "integer",
      "description": "The ID of a stage the created deal will be added to. Please note that a pipeline will be assigned automatically based on the `stage_id`. If omitted, the deal will be placed in the first stage of the default pipeline."
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

pipedrive_deals_delete_additional_discount

Delete a discount from a deal

Parameters:

Parameter	Type	Required	Default	Description
id	integer	Yes	—	The ID of the deal
discount_id	string	Yes	—	The ID of the discount

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "integer",
      "description": "The ID of the deal"
    },
    "discount_id": {
      "type": "string",
      "description": "The ID of the discount"
    }
  },
  "required": [
    "PCID",
    "id",
    "discount_id"
  ]
}

---

pipedrive_deals_delete_deal

Delete a deal

Parameters:

Parameter	Type	Required	Default	Description
id	integer	Yes	—	The ID of the deal

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "integer",
      "description": "The ID of the deal"
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

pipedrive_deals_delete_deal_field

Delete one deal field

Parameters:

Parameter	Type	Required	Default	Description
field_code	string	Yes	—	The unique code identifying the field

Show inputSchema

{
  "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_deals_delete_deal_field_options

Delete deal 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.

Show inputSchema

{
  "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_deals_delete_deal_follower

Delete a follower from a deal

Parameters:

Parameter	Type	Required	Default	Description
id	integer	Yes	—	The ID of the deal
follower_id	integer	Yes	—	The ID of the following user

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "integer",
      "description": "The ID of the deal"
    },
    "follower_id": {
      "type": "integer",
      "description": "The ID of the following user"
    }
  },
  "required": [
    "PCID",
    "id",
    "follower_id"
  ]
}

---

pipedrive_deals_delete_deal_product

Delete an attached product from a deal

Parameters:

Parameter	Type	Required	Default	Description
id	integer	Yes	—	The ID of the deal
product_attachment_id	integer	Yes	—	The product attachment ID

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "integer",
      "description": "The ID of the deal"
    },
    "product_attachment_id": {
      "type": "integer",
      "description": "The product attachment ID"
    }
  },
  "required": [
    "PCID",
    "id",
    "product_attachment_id"
  ]
}

---

pipedrive_deals_delete_installment

Delete an installment from a deal

Parameters:

Parameter	Type	Required	Default	Description
id	integer	Yes	—	The ID of the deal
installment_id	integer	Yes	—	The ID of the installment

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "integer",
      "description": "The ID of the deal"
    },
    "installment_id": {
      "type": "integer",
      "description": "The ID of the installment"
    }
  },
  "required": [
    "PCID",
    "id",
    "installment_id"
  ]
}

---

pipedrive_deals_delete_many_deal_products

Delete many products from a deal

Parameters:

Parameter	Type	Required	Default	Description
id	integer	Yes	—	The ID of the deal
ids	string	Yes	—	Comma-separated list of deal product IDs to delete. Maximum 100 IDs allowed.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "integer",
      "description": "The ID of the deal"
    },
    "ids": {
      "type": "string",
      "description": "Comma-separated list of deal product IDs to delete. Maximum 100 IDs allowed."
    }
  },
  "required": [
    "PCID",
    "id",
    "ids"
  ]
}

---

pipedrive_deals_get_additional_discounts

List discounts added to a deal

Parameters:

Parameter	Type	Required	Default	Description
id	integer	Yes	—	The ID of the deal

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "integer",
      "description": "The ID of the deal"
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

pipedrive_deals_get_archived_deals

Get all archived deals

Parameters:

Parameter	Type	Required	Default	Description
filter_id	integer	No	—	If supplied, only deals 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 deals owned by the specified user are returned. If filter_id is provided, this is ignored.
person_id	integer	No	—	If supplied, only deals linked to the specified person are returned. If filter_id is provided, this is ignored.
org_id	integer	No	—	If supplied, only deals linked to the specified organization are returned. If filter_id is provided, this is ignored.
pipeline_id	integer	No	—	If supplied, only deals in the specified pipeline are returned. If filter_id is provided, this is ignored.
stage_id	integer	No	—	If supplied, only deals in the specified stage are returned. If filter_id is provided, this is ignored.
status	string	No	—	Only fetch deals with a specific status. If omitted, all not deleted deals are returned. If set to deleted, deals that have been deleted up to 30 days ago will be included. Multiple statuses can be included as a comma separated array. If filter_id is provided, this is ignored.
updated_since	string	No	—	If set, only deals 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 deals 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.
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: next_activity_id, last_activity_id, first_won_time, products_count, files_count, notes_count, followers_count, email_messages_count, activities_count, done_activities_count, undone_activities_count, participants_count, last_incoming_mail_time, last_outgoing_mail_time, smart_bcc_email, source_lead_id
custom_fields	string	No	—	Optional 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 faster results and smaller response.<br/>A maximum of 15 keys is allowed.
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

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "filter_id": {
      "type": "integer",
      "description": "If supplied, only deals 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 deals owned by the specified user are returned. If filter_id is provided, this is ignored."
    },
    "person_id": {
      "type": "integer",
      "description": "If supplied, only deals linked to the specified person are returned. If filter_id is provided, this is ignored."
    },
    "org_id": {
      "type": "integer",
      "description": "If supplied, only deals linked to the specified organization are returned. If filter_id is provided, this is ignored."
    },
    "pipeline_id": {
      "type": "integer",
      "description": "If supplied, only deals in the specified pipeline are returned. If filter_id is provided, this is ignored."
    },
    "stage_id": {
      "type": "integer",
      "description": "If supplied, only deals in the specified stage are returned. If filter_id is provided, this is ignored."
    },
    "status": {
      "type": "string",
      "description": "Only fetch deals with a specific status. If omitted, all not deleted deals are returned. If set to deleted, deals that have been deleted up to 30 days ago will be included. Multiple statuses can be included as a comma separated array. If filter_id is provided, this is ignored.",
      "enum": [
        "open",
        "won",
        "lost",
        "deleted"
      ]
    },
    "updated_since": {
      "type": "string",
      "description": "If set, only deals 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 deals 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`.",
      "enum": [
        "id",
        "update_time",
        "add_time"
      ]
    },
    "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: next_activity_id, last_activity_id, first_won_time, products_count, files_count, notes_count, followers_count, email_messages_count, activities_count, done_activities_count, undone_activities_count, participants_count, last_incoming_mail_time, last_outgoing_mail_time, smart_bcc_email, source_lead_id"
    },
    "custom_fields": {
      "type": "string",
      "description": "Optional 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 faster results and smaller response.<br/>A maximum of 15 keys is allowed."
    },
    "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_deals_get_deal

Get details of a deal

Parameters:

Parameter	Type	Required	Default	Description
id	integer	Yes	—	The ID of the deal
include_fields	string	No	—	Optional comma separated string array of additional fields to include Valid values: next_activity_id, last_activity_id, first_won_time, products_count, files_count, notes_count, followers_count, email_messages_count, activities_count, done_activities_count, undone_activities_count, participants_count, last_incoming_mail_time, last_outgoing_mail_time, smart_bcc_email, source_lead_id
custom_fields	string	No	—	Optional 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 faster results and smaller response.<br/>A maximum of 15 keys is allowed.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "integer",
      "description": "The ID of the deal"
    },
    "include_fields": {
      "type": "string",
      "description": "Optional comma separated string array of additional fields to include Valid values: next_activity_id, last_activity_id, first_won_time, products_count, files_count, notes_count, followers_count, email_messages_count, activities_count, done_activities_count, undone_activities_count, participants_count, last_incoming_mail_time, last_outgoing_mail_time, smart_bcc_email, source_lead_id"
    },
    "custom_fields": {
      "type": "string",
      "description": "Optional 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 faster results and smaller response.<br/>A maximum of 15 keys is allowed."
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

pipedrive_deals_get_deal_conversion_status

Get Deal conversion status

Parameters:

Parameter	Type	Required	Default	Description
id	integer	Yes	—	The ID of a deal
conversion_id	string	Yes	—	The ID of the conversion

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "integer",
      "description": "The ID of a deal"
    },
    "conversion_id": {
      "type": "string",
      "description": "The ID of the conversion"
    }
  },
  "required": [
    "PCID",
    "id",
    "conversion_id"
  ]
}

---

pipedrive_deals_get_deal_field

Get one deal 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, important_fields, required_fields, ui_visibility,important_fields, ui_visibility,required_fields, important_fields,required_fields, ui_visibility,important_fields,required_fields

Show inputSchema

{
  "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, important_fields, required_fields, ui_visibility,important_fields, ui_visibility,required_fields, important_fields,required_fields, ui_visibility,important_fields,required_fields"
    }
  },
  "required": [
    "PCID",
    "field_code"
  ]
}

---

pipedrive_deals_get_deal_fields

Get all deal 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, important_fields, required_fields, ui_visibility,important_fields, ui_visibility,required_fields, important_fields,required_fields, ui_visibility,important_fields,required_fields
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

Show inputSchema

{
  "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, important_fields, required_fields, ui_visibility,important_fields, ui_visibility,required_fields, important_fields,required_fields, ui_visibility,important_fields,required_fields"
    },
    "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_deals_get_deal_followers

List followers of a deal

Parameters:

Parameter	Type	Required	Default	Description
id	integer	Yes	—	The ID of the deal
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

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "integer",
      "description": "The ID of the deal"
    },
    "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_deals_get_deal_followers_changelog

List followers changelog of a deal

Parameters:

Parameter	Type	Required	Default	Description
id	integer	Yes	—	The ID of the deal
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

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "integer",
      "description": "The ID of the deal"
    },
    "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_deals_get_deal_products

List products attached to a deal

Parameters:

Parameter	Type	Required	Default	Description
id	integer	Yes	—	The ID of the deal
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, add_time, update_time, order_nr.
sort_direction	string	No	—	The sorting direction. Supported values: asc, desc.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "integer",
      "description": "The ID of the deal"
    },
    "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`, `add_time`, `update_time`, `order_nr`.",
      "enum": [
        "id",
        "add_time",
        "update_time",
        "order_nr"
      ]
    },
    "sort_direction": {
      "type": "string",
      "description": "The sorting direction. Supported values: `asc`, `desc`.",
      "enum": [
        "asc",
        "desc"
      ]
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

pipedrive_deals_get_deals

Get all deals

Parameters:

Parameter	Type	Required	Default	Description
filter_id	integer	No	—	If supplied, only deals 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 deals owned by the specified user are returned. If filter_id is provided, this is ignored.
person_id	integer	No	—	If supplied, only deals linked to the specified person are returned. If filter_id is provided, this is ignored.
org_id	integer	No	—	If supplied, only deals linked to the specified organization are returned. If filter_id is provided, this is ignored.
pipeline_id	integer	No	—	If supplied, only deals in the specified pipeline are returned. If filter_id is provided, this is ignored.
stage_id	integer	No	—	If supplied, only deals in the specified stage are returned. If filter_id is provided, this is ignored.
status	string	No	—	Only fetch deals with a specific status. If omitted, all not deleted deals are returned. If set to deleted, deals that have been deleted up to 30 days ago will be included. Multiple statuses can be included as a comma separated array. If filter_id is provided, this is ignored.
updated_since	string	No	—	If set, only deals 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 deals 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.
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: next_activity_id, last_activity_id, first_won_time, products_count, files_count, notes_count, followers_count, email_messages_count, activities_count, done_activities_count, undone_activities_count, participants_count, last_incoming_mail_time, last_outgoing_mail_time, smart_bcc_email, source_lead_id
custom_fields	string	No	—	Optional 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 faster results and smaller response.<br/>A maximum of 15 keys is allowed.
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

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "filter_id": {
      "type": "integer",
      "description": "If supplied, only deals 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 deals owned by the specified user are returned. If filter_id is provided, this is ignored."
    },
    "person_id": {
      "type": "integer",
      "description": "If supplied, only deals linked to the specified person are returned. If filter_id is provided, this is ignored."
    },
    "org_id": {
      "type": "integer",
      "description": "If supplied, only deals linked to the specified organization are returned. If filter_id is provided, this is ignored."
    },
    "pipeline_id": {
      "type": "integer",
      "description": "If supplied, only deals in the specified pipeline are returned. If filter_id is provided, this is ignored."
    },
    "stage_id": {
      "type": "integer",
      "description": "If supplied, only deals in the specified stage are returned. If filter_id is provided, this is ignored."
    },
    "status": {
      "type": "string",
      "description": "Only fetch deals with a specific status. If omitted, all not deleted deals are returned. If set to deleted, deals that have been deleted up to 30 days ago will be included. Multiple statuses can be included as a comma separated array. If filter_id is provided, this is ignored.",
      "enum": [
        "open",
        "won",
        "lost",
        "deleted"
      ]
    },
    "updated_since": {
      "type": "string",
      "description": "If set, only deals 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 deals 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`.",
      "enum": [
        "id",
        "update_time",
        "add_time"
      ]
    },
    "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: next_activity_id, last_activity_id, first_won_time, products_count, files_count, notes_count, followers_count, email_messages_count, activities_count, done_activities_count, undone_activities_count, participants_count, last_incoming_mail_time, last_outgoing_mail_time, smart_bcc_email, source_lead_id"
    },
    "custom_fields": {
      "type": "string",
      "description": "Optional 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 faster results and smaller response.<br/>A maximum of 15 keys is allowed."
    },
    "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_deals_get_installments

List installments added to a list of deals

Parameters:

Parameter	Type	Required	Default	Description
deal_ids	integer[]	Yes	—	An array of integers with the IDs of the deals for which the attached installments will be returned. A maximum of 100 deal IDs can be provided.
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, billing_date, deal_id.
sort_direction	string	No	—	The sorting direction. Supported values: asc, desc.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "deal_ids": {
      "type": "array",
      "items": {
        "type": "integer"
      },
      "description": "An array of integers with the IDs of the deals for which the attached installments will be returned. A maximum of 100 deal IDs can be provided."
    },
    "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`, `billing_date`, `deal_id`.",
      "enum": [
        "id",
        "billing_date",
        "deal_id"
      ]
    },
    "sort_direction": {
      "type": "string",
      "description": "The sorting direction. Supported values: `asc`, `desc`.",
      "enum": [
        "asc",
        "desc"
      ]
    }
  },
  "required": [
    "PCID",
    "deal_ids"
  ]
}

---

pipedrive_deals_get_lead_conversion_status

Get Lead conversion status

Parameters:

Parameter	Type	Required	Default	Description
id	string	Yes	—	The ID of a lead
conversion_id	string	Yes	—	The ID of the conversion

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "The ID of a lead"
    },
    "conversion_id": {
      "type": "string",
      "description": "The ID of the conversion"
    }
  },
  "required": [
    "PCID",
    "id",
    "conversion_id"
  ]
}

---

pipedrive_deals_get_products

Get deal products of several deals

Parameters:

Parameter	Type	Required	Default	Description
deal_ids	integer[]	Yes	—	An array of integers with the IDs of the deals for which the attached products will be returned. A maximum of 100 deal IDs can be provided.
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, deal_id, add_time, update_time, order_nr.
sort_direction	string	No	—	The sorting direction. Supported values: asc, desc.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "deal_ids": {
      "type": "array",
      "items": {
        "type": "integer"
      },
      "description": "An array of integers with the IDs of the deals for which the attached products will be returned. A maximum of 100 deal IDs can be provided."
    },
    "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`, `deal_id`, `add_time`, `update_time`, `order_nr`.",
      "enum": [
        "id",
        "deal_id",
        "add_time",
        "update_time",
        "order_nr"
      ]
    },
    "sort_direction": {
      "type": "string",
      "description": "The sorting direction. Supported values: `asc`, `desc`.",
      "enum": [
        "asc",
        "desc"
      ]
    }
  },
  "required": [
    "PCID",
    "deal_ids"
  ]
}

---

pipedrive_deals_post_additional_discount

Add a discount to a deal

Parameters:

Parameter	Type	Required	Default	Description
id	integer	Yes	—	The ID of the deal
amount	number	Yes	—	The discount amount. Must be a positive number (excluding 0).
description	string	Yes	—	The name of the discount.
type	string	Yes	—	Determines whether the discount is applied as a percentage or a fixed amount.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "integer",
      "description": "The ID of the deal"
    },
    "amount": {
      "type": "number",
      "description": "The discount amount. Must be a positive number (excluding 0)."
    },
    "description": {
      "type": "string",
      "description": "The name of the discount."
    },
    "type": {
      "type": "string",
      "description": "Determines whether the discount is applied as a percentage or a fixed amount.",
      "enum": [
        "percentage",
        "amount"
      ]
    }
  },
  "required": [
    "PCID",
    "id",
    "amount",
    "description",
    "type"
  ]
}

---

pipedrive_deals_post_installment

Add an installment to a deal

Parameters:

Parameter	Type	Required	Default	Description
id	integer	Yes	—	The ID of the deal
amount	number	Yes	—	The installment amount. Must be a positive number (excluding 0).
billing_date	string	Yes	—	The date on which the installment will be charged. Must be in the format YYYY-MM-DD.
description	string	Yes	—	The name of the installment.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "integer",
      "description": "The ID of the deal"
    },
    "amount": {
      "type": "number",
      "description": "The installment amount. Must be a positive number (excluding 0)."
    },
    "billing_date": {
      "type": "string",
      "description": "The date on which the installment will be charged. Must be in the format YYYY-MM-DD."
    },
    "description": {
      "type": "string",
      "description": "The name of the installment."
    }
  },
  "required": [
    "PCID",
    "id",
    "amount",
    "billing_date",
    "description"
  ]
}

---

pipedrive_deals_search_deals

Search deals

Parameters:

Parameter	Type	Required	Default	Description
term	string	Yes	—	The search term to look for. Minimum 2 characters (or 1 if using exact_match). Please note that the search term has to be URL encoded.
fields	string	No	—	A comma-separated string array. The fields to perform the search from. Defaults to all of them. Only the following custom field types are searchable: address, varchar, text, varchar_auto, double, monetary and phone. Read more about searching by custom fields <a href=“https://support.pipedrive.com/en/article/search-finding-what-you-need#searching-by-custom-fields” target=“_blank” rel=“noopener noreferrer”>here</a>. Valid values: custom_fields, notes, title
exact_match	boolean	No	—	When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
person_id	integer	No	—	Will filter deals by the provided person ID. The upper limit of found deals associated with the person is 2000.
organization_id	integer	No	—	Will filter deals by the provided organization ID. The upper limit of found deals associated with the organization is 2000.
status	string	No	—	Will filter deals by the provided specific status. open = Open, won = Won, lost = Lost. The upper limit of found deals associated with the status is 2000.
include_fields	string	No	—	Supports including optional fields in the results which are not provided by default Valid values: deal.cc_email
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

Show inputSchema

{
  "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 <a href=\"https://support.pipedrive.com/en/article/search-finding-what-you-need#searching-by-custom-fields\" target=\"_blank\" rel=\"noopener noreferrer\">here</a>. Valid values: custom_fields, notes, title"
    },
    "exact_match": {
      "type": "boolean",
      "description": "When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive."
    },
    "person_id": {
      "type": "integer",
      "description": "Will filter deals by the provided person ID. The upper limit of found deals associated with the person is 2000."
    },
    "organization_id": {
      "type": "integer",
      "description": "Will filter deals by the provided organization ID. The upper limit of found deals associated with the organization is 2000."
    },
    "status": {
      "type": "string",
      "description": "Will filter deals by the provided specific status. open = Open, won = Won, lost = Lost. The upper limit of found deals associated with the status is 2000.",
      "enum": [
        "open",
        "won",
        "lost"
      ]
    },
    "include_fields": {
      "type": "string",
      "description": "Supports including optional fields in the results which are not provided by default Valid values: deal.cc_email"
    },
    "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_deals_search_leads

Search leads

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. Valid values: custom_fields, notes, title
exact_match	boolean	No	—	When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive.
person_id	integer	No	—	Will filter leads by the provided person ID. The upper limit of found leads associated with the person is 2000.
organization_id	integer	No	—	Will filter leads by the provided organization ID. The upper limit of found leads associated with the organization is 2000.
include_fields	string	No	—	Supports including optional fields in the results which are not provided by default Valid values: lead.was_seen
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

Show inputSchema

{
  "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. Valid values: custom_fields, notes, title"
    },
    "exact_match": {
      "type": "boolean",
      "description": "When enabled, only full exact matches against the given term are returned. It is <b>not</b> case sensitive."
    },
    "person_id": {
      "type": "integer",
      "description": "Will filter leads by the provided person ID. The upper limit of found leads associated with the person is 2000."
    },
    "organization_id": {
      "type": "integer",
      "description": "Will filter leads by the provided organization ID. The upper limit of found leads associated with the organization is 2000."
    },
    "include_fields": {
      "type": "string",
      "description": "Supports including optional fields in the results which are not provided by default Valid values: lead.was_seen"
    },
    "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_deals_update_additional_discount

Update a discount added to a deal

Parameters:

Parameter	Type	Required	Default	Description
id	integer	Yes	—	The ID of the deal
discount_id	string	Yes	—	The ID of the discount
amount	number	No	—	The discount amount. Must be a positive number (excluding 0).
description	string	No	—	The name of the discount.
type	string	No	—	Determines whether the discount is applied as a percentage or a fixed amount.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "integer",
      "description": "The ID of the deal"
    },
    "discount_id": {
      "type": "string",
      "description": "The ID of the discount"
    },
    "amount": {
      "type": "number",
      "description": "The discount amount. Must be a positive number (excluding 0)."
    },
    "description": {
      "type": "string",
      "description": "The name of the discount."
    },
    "type": {
      "type": "string",
      "description": "Determines whether the discount is applied as a percentage or a fixed amount.",
      "enum": [
        "percentage",
        "amount"
      ]
    }
  },
  "required": [
    "PCID",
    "id",
    "discount_id"
  ]
}

---

pipedrive_deals_update_deal

Update a deal

Parameters:

Parameter	Type	Required	Default	Description
id	integer	Yes	—	The ID of the deal
archive_time	string	No	—	The optional date and time of archiving the deal in UTC. Format: YYYY-MM-DD HH:MM:SS. If omitted and is_archived is true, it will be set to the current date and time.
close_time	string	null	No	—	The date and time of closing the deal. Can only be set if deal status is won or lost.
currency	string	No	—	The currency associated with the deal
custom_fields	object	No	—	An object where each key represents a custom field. All custom fields are referenced as randomly generated 40-character hashes
expected_close_date	string	No	—	The expected close date of the deal
is_archived	boolean	No	—	Whether the deal is archived or not
is_deleted	boolean	No	—	Whether the deal is deleted or not
label_ids	integer[]	No	—	The IDs of labels assigned to the deal
lost_reason	string	null	No	—	The reason for losing the deal. Can only be set if deal status is lost.
lost_time	string	No	—	The date and time of changing the deal status as lost. Can only be set if deal status is lost.
org_id	integer	No	—	The ID of the organization linked to the deal
owner_id	integer	No	—	The ID of the user who owns the deal
person_id	integer	No	—	The ID of the person linked to the deal
pipeline_id	integer	No	—	The ID of the pipeline associated with the deal
probability	number	null	No	—	The success probability percentage of the deal
stage_id	integer	No	—	The ID of the deal stage
status	string	No	—	The status of the deal
title	string	No	—	The title of the deal
value	number	No	—	The value of the deal
visible_to	integer	No	—	The visibility of the deal
won_time	string	No	—	The date and time of changing the deal status as won. Can only be set if deal status is won.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "integer",
      "description": "The ID of the deal"
    },
    "archive_time": {
      "type": "string",
      "description": "The optional date and time of archiving the deal in UTC. Format: YYYY-MM-DD HH:MM:SS. If omitted and `is_archived` is true, it will be set to the current date and time."
    },
    "close_time": {
      "type": [
        "string",
        "null"
      ],
      "description": "The date and time of closing the deal. Can only be set if deal status is won or lost."
    },
    "currency": {
      "type": "string",
      "description": "The currency associated with the deal"
    },
    "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"
    },
    "expected_close_date": {
      "type": "string",
      "description": "The expected close date of the deal"
    },
    "is_archived": {
      "type": "boolean",
      "description": "Whether the deal is archived or not"
    },
    "is_deleted": {
      "type": "boolean",
      "description": "Whether the deal is deleted or not"
    },
    "label_ids": {
      "type": "array",
      "items": {
        "type": "integer"
      },
      "description": "The IDs of labels assigned to the deal"
    },
    "lost_reason": {
      "type": [
        "string",
        "null"
      ],
      "description": "The reason for losing the deal. Can only be set if deal status is lost."
    },
    "lost_time": {
      "type": "string",
      "description": "The date and time of changing the deal status as lost. Can only be set if deal status is lost."
    },
    "org_id": {
      "type": "integer",
      "description": "The ID of the organization linked to the deal"
    },
    "owner_id": {
      "type": "integer",
      "description": "The ID of the user who owns the deal"
    },
    "person_id": {
      "type": "integer",
      "description": "The ID of the person linked to the deal"
    },
    "pipeline_id": {
      "type": "integer",
      "description": "The ID of the pipeline associated with the deal"
    },
    "probability": {
      "type": [
        "number",
        "null"
      ],
      "description": "The success probability percentage of the deal"
    },
    "stage_id": {
      "type": "integer",
      "description": "The ID of the deal stage"
    },
    "status": {
      "type": "string",
      "description": "The status of the deal"
    },
    "title": {
      "type": "string",
      "description": "The title of the deal"
    },
    "value": {
      "type": "number",
      "description": "The value of the deal"
    },
    "visible_to": {
      "type": "integer",
      "description": "The visibility of the deal"
    },
    "won_time": {
      "type": "string",
      "description": "The date and time of changing the deal status as won. Can only be set if deal status is won."
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

pipedrive_deals_update_deal_field

Update one deal field

Parameters:

Parameter	Type	Required	Default	Description
field_code	string	Yes	—	The unique code identifying the field
description	string	null	No	—	Field description
field_name	string	No	—	Field name
important_fields	object	No	—	Configuration for highlighting the field at specific stages.
required_fields	object	No	—	Required fields configuration for marking the field as mandatory when interacted with in the Pipedrive web UI.
ui_visibility	object	No	—	UI visibility settings for the field. Controls where the field appears in the Pipedrive web UI.

Show inputSchema

{
  "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"
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "description": "Field description"
    },
    "field_name": {
      "type": "string",
      "description": "Field name"
    },
    "important_fields": {
      "type": "object",
      "description": "Configuration for highlighting the field at specific stages.",
      "properties": {
        "enabled": {
          "type": "boolean",
          "description": "Whether the field is marked as important. When false, the field is not highlighted. When true with empty stage_ids, the field is important everywhere. When true with specific stage_ids, the field is important only at those stages. Default is false."
        },
        "stage_ids": {
          "type": "array",
          "items": {
            "type": "integer"
          },
          "description": "Array of deal stage IDs where this field should be highlighted as important. Must reference valid, active deal stages. Empty array when enabled is false. The stages must be in pipelines where this field is visible (show_in_pipelines)."
        }
      }
    },
    "required_fields": {
      "type": "object",
      "description": "Required fields configuration for marking the field as mandatory when interacted with in the Pipedrive web UI.",
      "properties": {
        "enabled": {
          "type": "boolean",
          "description": "Whether the field is required. When false, the field is optional. When true with empty stage_ids, the field is required everywhere. When true with specific stage_ids, the field is required only at those stages. Default is false."
        },
        "stage_ids": {
          "type": "array",
          "items": {
            "type": "integer"
          },
          "description": "Array of deal stage IDs where this field is required. Must reference valid, active deal stages. Empty array when enabled is false. The stages must be in pipelines where this field is visible (show_in_pipelines)."
        },
        "statuses": {
          "type": "object",
          "description": "Pipeline-specific status requirements for when deals are won or lost. Keys are pipeline IDs (as strings), values are arrays of status strings ('won', 'lost'). Example - {\"1\":[\"won\",\"lost\"],\"2\":[\"won\"]} means the field is required when marking deals as won or lost in pipeline 1, and only when won in pipeline 2. Must reference valid, active pipelines."
        }
      }
    },
    "ui_visibility": {
      "type": "object",
      "description": "UI visibility settings for the field. Controls where the field appears in the Pipedrive web UI.",
      "properties": {
        "add_visible_flag": {
          "type": "boolean",
          "description": "Whether the field is shown in the add deal modal. Default is false. Cannot be set to false for required system fields (title, pipeline, stage_id, probability)."
        },
        "details_visible_flag": {
          "type": "boolean",
          "description": "Whether the field is shown in the deal details view. Default is true."
        },
        "projects_detail_visible_flag": {
          "type": "boolean",
          "description": "Whether the field is shown in the project details view when the deal is linked to a project. Default is false."
        },
        "show_in_pipelines": {
          "type": "object",
          "description": "Controls which pipelines display this field. Default is show_in_all=true. Note that fields marked as important or required must be visible in the pipelines where they are configured."
        }
      }
    }
  },
  "required": [
    "PCID",
    "field_code"
  ]
}

---

pipedrive_deals_update_deal_field_options

Update deal 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.

Show inputSchema

{
  "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_deals_update_deal_product

Update the product attached to a deal

Parameters:

Parameter	Type	Required	Default	Description
id	integer	Yes	—	The ID of the deal
product_attachment_id	integer	Yes	—	The ID of the deal-product (the ID of the product attached to the deal)
billing_frequency	string	No	—	Only available in Growth and above plans How often a customer is billed for access to a service or product To set billing_frequency different than one-time, the deal must not have installments associated A deal can have up to 20 products attached with billing_frequency different than one-time
billing_frequency_cycles	integer	null	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
billing_start_date	string	null	No	—	Only available in Growth and above plans The billing start date. Must be between 10 years in the past and 10 years in the future
comments	string	No	—	The comments of the product
discount	number	No	—	The value of the discount. The discount_type field can be used to specify whether the value is an amount or a percentage
discount_type	string	No	—	The value of the discount. The discount_type field can be used to specify whether the value is an amount or a percentage
is_enabled	boolean	No	—	Whether this product is enabled for the deal Not possible to disable the product if the deal has installments associated and the product is the last one enabled Not possible to enable the product if the deal has installments associated and the product is recurring
item_price	number	No	—	The price value of the product
product_id	integer	No	—	The ID of the product
product_variation_id	integer	null	No	—	The ID of the product variation
quantity	number	No	—	The quantity of the product
tax	number	No	—	The product tax
tax_method	string	No	—	The tax option to be applied to the products. When using inclusive, the tax percentage will already be included in the price. When using exclusive, the tax will not be included in the price. When using none, no tax will be added. Use the tax field for defining the tax percentage amount. By default, the user setting value for tax options will be used. Changing this in one product affects the rest of the products attached to the deal

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "integer",
      "description": "The ID of the deal"
    },
    "product_attachment_id": {
      "type": "integer",
      "description": "The ID of the deal-product (the ID of the product attached to the deal)"
    },
    "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  To set `billing_frequency` different than `one-time`, the deal must not have installments associated  A deal can have up to 20 products attached with `billing_frequency` different than `one-time`",
      "enum": [
        "one-time",
        "annually",
        "semi-annually",
        "quarterly",
        "monthly",
        "weekly"
      ]
    },
    "billing_frequency_cycles": {
      "type": [
        "integer",
        "null"
      ],
      "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"
    },
    "billing_start_date": {
      "type": [
        "string",
        "null"
      ],
      "description": "Only available in Growth and above plans  The billing start date. Must be between 10 years in the past and 10 years in the future"
    },
    "comments": {
      "type": "string",
      "description": "The comments of the product"
    },
    "discount": {
      "type": "number",
      "description": "The value of the discount. The `discount_type` field can be used to specify whether the value is an amount or a percentage"
    },
    "discount_type": {
      "type": "string",
      "description": "The value of the discount. The `discount_type` field can be used to specify whether the value is an amount or a percentage",
      "enum": [
        "percentage",
        "amount"
      ]
    },
    "is_enabled": {
      "type": "boolean",
      "description": "Whether this product is enabled for the deal  Not possible to disable the product if the deal has installments associated and the product is the last one enabled  Not possible to enable the product if the deal has installments associated and the product is recurring"
    },
    "item_price": {
      "type": "number",
      "description": "The price value of the product"
    },
    "product_id": {
      "type": "integer",
      "description": "The ID of the product"
    },
    "product_variation_id": {
      "type": [
        "integer",
        "null"
      ],
      "description": "The ID of the product variation"
    },
    "quantity": {
      "type": "number",
      "description": "The quantity of the product"
    },
    "tax": {
      "type": "number",
      "description": "The product tax"
    },
    "tax_method": {
      "type": "string",
      "description": "The tax option to be applied to the products. When using `inclusive`, the tax percentage will already be included in the price. When using `exclusive`, the tax will not be included in the price. When using `none`, no tax will be added. Use the `tax` field for defining the tax percentage amount. By default, the user setting value for tax options will be used. Changing this in one product affects the rest of the products attached to the deal",
      "enum": [
        "exclusive",
        "inclusive",
        "none"
      ]
    }
  },
  "required": [
    "PCID",
    "id",
    "product_attachment_id"
  ]
}

---

pipedrive_deals_update_installment

Update an installment added to a deal

Parameters:

Parameter	Type	Required	Default	Description
id	integer	Yes	—	The ID of the deal
installment_id	integer	Yes	—	The ID of the installment
amount	number	No	—	The installment amount. Must be a positive number (excluding 0).
billing_date	string	No	—	The date on which the installment will be charged. Must be in the format YYYY-MM-DD.
description	string	No	—	The name of the installment.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "integer",
      "description": "The ID of the deal"
    },
    "installment_id": {
      "type": "integer",
      "description": "The ID of the installment"
    },
    "amount": {
      "type": "number",
      "description": "The installment amount. Must be a positive number (excluding 0)."
    },
    "billing_date": {
      "type": "string",
      "description": "The date on which the installment will be charged. Must be in the format YYYY-MM-DD."
    },
    "description": {
      "type": "string",
      "description": "The name of the installment."
    }
  },
  "required": [
    "PCID",
    "id",
    "installment_id"
  ]
}