[block:html]
{
  "html": "<div class=\"chlog-box\">\n    <div class=\"from-area\">\n        <span class=\"from-label\">Effective from:</span><br>\n        <span class=\"from-date\">September 7, 2023</span>\n    </div>\n    <div class=\"change-area\">\n      \n      <blockquote class=\"callout callout_info\" theme=\"📘\"><p class=\"callout-heading empty\"><span class=\"callout-icon\">📘</span></p><p><strong>We've decided to retract the change to Deals API</strong>: </p><p>After careful consideration and valuable input from feedback from our API users, we have decided to retract the previously announced breaking change to the API.</p><p><strong>Why are we retracting the change?</strong></p><p>Upon reviewing the concerns raised, it became evident that the implementation of workarounds to get the exact time of deal closures would impose undue burdens on our technology partners and customers. Therefore, we have opted to maintain the current functionality, where the relevant fields will continue to return full datetime values as they presently do.</p><p><strong>Will this retraction affect those using the existing API?</strong></p><p>There will be no alterations to the current API behavior, and consequently, no adverse effects will arise for those utilizing the established client code.</p><p><strong>What about those who have already made adjustments towards the new API behavior?</strong></p><p>For those who have proactively updated their code in anticipation of the new API specifications, firstly, thank you for your proactive work. With this retraction, we advise reverting any modifications pertaining to the now-retracted change. The API will continue to function as it did prior to the announcement, negating the necessity for these adjustments.</p><p>We apologize for any inconvenience this announcement may have caused and are committed to ensuring that our API remains user-friendly. Your continued support, feedback and understanding are greatly appreciated.</p><p>We at Pipedrive are committed to ensuring that every customer and partner has a stable and trustworthy experience with all of our products and services. Therefore, we’ll continue with transparent communications regarding our API and developer platform.</p></blockquote>\n      \n      <p><b>What is changing?</b></p>\n      <p>The data type for the <code>close_time</code>, <code>won_time</code>, <code>first_won_time</code>, and <code>lost_time</code> response fields will be changed from <code>datetime</code> to <code>date</code> for the following Deals API endpoints:</p>\n      <ul>\n        <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#getDeals\" target=\"blank\">GET /deals</a></code></li>\n         <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#getDealsTimeline\" target=\"blank\">GET /deals/timeline</a></code></li>\n         <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#getDeal\" target=\"blank\">GET /deals/{id}</a></code></li>\n         <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#addDeal\" target=\"blank\">POST /deals</a></code></li>\n         <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#duplicateDeal\" target=\"blank\">POST /deals/{id}/duplicate</a></code></li>\n         <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#updateDeal\" target=\"blank\">PUT /deals/{id}</a></code></li>\n         <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#mergeDeals\" target=\"blank\">PUT /deals/{id}/merge</a></code></li>\n        <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Persons#getPersonDeals\" target=\"blank\">GET /persons/{id}/deals</a></code></li>\n        <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Pipelines#getPipelineDeals\" target=\"blank\">GET /pipelines/{id}/deals</a></code></li>\n        <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Products#getProductDeals\" target=\"blank\">GET /products/{id}/deals</a></code></li>\n        <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Recents#getRecents\" target=\"blank\">GET /recents</a></code></li>\n        <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Stages#getStageDeals\" target=\"blank\">GET /stages/{id}/deals</a></code></li>\n      </ul>\n     \n      \n      <p>Similarly, the <code>won_time</code> and <code>lost_time</code> response fields will be changed from <code>datetime</code> to <code>date</code> in the <code><a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#getDealsCollection\" target=\"blank\">GET /deals/collection</a></code> endpoint.</p>\n      \n      <p>The update will be gradually rolled out between <b>December 6 and December 13, 2023</b>.</p>\n      \n      <p>If you have any questions or comments, let us know in <a href=\"https://devcommunity.pipedrive.com/\" target=\"_self\">the Developers' Community</a>.</p>\n   \n      \n      </div>\n</div> "
}
[/block]

We are updating the data type for four deals-related response fields from datetime to date.

Breaking change: data type update for 4 deals-related response fields

[block:html]
{
  "html": "<div class=\"chlog-box\">\n    <div class=\"from-area\">\n        <span class=\"from-label\">Effective from:</span><br>\n        <span class=\"from-date\">September 5, 2023</span>\n    </div>\n    <div class=\"change-area\">\n      \n      <p>We have implemented the following bug fixes in <a href=\"https://pipedrive.readme.io/docs/guide-for-webhooks-v2#webhook-format\" target=\"blank\">webhooks v2</a> for better user management and consistency with webhooks v1:</p>\n     \n      <p>1. The <code>user_id</code> field in the payload now represents the ID of the user who triggered the webhook. Previously, the field represented the owner of the webhook.</p>\n      \n      <p>2. We have added the <code>webhook_owner_id</code> field inside the meta section of the payload. This field represents the ID of the user who created the webhook.</p>\n      \n      <p>Please refer to our <a href=\"https://pipedrive.readme.io/docs/guide-for-webhooks-v2#webhook-format\" target=\"blank\">webhooks v2 guide</a> for more details. For any questions or comments, please share them in <a href=\"https://devcommunity.pipedrive.com/\" target=\"blank\">our Developers’ Community</a>.</p>\n      \n      \n      </div>\n</div>"
}
[/block]

We have implemented two bug fixes in the webhooks v2 payload for better user management.

Bug fixes in webhooks v2 payload

[block:html]
{
  "html": "<div class=\"chlog-box\">\n    <div class=\"from-area\">\n        <span class=\"from-label\">Effective from:</span><br>\n        <span class=\"from-date\">November 15, 2023</span>\n    </div>\n    <div class=\"change-area\">\n      \n      <p>UPDATE: In order to support the use cases where a deal has a larger amount of notes, we are updating the announced new notes per deal limit to 100.\n      \n      <p>We are introducing a new limit to the size of notes and the allowed number of notes per deal as a proactive measure aimed at safeguarding our system from potential misuse and excessive load.</p>\n      \n      <h3><b>What is changing?</b></h3>\n      <p><b>1. Limit on note size</b></p>\n      \n      <p>From <b>November 15, 2023</b>, notes will have <b>a maximum size limit of 100 kB</b>. Adding new notes and/or updating existing ones over the 100 kB limit will fail with a <code>400</code> error code for these endpoints:</p>\n      <ul>\n        <li><code></code><a href=\"https://developers.pipedrive.com/docs/api/v1/Notes#addNote\" target=\"blank\">POST /notes</a></li>\n        <li><code></code><a href=\"https://developers.pipedrive.com/docs/api/v1/Notes#updateNote\" target=\"blank\">PUT /notes/{id}</a></li>\n      </ul>\n      \n      <p><b>Please note that all existing notes exceeding the 100 kB limit will remain usable, but cannot be edited, unless they meet the size requirement.</b></p>\n      \n      <p>Here's an example of the <code>400</code> error response:</p>\n      <div class=\"CodeTabs CodeTabs_initial theme-light\"><div class=\"CodeTabs-toolbar\" role=\"tablist\"><button aria-selected=\"true\" class=\"CodeTabs_active\" role=\"tab\" type=\"button\">JSON</button></div><div class=\"CodeTabs-inner\" role=\"tabpanel\"><pre><button aria-label=\"Copy Code\" class=\"rdmd-code-copy fa\"></button><code class=\"rdmd-code lang-json theme-light\" data-lang=\"json\" name=\"\" tabindex=\"0\"><div class=\"cm-s-neo\">{\n  <span class=\"cm-property\">\"success\"</span>: <span class=\"cm-atom\">false</span>,\n  <span class=\"cm-property\">\"error\"</span>: <span class=\"cm-string\">\"Note content size cannot be more than 100 kB.\"</span>,\n  <span class=\"cm-property\">\"error_info\"</span>: <span class=\"cm-string\">\"Please check developers.pipedrive.com for more information about Pipedrive API.\"</span>,\n  <span class=\"cm-property\">\"data\"</span>: <span class=\"cm-atom\">null</span>,\n  <span class=\"cm-property\">\"additional_data\"</span>: <span class=\"cm-atom\">null</span>\n}\n\n</div></code></pre></div></div>\n      <br>\n      \n      <p><b>2. Limit on notes per deal</b></p>\n      <p>Similarly, from <b>November 15, 2023</b>, the <b>maximum number of notes per deal will be 100</b>. If the limit is exceeded for a specific deal, attempting to add new and/or update existing notes to be associated with the deal via the following endpoints will fail:</p>\n       <ul>\n        <li><code></code><a href=\"https://developers.pipedrive.com/docs/api/v1/Notes#addNote\" target=\"blank\">POST /notes</a></li>\n        <li><code></code><a href=\"https://developers.pipedrive.com/docs/api/v1/Notes#updateNote\" target=\"blank\">PUT /notes/{id}</a></li>\n      </ul>\n      \n      <p>Here's an example of the <code>400</code> error response:</p>\n      <div class=\"CodeTabs CodeTabs_initial theme-light\"><div class=\"CodeTabs-toolbar\" role=\"tablist\"><button aria-selected=\"true\" class=\"CodeTabs_active\" role=\"tab\" type=\"button\">JSON</button></div><div class=\"CodeTabs-inner\" role=\"tabpanel\"><pre><button aria-label=\"Copy Code\" class=\"rdmd-code-copy fa\"></button><code class=\"rdmd-code lang-json theme-light\" data-lang=\"json\" name=\"\" tabindex=\"0\"><div class=\"cm-s-neo\">{\n  <span class=\"cm-property\">\"success\"</span>: <span class=\"cm-atom\">false</span>,\n  <span class=\"cm-property\">\"error\"</span>: <span class=\"cm-string\">\"The limit of 50 notes per deal has been reached.\"</span>,\n  <span class=\"cm-property\">\"error_info\"</span>: <span class=\"cm-string\">\"Please check developers.pipedrive.com for more information about Pipedrive API.\"</span>,\n  <span class=\"cm-property\">\"data\"</span>: <span class=\"cm-atom\">null</span>,\n  <span class=\"cm-property\">\"additional_data\"</span>: <span class=\"cm-atom\">null</span>\n}\n\n</div></code></pre></div></div>\n      \n      <h3><b>Why is it changing?</b></h3>\n      <p>We are introducing the two new note-related limits in an effort to ensure the optimal performance and security of our system. We believe the 100 kB limit is generous enough to cover various use cases for notes while also protecting our system from potential misuse.</p>\n      \n      \n     <p>If you have any questions or comments, let us know in <a href=\"https://devcommunity.pipedrive.com/\" target=\"_self\">the Developers' Community</a>.</p>\n\n    </div>\n</div>  "
}
[/block]

We are introducing two new limits to Notes API: the maximum note size of 100 kB and the maximum number of notes per deal as 50. The goal of the limits is to safeguard our system from potential misuse and excessive load.

Breaking change: new note size and notes per deal limits

[block:html]
{
  "html": "<div class=\"chlog-box\">\n    <div class=\"from-area\">\n        <span class=\"from-label\">Effective from:</span><br>\n        <span class=\"from-date\">August 14, 2023</span>\n    </div>\n    <div class=\"change-area\">\n      <p>Based on your feedback, we’ve made one of the most requested app features possible: iframes!</p>\n      <p>With our <a href=\"https://pipedrive.readme.io/docs/custom-ui-extensions\" target=\"blank\">custom user interface (UI) extensions</a>, \n        you can render an embedded iframe with any contextual web content directly inside different Pipedrive views.</p>\n      <img src=\"https://files.readme.io/4614557-Custom_floating_window_in_Pipedrives_user_interface.png\">\n      <h3>Why should you implement custom UI extensions for your app?</h3>\n      <p>With custom UI extensions, you can now display your content natively in Pipedrive’s UI. This enables you to extend your app’s functionality in a multitude of ways, such as:\n\t\t\t<ul>\n\t\t  <li>Calling – outgoing and incoming calls, call notifications, in-call activities, call outcomes and follow-up actions</li>\n\t\t  <li>Messaging – messaging conversations and notifications</li>\n\t\t\t<li>The sky is the limit for any use case that helps customers win more deals! Display incoming support cases, showing a stream of contextual events from email marketing, lead generation \n        and other customer engagement tools, e.g., campaign click rates, webform/survey submissions, website visits, etc.</li>\n      </ul>\n      </p>\n  \t\t<p>Start building with the four custom UI extensions we offer:\n\t\t\t<ul>\n      <li><a href=\"https://pipedrive.readme.io/docs/custom-ui-extensions-floating-window\" target=\"blank\">Custom floating window</a></li>\n\t\t\t<li><a href=\"https://pipedrive.readme.io/docs/custom-ui-extensions-panels\" target=\"blank\">Custom panels</a></li>\n\t\t\t<li><a href=\"https://pipedrive.readme.io/docs/custom-ui-extensions-modals\" target=\"blank\">Custom modals</a></li>\n\t\t\t<li><a href=\"https://pipedrive.readme.io/docs/custom-ui-extensions-app-settings\" target=\"blank\">Custom UI for app settings</a></li>\n\t\t\t</ul>\n  \t\t</p><br>\n<h3>Custom floating window</h3>\n<p><img src=\"https://files.readme.io/7685eb9-Custom_floating_window.png\"></p>\n<p>A <a href=\"https://pipedrive.readme.io/docs/custom-ui-extensions-floating-window\" target=\"blank\">custom floating window</a> is an iframe embedded inside a <b>resizable and draggable window</b> that <b>persists while a user navigates</b> around Pipedrive.</p>\n<p>Users can drag the floating window around Pipedrive’s interface, while apps can resize it and make it visible where appropriate, e.g., when a user receives an incoming call/message.</p>\n<p>In addition, apps with a custom floating window have a <a href=\"https://pipedrive.readme.io/docs/custom-ui-extensions-floating-window#visibility-in-pipedrives-ui\" target=\"blank\">default entry point in the apps dock</a> located in a popover visible from the puzzle icon in the top bar.</p>\n<h3>Custom panels</h3>\n<img src=\"https://files.readme.io/5180f4a-Custom_panel.png\">\n<p>A <a href=\"https://pipedrive.readme.io/docs/custom-ui-extensions-panels\" target=\"blank\">custom panel</a> is an iframe embedded inside a <b>sidebar panel in the detail view</b> of deals, people, and organizations. Its height can be customized.</p>\n<h3>Custom modals</h3>\n<img src=\"https://files.readme.io/f5ab078-Custom_modal.png\">\n<p>A <a href=\"https://pipedrive.readme.io/docs/custom-ui-extensions-modals\" target=\"blank\">custom modal</a> is an iframe embedded in a <b>modal</b> window that <b>opens when triggered</b> by the user from various menus and links inside Pipedrive. A custom modal’s height and width are adjustable, as a modal can have a larger area.</p>\n<p>Custom modals have multiple entry points, including list and detail views and via the SDK.</p>\n<h3>Custom UI for app settings</h3>\n<p>Custom UI for app settings is an iframe embedded in a surface that gives users easy access to user settings for your app.</p>\n<br>\n<h3>Get inspired with our sample apps</h3>\n<p><b>Custom UI extensions x contract management sample app</b><br>\nLearn <a href=\"https://developers.pipedrive.com/tutorials/docusign-contract-management-custom-ui-integration?step=1\" target=\"blank\">how to integrate a contract management service into Pipedrive using custom UI extensions</a>. Although this tutorial centers on document/contract management, it can be extended to various use cases like proposals and CPQ (Configure, Price, Quote) integrations.</p>\n<p><b>Custom floating window x calling integrations</b><br>\nUsing the custom floating window, learn <a href=\"https://developers.pipedrive.com/tutorials/custom-floating-window-ui-caller-integrations\" target=\"blank\">how to integrate a calling service into Pipedrive</a>. While this extension is suitable for use cases that involve calling, telephony and messaging, it’s also an open canvas for any use case that fits.</p>\n<br>\n<h3>Start building custom UI extensions for your app</h3>\n<p>Check out our <a href=\"https://pipedrive.readme.io/docs/custom-ui-extensions\" target=\"blank\">custom UI extensions guide</a> and <a href=\"https://app.pipedrive.com/auth/login\" target=\"blank\">log in to your developer sandbox account</a> to start building. We’re excited to see how you use these extensions in your app!</p>\n<p>NB: If you need a sandbox, you can sign up for one <a href=\"https://developers.pipedrive.com/\" target=\"blank\">here</a>.</p>\n</div>\n</div>"
}
[/block]

Extend your app's functionality with our custom UI app extensions. Load any contextual web content within an embedded iframe directly inside different Pipedrive views.

Custom UI extensions: provide any functionality in Pipedrive via iframes

[block:html]
{
  "html": "<div class=\"chlog-box\">\n    <div class=\"from-area\">\n        <span class=\"from-label\">Effective from:</span><br>\n        <span class=\"from-date\">July 28, 2023</span>\n    </div>\n    <div class=\"change-area\">\n      <p>We are happy to announce 2 new cursor-paginated endpoints for Persons and Organizations API to offer a fast and performant way for querying large sets of items:\n      <ul>\n        <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Persons#getPersonsCollection\" target=\"blank\">GET /persons/collection</a></code> – for querying all persons</li>\n        <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Organizations#getOrganizationsCollection\" target=\"blank\">GET /organizations/collection</a></code> – for querying all organizations</li>\n      </ul></p>\n      <br>\n  <p><b>As these endpoints are released in Beta, we are interested in hearing about your experience using them! Let us know of any feedback in <a href=\"https://devcommunity.pipedrive.com/\" target=\"blank\">the Developers' Community</a>.</b></p>\n  <br>\n  <p><b>If, based on the feedback, anything is changed in the behavior of these endpoints during the Beta period, we will announce this in the <a href=\"https://devcommunity.pipedrive.com/t/introducing-2-new-cursor-paginated-get-endpoints-for-persons-and-organizations-api/7219\" target=\"blank\">Community thread</a>.</b></p>\n  <br>\n  <p>The pagination logic for these endpoints is controlled by the <code>cursor</code> and <code>limit</code> query parameters:\n      <ul>\n        <li><code>cursor</code> –  a marker representing the first item on the next page</li>\n        <li><code>limit</code> – the limit of entries to be returned</li>\n  \t\t</ul> </p>\n\n\t\t\t<p>Within the response’s <code>additional_data</code> object, the <code>next_cursor</code> field is returned, indicating the first item on the next page.</p>\n<br>\n<p><b>Please note</b> that only global admins (users with global permissions) can access these endpoints. Users with regular permissions will receive a <code>403</code> error response. </p>\n\n<br>\n<p><b>Here's an example response schema for the <code>GET /persons/collection</code> endpoint:</b></p>\n\t\t\t<div class=\"CodeTabs CodeTabs_initial theme-undefined\"><div class=\"CodeTabs-toolbar\"><button type=\"button\">JSON</button></div><div class=\"CodeTabs-inner\"><pre><button aria-label=\"Copy Code\" class=\"rdmd-code-copy fa\"></button><code class=\"rdmd-code lang-javascript theme-light\" data-lang=\"javascript\" name=\"JSON\"><div class=\"cm-s-neo\">{\n    <span class=\"cm-string\">\"success\"</span>: <span class=\"cm-atom\">true</span>,\n    <span class=\"cm-string\">\"data\"</span>: [\n        {\n            <span class=\"cm-string cm-property\">\"id\"</span>: <span class=\"cm-number\">1</span>,\n            <span class=\"cm-string cm-property\">\"active_flag\"</span>: <span class=\"cm-atom\">true</span>,\n            <span class=\"cm-string cm-property\">\"owner_id\"</span>: <span class=\"cm-number\">123</span>,\n            <span class=\"cm-string cm-property\">\"org_id\"</span>: <span class=\"cm-number\">1234</span>,\n            <span class=\"cm-string cm-property\">\"name\"</span>: <span class=\"cm-string\">\"Will Smith\"</span>,\n            <span class=\"cm-string cm-property\">\"phone\"</span>: [\n                {\n                    <span class=\"cm-string cm-property\">\"value\"</span>: <span class=\"cm-string\">\"12345\"</span>,\n                    <span class=\"cm-string cm-property\">\"primary\"</span>: <span class=\"cm-atom\">true</span>,\n                    <span class=\"cm-string cm-property\">\"label\"</span>: <span class=\"cm-string\">\"work\"</span>\n                }\n            ],\n            <span class=\"cm-string cm-property\">\"email\"</span>: [\n                {\n                    <span class=\"cm-string cm-property\">\"value\"</span>: <span class=\"cm-string\">\"12345@email.com\"</span>,\n                    <span class=\"cm-string cm-property\">\"primary\"</span>: <span class=\"cm-atom\">true</span>,\n                    <span class=\"cm-string cm-property\">\"label\"</span>: <span class=\"cm-string\">\"work\"</span>\n                }\n            ],\n            <span class=\"cm-string cm-property\">\"update_time\"</span>: <span class=\"cm-string\">\"2023-02-08 05:30:20\"</span>,\n            <span class=\"cm-string cm-property\">\"delete_time\"</span>: <span class=\"cm-atom\">null</span>,\n            <span class=\"cm-string cm-property\">\"add_time\"</span>: <span class=\"cm-string\">\"2023-01-08 05:30:20\"</span>,\n            <span class=\"cm-string cm-property\">\"visible_to\"</span>: <span class=\"cm-string\">\"3\"</span>,\n            <span class=\"cm-string cm-property\">\"picture_id\"</span>: <span class=\"cm-number\">12</span>,\n            <span class=\"cm-string cm-property\">\"label\"</span>: <span class=\"cm-number\">1</span>,\n            <span class=\"cm-string cm-property\">\"cc_email\"</span>: <span class=\"cm-string\">\"org@pipedrivemail.com\"</span>\n        }\n    ],\n    <span class=\"cm-string\">\"additional_data\"</span>: {\n        <span class=\"cm-string\">\"next_cursor\"</span>: <span class=\"cm-string\">\"eyJhY3Rpdml0aWVzIjoyN30\"</span>\n    }\n}\n</div></code></pre></div></div>\n\n\n\t\t\t<p>For additional information about pagination in the Pipedrive API, please refer to our developer documentation <a href=\"https://pipedrive.readme.io/docs/core-api-concepts-pagination\" target=\"blank\">here</a>.</p>\n\t\t\t\n\n<h3><b>What is the benefit of the new endpoints?</b></h3>\n\t\t\t<p>Until now, most of the <code>GET</code> endpoints of Pipedrive’s API have supported offset-based pagination. We are introducing the two new <code>GET</code> endpoints with cursor-based pagination to ensure reliable response times and a better experience when paging through large sets of entities.</p>\n\t\t\t\n<p>You can check out the previously announced Activities and Deals API cursor-based endpoints here:</p>\n<ul>\n  <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Activities#getActivitiesCollection\" target=\"blank\">GET /activities/collection</a></code></li>\n  <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#getDealsCollection\" target=\"blank\">GET /deals/collection</a></code></li>\n</ul>\n\n\n</div>\n</div>"
}
[/block]

We are happy to announce 2 new cursor-paginated GET endpoints for persons and organizations to offer a fast and performant way for retrieving items: <code>GET /persons/collection</code> and <code>GET /organizations/collection</code>.

Introducing 2 new cursor-paginated <code>GET</code> endpoints for Persons and Organizations API

[block:html]
{
  "html": "<div class=\"chlog-box\">\n    <div class=\"from-area\">\n        <span class=\"from-label\">Effective from:</span><br>\n        <span class=\"from-date\">October 25, 2023</span>\n    </div>\n    <div class=\"change-area\">\n      <p>Monetary discounts can now be added to the products attached to a deal, in addition to percentage discounts. The tax amount associated with a deal-product can now be specified as inclusive, exclusive, or none.</p>\n      \n      <h3><b>What is changing?</b></h3>\n      \n      <p>We have added 3 new body parameters to the POST and PUT deal-products endpoints:</p>\n      <ul>\n        <li><code>discount</code>- the value of the discount</li>\n        <li><code>discount_type</code>- the type of the discount's value (percentage or amount)</li>\n        <li><code>tax_method</code>- the tax option to be applied to the products (inclusive, exclusive or none)</li>\n      </ul>\n      \n      \n      <p>Similarly, the 3 fields have been added to the responses of the deal-products endpoints:</p>\n      <ul>\n        <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#getDealProducts\" target=\"blank\">GET /deals/{id}/products</a></code></li>\n        <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#addDealProduct\" target=\"blank\">POST /deals/{id}/products</a></code></li>\n        <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#updateDealProduct\" target=\"blank\">PUT /deals/{id}/products/{product_attachment_id}</a></code></li>\n      </ul>\n      <br>\n      <p>The existing <code>discount_percentage</code> parameter has been deprecated and will be removed from the 3 endpoints on <b>October 25, 2023</b>.</p>\n     \n      <h3><b>Why is it changing?</b></h3>\n      <p>With the new <code>discount</code> and <code>discount_type</code> fields being added to support both percentage and monetary discounts for products, the existing <code>discount_percentage</code> field no longer serves its purpose.</p>\n      \n      <p>If you have any questions or comments, let us know in <a href=\"https://devcommunity.pipedrive.com/\" target=\"_self\">the Developers' Community</a>.</p>\n   \n      \n      </div>\n \n</div>\n      "
}
[/block]

Two new fields in Deals API enable adding monetary discounts to the products attached to a deal, in addition to previous percentage discounts. The existing <code>discount_percentage</code> field has therefore been deprecated and will be removed.

Update to the logic of product discounts

[block:html]
{
  "html": "<div class=\"chlog-box\">\n    <div class=\"from-area\">\n        <span class=\"from-label\">Effective from:</span><br>\n        <span class=\"from-date\">August 21, 2023</span>\n    </div>\n    <div class=\"change-area\">\n     \n      <p>On June 29, 2022, we announced the <a href=\"https://developers.pipedrive.com/changelog/post/changes-in-filter-conditions-for-filters-api\" target=\"blank\">breaking changes in filter conditions for Filters API</a>. \nThe end date of the warning period has passed without the change going live for existing users prior to the initial announcement date. We want to apologize for any confusion or inconvenience this has caused. \n</p>\n      \n      <p>The changes to filter conditions will be implemented for all users between <b>August 21 and September 3, 2023</b>. All the details from the original announcement remain:</p>\n      \n      \n      <h3><b>What is changing?</b></h3>\n      <p>We will be implementing a limit to the number of conditions a filter can have via the <code><a href=\"https://developers.pipedrive.com/docs/api/v1/Filters#addFilter\" target=\"_self\">POST /filters</a></code> and <code><a href=\"https://developers.pipedrive.com/docs/api/v1/Filters#updateFilter\" target=\"_self\">PUT /filters/{id}</a></code> endpoints.\n        The new limit will be <b>16 conditions per filter</b>.</p>\n      \n      <p>If a filter is being added or updated to include more than 16 conditions, the request will fail and a <code>400</code> error response, similar to this one, will be returned:</p>\n      <div class=\"CodeTabs CodeTabs_initial theme-light\"><div class=\"CodeTabs-toolbar\"><button type=\"button\">JSON</button></div><div class=\"CodeTabs-inner\"><pre><code class=\"rdmd-code lang-json theme-light\" data-lang=\"json\" name=\"\"><button aria-label=\"Copy Code\" class=\"rdmd-code-copy fa\"></button><div class=\"cm-s-neo\">{\n  <span class=\"cm-property\">\"success\"</span>: <span class=\"cm-atom\">false</span>,\n  <span class=\"cm-property\">\"error\"</span>: <span class=\"cm-string\">\"Filter is allowed to have at most 16 conditions\"</span>,\n  <span class=\"cm-property\">\"error_info\"</span>: <span class=\"cm-string\">\"Please check developers.pipedrive.com for more information about Pipedrive API.\"</span>,\n  <span class=\"cm-property\">\"data\"</span>: <span class=\"cm-atom\">null</span>,\n  <span class=\"cm-property\">\"additional_data\"</span>: <span class=\"cm-atom\">null</span>\n}\n</div></code></pre></div></div>\n      \n      <p>In addition to the limit, we have now deprecated and will soon stop supporting the following filter conditions from the <code>conditions</code> body parameter of \n        the <code><a href=\"https://developers.pipedrive.com/docs/api/v1/Filters#addFilter\" target=\"_self\">POST /filters</a></code> and <code><a href=\"https://developers.pipedrive.com/docs/api/v1/Filters#updateFilter\" target=\"_self\">PUT /filters/{id}</a></code> endpoint:</p>\n      <ul>\n        <li><code>LIKE '%$'</code> <i>(ends with)</i></li>\n        <li><code>NOT LIKE '%$%'</code> <i>(does not contain)</i></li>\n        <li><code>NOT LIKE '%$'</code> <i>(does not end with)</i></li>\n      </ul>\n      \n      <p>We advise you to review the filters you have \n        created and make sure that they adhere to the changes.</p>\n        \n        <p><b>All existing filters with more than 16 conditions and/or the unsupported conditions will remain usable, but cannot be edited until they meet the above-mentioned requirements.</b></p>\n      \n      \n\t\t\t<h3><b>Why is it changing?</b></h3>\n      <p>Complex filters can easily cause system overload. As we are constantly improving our systems, \n        these limits will help to continuously support the performance \n        of our API to apps and users.</p>\n      \n     <p>If you have any questions or comments, let us know in <a href=\"https://devcommunity.pipedrive.com/\" target=\"_self\">the Developers' Community</a>.</p>\n    </div>\n  \n  \n</div>\n\n"
}
[/block]

On June 29, 2022, we announced the breaking changes in filter conditions for Filters API. The end date of the warning period has passed without the change going live for existing users prior to the announcement date. We want to apologize for any confusion or inconvenience this has caused. We are announcing a new live date for this change.

Update to the breaking changes in filter conditions for Filters API

[block:html]
{
  "html": "<div class=\"chlog-box\">\n    <div class=\"from-area\">\n        <span class=\"from-label\">Effective from:</span><br>\n        <span class=\"from-date\">September 15, 2023</span>\n    </div>\n    <div class=\"change-area\">\n      \n      <h2><b>What is changing?</b></h2>\n      \n      <p>From <b>September 15, 2023</b>, encrypted access tokens associated with <a href=\"https://pipedrive.readme.io/docs/marketplace-oauth-api\" target=\"blank\">OAuth 2.0</a> will be two times longer for improved security. We recommend using, at minimum, varchar(560) for storing the longer tokens in your app’s database.</p>\n      \n      <p><b>If your app uses encrypted access tokens, please check your app’s authentication logic to allocate enough space for storing the tokens.</b></p>\n      \n      <p>We will support old decryption until we are sure that all tokens are refreshed and use the new encryption.</p>\n      \n      <p>If you have any questions or comments, let us know in <a href=\"https://devcommunity.pipedrive.com/\" target=\"blank\">our Developers' Community</a>.</p>\n      </div>\n</div>"
}
[/block]

The encrypted access tokens for OAuth 2.0 will be two times longer from September 15, 2023 for improved security.

Improved security for access tokens related to OAuth 2.0

[block:html]
{
  "html": "<div class=\"chlog-box\">\n    <div class=\"from-area\">\n        <span class=\"from-label\">Effective from:</span><br>\n        <span class=\"from-date\">September 4, 2023</span>\n    </div>\n    <div class=\"change-area\">\n      \n      <h2><b>What is changing?</b></h2>\n      <p>Related to the announcement of <a href=\"https://developers.pipedrive.com/changelog/post/introducing-item-specific-create-and-update-permissions\" target=\"blank\">Introducing item-specific create and update permissions</a>, \n        we will be modifying the edit permission for Products API to make the behavior consistent \n        with deals, leads, organizations and persons entities.</p>\n      \n      <p><b>1. Introducing the <code>can_edit_other_users_products</code> field</b></p>\n      <p>Users can be restricted from editing other users’ products to ensure data reliability and quality for your Pipedrive account. Please note that the products owned by the user themselves will always remain editable.</p>\n\n      <p>The <code><a href=\"https://developers.pipedrive.com/docs/api/v1/Users#getUserPermissions\" target=\"blank\">GET /users/{id}/permissions</a></code> endpoint will include a new response field \n        <code>can_edit_other_users_products</code> to indicate whether the user is allowed to edit other users’ products. \n        We will roll the new permission field out to all companies on September 4.</p>\n      \n      <p>If the user does not have permission to edit other users’ products, \n        calling the <code><a href=\"https://developers.pipedrive.com/docs/api/v1/Products#updateProduct\" target=\"blank\">PUT /products/{id}</a></code> endpoint will result in a 403 error.</p>\n      \n      <p><b>2. Removing the existing <code>can_edit_products</code> field</b></p>\n      <p>The current permission field for editing products - the can_edit_products field - will be removed from the response of \n        the <code><a href=\"https://developers.pipedrive.com/docs/api/v1/Users#getUserPermissions\" target=\"blank\">GET /users/{id}/permissions</a></code> endpoint on September 4, 2023.</p>\n     \n      <p><b>Please check your API consumption logic and start using the new response field to check for the user’s products editing permission.</b></p>\n      <br>\n      <h2><b>Where can I find the permissions for a user?</b></h2>\n      <p>The <code><a href=\"https://developers.pipedrive.com/docs/api/v1/Users#getUserPermissions\" target=\"blank\">GET /users/{id}/permissions</a></code> endpoint can be used to find a specific user’s permissions.</p>\n      \n     <p>If you have any questions or comments, let us know in <a href=\"https://devcommunity.pipedrive.com/\" target=\"blank\">our Developers' Community</a>.</p>\n      \n   \n      </div>\n</div>"
}
[/block]

We are introducing a new response field and removing the existing one related to the permission for editing other users' products for the <code>GET /users/{id}/permissions</code> endpoint.

Update to the edit permission for Products API

[block:html]
{
  "html": "<div class=\"chlog-box\">\n    <div class=\"from-area\">\n        <span class=\"from-label\">Effective from:</span><br>\n        <span class=\"from-date\">August 22, 2023</span>\n    </div>\n    <div class=\"change-area\">\n      \n      <p><b>What is being removed?</b></p>\n      <p>The <code>sum_no_discount</code> response field will be removed from 3 deal-products endpoints on <b>August 22, 2023</b>:</p>\n      <ul>\n        <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#getDealProducts\" target=\"blank\">GET /deals/{id}/products</a></code></li>\n        <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#addDealProduct\" target=\"blank\">POST /deals/{id}/products</a></code></li>\n        <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#updateDealProduct\" target=\"blank\">PUT /deals/{id}/products/{product_attachment_id}</a></code></li>\n      </ul>\n      \n      <br>\n      <p><b>Why is it changing?</b></p>\n      \n      <p>The <code>sum_no_discount</code> response field is an obsolete legacy field, which we are removing to ensure that the 3 deal-products endpoints return only the most relevant fields.</p>\n      <p>If you have any questions or comments, let us know in <a href=\"https://devcommunity.pipedrive.com/\" target=\"blank\">our Developers' Community</a>.</p>\n      \n      </div>\n</div>"
}
[/block]

We are going to be removing an obsolete response field from 3 deal-products endpoints.

Contents

Changelog

Announced changes

Subscribe to our Changelog

Subscribe to our Changelog

Subscribe to our
Changelog