[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\">January 10, 2022</span>\n    </div>\n    <div class=\"change-area\">\n      <h3 class=\"heading heading-3 header-scroll\" align=\"\">\n      <div class=\"heading-anchor anchor waypoint\" id=\"new-endpoints-in-deals-and-contacts-scopes\"></div>\n        <div class=\"heading-text\"><div id=\"new-endpoints-in-deals-and-contacts-scopes\" class=\"heading-anchor_backwardsCompatibility\">\n          </div>New endpoints in Deals and Contacts scopes</div>\n        <a aria-label=\"Skip link to New endpoints in Deals and Contacts scopes\" class=\"heading-anchor-icon fa fa-anchor\" \n           href=\"#new-endpoints-in-deals-and-contacts-scopes\"></a></h3>\n\n      <p><code>Deals:read</code>, <code>deals:full</code>, <code>contacts:read</code> and <code>contacts:full</code> scopes now allow apps to have access to new endpoints.</p>\n      <h4><code>Deals:read</code> and <code>deals:full</code></h4>\n      <p> By selecting the <code>deals:read</code> and/or <code>deals:full</code> scope(s),\n        an app can now have access to the following endpoint, which allows the app to list users permitted to access a deal:</p>\n<ul>\n  <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#getDealUsers\" target=\"_self\">GET /deals/{id}/permittedUsers</a></code></li>\n      </ul>    \n      <h4><code>Contacts:read</code></h4>\n      <p> By selecting the <code> contacts:read</code>scope, an app can now have access to the following endpoints, which allow the app to list products associated with a person \n        and list users permitted to access a person and an organization:</p>\n<ul>\n  <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Persons#getPersonProducts\" target=\"_self\">GET /persons/{id}/products</a></code></li>\n  <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Persons#getPersonFollowers\" target=\"_self\">GET /persons/{id}/permittedUsers</a></code></li>\n  <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Organizations#getOrganizationUsers\" target=\"_self\">GET /organizations/{id}/permittedUsers</a></code></li>\n      </ul>\n      <h4><code>Contacts:full</code></h4>\n      <p> By selecting the <code> contacts:full</code>scope, an app can now have access to the following endpoints, which allow the app to list products associated with a person, \n        list users permitted to access a person and an organization and delete followers from a person and an organization:</p>\n<ul>\n  <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Persons#getPersonProducts\" target=\"_self\">GET /persons/{id}/products</a></code></li>\n  <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Persons#getPersonFollowers\" target=\"_self\">GET /persons/{id}/permittedUsers</a></code></li>\n  <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Organizations#getOrganizationUsers\" target=\"_self\">GET /organizations/{id}/permittedUsers</a></code></li>\n  <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Persons#deletePersonFollower\" target=\"_self\">DELETE /persons/{id}/followers/{follower_id}</a></code></li>\n  <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Organizations#deleteOrganizationFollower\" target=\"_self\">DELETE /organizations/{id}/followers/{follower_id}</a></code></li>\n      </ul>\n<p>You can read more about the scopes and permission explanations <a href=\"https://pipedrive.readme.io/docs/marketplace-scopes-and-permissions-explanations\">here</a>.</p> \n     <p>If you wish to add or remove scopes of an already approved or published app, be sure to <a href=\"https://pipedrive.readme.io/docs/marketplace-updating-the-existing-app#changing-the-scopes\">learn how changing the scopes will affect your app's existing users</a>.</p>\n\n\n      \n      <p class=\"published-on\"><i>Published on January 10, 2022</i></p>\n    </div>\n</div>"
}
[/block]

{"product": ["Developer Platform"], "features": ["API Reference"]}

New endpoints in Deals and Contacts scopes

[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\">December 29, 2021</span>\n    </div>\n    <div class=\"change-area\">\n       <h3 class=\"heading heading-3 header-scroll\" align=\"\">\n        <div class=\"heading-anchor anchor waypoint\" id=\"documentation-updates-for-api-reference-dec-21\"></div>\n        <div class=\"heading-text\"><div id=\"documentation-updates-for-api-reference-dec-21\" class=\"heading-anchor_backwardsCompatibility\">\n          </div>Documentation updates for API Reference</div>\n        <a aria-label=\"Skip link to Documentation updates for API Reference\" class=\"heading-anchor-icon fa fa-anchor\" \n           href=\"#documentation-updates-for-api-reference-dec-21\"></a></h3>\n      \n     <p>Here are the most recent updates to our <a href=\"https://developers.pipedrive.com/docs/api/v1/\">API Reference page</a>:\n      </p>\n      <p><b>1.</b> We improved the description of the <code>follower_id</code> path parameter within the \n        <code><a href=\"https://developers.pipedrive.com/docs/api/v1/Products#deleteProductFollower\" target=\"_self\">DELETE /products/{id}/followers/{follower_id}</a></code> endpoint.</p>\n        <p><b>2.</b> We added the body parameter <code>tax</code> to the following two endpoints: \n   <p>   <ul><ul>\n<li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#addDealProduct\" target=\"_self\">POST /deals/{id}/products</a></code></li>\n<li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#updateDealProduct\" target=\"_self\">PUT /deals/{id}/products/{product_attachment_id}</a></code></li>\n      </ul></p></ul>\n  <p><b>3.</b> We updated the response status code from <code>200</code> “OK” to <code>201</code> “Created” to reflect reality for the\n<code><a href=\"https://developers.pipedrive.com/docs/api/v1/Activities#addActivity\" target=\"_self\">POST /activities</a></code> endpoint.</p>\n    <p><b>4.</b> We added support for searching leads by <code>custom_fields</code> and <code>notes</code>  within the\n<code><a href=\"https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem\" target=\"_self\">GET /itemSearch</a></code> endpoint.</p>  \n       <br>\n      <p class=\"published-on\"><i>Published on December 29, 2021</i></p>\n  </div>\n</div> "
}
[/block]

Documentation updates for API Reference

[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\">February 7, 2022</span>\n    </div>\n    <div class=\"change-area\">\n       <h3 class=\"heading heading-3 header-scroll\" align=\"\">\n        <div class=\"heading-anchor anchor waypoint\" id=\"update-to-the-breaking-change-in-products-endpoint-and-webhook\"></div>\n        <div class=\"heading-text\"><div id=\"update-to-the-breaking-change-in-products-endpoint-and-webhook\" class=\"heading-anchor_backwardsCompatibility\">\n          </div>Update to the breaking change in Products endpoint and webhook</div>\n        <a aria-label=\"Skip link to Update to the breaking change in Products endpoint and webhook\" class=\"heading-anchor-icon fa fa-anchor\" \n           href=\"#update-to-the-breaking-change-in-products-endpoint-and-webhook\"></a></h3>\n      \n    <p>Regarding the <a href=\"https://pipedrive.readme.io/docs/changelog#breaking-change-in-products-endpoint-and-webhook\">breaking change in Products endpoint and webhook</a> we communicated on September 24, 2021, \n      we will be updating the response schema of the <code><a href=\"https://developers.pipedrive.com/docs/api/v1/Products#updateProduct\" target=\"_self\">PUT /v1/products/{id}</a></code> \n      endpoint and the response payload of the <code>updated.product</code> webhook.\n      The updated structure follows a consistent pattern and is unified with the responses of the Products endpoint.\n      </p>\n      \n\n      <p>The current response structure:\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-meta\">...</span>\n   <span class=\"cm-string\">“id”</span>: <span class=\"cm-number\">1</span>,\n   <span class=\"cm-string\">\"add_time\"</span>: <span class=\"cm-string\">\"2019-12-19 11:36:49\"</span>,\n   <span class=\"cm-string\">\"update_time\"</span>: <span class=\"cm-string\">\"2019-12-26 13:35:17\"</span>,\n   <span class=\"cm-property\">\"prices\"</span>:  {\n         <span class=\"cm-property\">\"EUR\"</span>: {\n            <span class=\"cm-property\">\"id\"</span>: <span class=\"cm-number\">1</span>,\n            <span class=\"cm-property\">\"product_id\"</span>: <span class=\"cm-number\">1</span>,\n            <span class=\"cm-property\">\"price\"</span>: <span class=\"cm-number\">5</span>,\n            <span class=\"cm-property\">\"currency\"</span>: <span class=\"cm-string\">\"EUR\"</span>,\n            <span class=\"cm-property\">\"cost\"</span>: <span class=\"cm-number\">2</span>,\n            <span class=\"cm-property\">\"overhead_cost\"</span>: <span class=\"cm-number\">3</span>\n          }\n    }\n   <span class=\"cm-meta\">...</span>\n};\n</div></code></pre></div></div>\n</p> \n  \n        <p>The updated response structure:\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-meta\">...</span>\n   <span class=\"cm-string\">“id”</span>: <span class=\"cm-number\">123</span>,\n   <span class=\"cm-string\">“add_time”</span>: <span class=\"cm-string\">\"2019-12-19 11:36:49\"</span>,\n   <span class=\"cm-string\">“update_time”</span>: <span class=\"cm-string\">\"2019-12-26 13:35:17\"</span>,\n   <span class=\"cm-property\">“prices”</span>: [\n      {\n         <span class=\"cm-property\">“id”</span>: <span class=\"cm-number\">1</span>,\n         <span class=\"cm-property\">“product_id”</span>: <span class=\"cm-number\">123</span>,\n         <span class=\"cm-property\">“price”</span>: <span class=\"cm-number\">5</span>,\n         <span class=\"cm-property\">“currency”</span>: <span class=\"cm-string\">\"EUR\"</span>,\n         <span class=\"cm-property\">“cost”</span>: <span class=\"cm-number\">2</span>,\n         <span class=\"cm-property\">“overhead_cost”</span>: <span class=\"cm-number\">3</span>,\n      },\n   ],\n   <span class=\"cm-meta\">...</span>\n};\n</div></code></pre></div></div>\n</p> \n\n<p>The updated response structure ensures consistency with the <code><a href=\"https://developers.pipedrive.com/docs/api/v1/Products#addProduct\" target=\"_self\">POST /v1/products</a></code> endpoint. The prices property is now represented in the same way - as an array of price objects.\n          \n       <br>\n      <p class=\"published-on\"><i>Published on December 8, 2021</i></p>\n  </div>\n</div>"
}
[/block]

{"product": ["API", "Webhooks"], "features": ["Products"]}

[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\">February 7, 2022</span>\n    </div>\n    <div class=\"change-area\">\n       <h3 class=\"heading heading-3 header-scroll\" align=\"\">\n        <div class=\"heading-anchor anchor waypoint\" id=\"update-to-the-breaking-change-in-products-endpoint-and-webhook\"></div>\n        <div class=\"heading-text\"><div id=\"update-to-the-breaking-change-in-products-endpoint-and-webhook\" class=\"heading-anchor_backwardsCompatibility\">\n          </div>Update to the breaking change in Products endpoint and webhook</div>\n        <a aria-label=\"Skip link to Update to the breaking change in Products endpoint and webhook\" class=\"heading-anchor-icon fa fa-anchor\" \n           href=\"#update-to-the-breaking-change-in-products-endpoint-and-webhook\"></a></h3>\n      \n    <p>Regarding the <a href=\"/changelog/post/breaking-change-in-products-endpoint-and-webhook\">breaking change in Products endpoint and webhook</a> we communicated on September 24, 2021, \n      we will be updating the response schema of the <code><a href=\"https://developers.pipedrive.com/docs/api/v1/Products#updateProduct\" target=\"_self\">PUT /v1/products/{id}</a></code> \n      endpoint and the response payload of the <code>updated.product</code> webhook.\n      The updated structure follows a consistent pattern and is unified with the responses of the Products endpoint.\n      </p>\n      \n\n      <p>The current response structure:\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-meta\">...</span>\n   <span class=\"cm-string\">“id”</span>: <span class=\"cm-number\">1</span>,\n   <span class=\"cm-string\">\"add_time\"</span>: <span class=\"cm-string\">\"2019-12-19 11:36:49\"</span>,\n   <span class=\"cm-string\">\"update_time\"</span>: <span class=\"cm-string\">\"2019-12-26 13:35:17\"</span>,\n   <span class=\"cm-property\">\"prices\"</span>:  {\n         <span class=\"cm-property\">\"EUR\"</span>: {\n            <span class=\"cm-property\">\"id\"</span>: <span class=\"cm-number\">1</span>,\n            <span class=\"cm-property\">\"product_id\"</span>: <span class=\"cm-number\">1</span>,\n            <span class=\"cm-property\">\"price\"</span>: <span class=\"cm-number\">5</span>,\n            <span class=\"cm-property\">\"currency\"</span>: <span class=\"cm-string\">\"EUR\"</span>,\n            <span class=\"cm-property\">\"cost\"</span>: <span class=\"cm-number\">2</span>,\n            <span class=\"cm-property\">\"overhead_cost\"</span>: <span class=\"cm-number\">3</span>\n          }\n    }\n   <span class=\"cm-meta\">...</span>\n};\n</div></code></pre></div></div>\n</p> \n  \n        <p>The updated response structure:\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-meta\">...</span>\n   <span class=\"cm-string\">“id”</span>: <span class=\"cm-number\">123</span>,\n   <span class=\"cm-string\">“add_time”</span>: <span class=\"cm-string\">\"2019-12-19 11:36:49\"</span>,\n   <span class=\"cm-string\">“update_time”</span>: <span class=\"cm-string\">\"2019-12-26 13:35:17\"</span>,\n   <span class=\"cm-property\">“prices”</span>: [\n      {\n         <span class=\"cm-property\">“id”</span>: <span class=\"cm-number\">1</span>,\n         <span class=\"cm-property\">“product_id”</span>: <span class=\"cm-number\">123</span>,\n         <span class=\"cm-property\">“price”</span>: <span class=\"cm-number\">5</span>,\n         <span class=\"cm-property\">“currency”</span>: <span class=\"cm-string\">\"EUR\"</span>,\n         <span class=\"cm-property\">“cost”</span>: <span class=\"cm-number\">2</span>,\n         <span class=\"cm-property\">“overhead_cost”</span>: <span class=\"cm-number\">3</span>,\n      },\n   ],\n   <span class=\"cm-meta\">...</span>\n};\n</div></code></pre></div></div>\n</p> \n\n<p>The updated response structure ensures consistency with the <code><a href=\"https://developers.pipedrive.com/docs/api/v1/Products#addProduct\" target=\"_self\">POST /v1/products</a></code> endpoint. The prices property is now represented in the same way - as an array of price objects.\n          \n       <br>\n      <p class=\"published-on\"><i>Published on December 8, 2021</i></p>\n  </div>\n</div>"
}
[/block]

Update to the breaking change in Products endpoint and Webhook

[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 22, 2021</span>\n    </div>\n    <div class=\"change-area\">\n       \n      \n      <p><b>What is changing?</b></p>\n      <p>In order to protect ourselves from online attacks, \n        users abusing our system by not respecting our <a href=\"https://pipedrive.readme.io/docs/core-api-concepts-rate-limiting\">rate limits</a> and keeping up \n        the high volume of traffic despite getting the <code>429</code> response code, \n        will also start getting the <code>403</code> response code. When getting the <code>403</code> response code, \n        the answer will be an HTML error page informing the user that one’s access has been denied:</p>\n\n  <span aria-label=\"\" class=\"img\" role=\"button\" tabindex=\"0\">\n    <img src=\"https://files.readme.io/4818f6b-Ratelimiting.png\" alt=\"\" title=\"Ratelimiting.png\" class=\"\" align=\"\" caption=\"\" height=\"auto\" width=\"auto\">\n    <span autofocus=\"\" class=\"lightbox\" role=\"dialog\" tabindex=\"0\">\n      <span class=\"lightbox-inner\">\n      \n      <img src=\"https://files.readme.io/4818f6b-Ratelimiting.png\" title=\"Click to close...\" class=\"lightbox-img\" align=\"\" caption=\"\" height=\"auto\" >\n    </span>\n      </span>\n      \n  <p><b>Why is it changing?</b></p>\n      <p>This <a href=\"https://pipedrive.readme.io/docs/core-api-concepts-rate-limiting#blocking-high-volume-traffic\">improvement</a> is designed to prevent undesired loads on our systems \n    from misconfigured API integrations or abuse. Our goal is to protect the \n    Pipedrive infrastructure and make our service more reliable to users not \n    busing our system.\n</p>\n  \n  <p><b>Who is affected?</b></p>\n      <p>\nPlease note that this improvement will not impact the vast majority of users, \n        even if there is heavy usage of our API. If you are impacted by this, \n        please review your integration and remove any misconfiguration that might \n        lead you to be blocked.\n</p>  \n  </div>\n</div>"
}
[/block]

{"product": ["API"], "features": ["Rate limiting"]}

Blocking high volume traffic

[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\">January 26, 2022</span>\n    </div>\n    <div class=\"change-area\">\n       <h3 class=\"heading heading-3 header-scroll\" align=\"\">\n        <div class=\"heading-anchor anchor waypoint\" id=\"removal-of-follower-count-updates-in-webhooks\"></div>\n        <div class=\"heading-text\"><div id=\"removal-of-follower-count-updates-in-webhooks\" class=\"heading-anchor_backwardsCompatibility\">\n          </div>Removal of  <code>follower_count</code> updates in Webhooks</div>\n        <a aria-label=\"Skip link to Removal of follower_count updates in Webhooks\" class=\"heading-anchor-icon fa fa-anchor\" \n           href=\"#removal-of-follower-count-updates-in-webhooks\"></a></h3>\n      \n      <p><b>What is changing?</b></p>\n      <p>The following types of Webhooks will no longer be triggered when a follower is added or removed:</p>\n   <p>   <ul><ul>\n<li><code>updated.deal</code></li>\n<li><code>updated.person</code></li>\n<li><code>updated.organization</code></li>\n<li><code>updated.product</code></li>\n      </ul></p></ul>\n  <p>Previously, when a follower was added or removed, a webhook was triggered with new <code>update_time</code> and <code>follower_count</code> values for the entity.</p>\n  \n  <p><b>Why is it changing?</b></p>\n  <p>The logic that handles <code>follower_count</code> was built on an old technological platform that is not reliable enough, \n  which resulted in webhooks not triggering and <code>follower_count</code> values being incorrect.\n  We’re doing this change to enable moving to a more reliable platform.</p>\n  \n  <p><b>Who is affected?</b></p>\n  <p>Anyone who relies on active Webhooks that are triggered when a follower is added or removed from the previous 4 Webhooks.</p>\n  \n  <p class=\"published-on\"><i>Published on December 6, 2021</i></p>\n  </div>\n</div>"
}
[/block]

Removal of <code>follower_count</code> updates in Webhooks

[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 30, 2021</span>\n    </div>\n    <div class=\"change-area\">\n       <h3 class=\"heading heading-3 header-scroll\" align=\"\">\n        <div class=\"heading-anchor anchor waypoint\" id=\"documentation-updates-for-api-reference-nov-21\"></div>\n        <div class=\"heading-text\"><div id=\"documentation-updates-for-api-reference-nov-21\" class=\"heading-anchor_backwardsCompatibility\">\n          </div>Documentation updates for API Reference</div>\n        <a aria-label=\"Skip link to Documentation updates for API Reference\" class=\"heading-anchor-icon fa fa-anchor\" \n           href=\"#documentation-updates-for-api-reference-nov-21\"></a></h3>\n      \n     <p>Here are the most recent updates to our <a href=\"https://developers.pipedrive.com/docs/api/v1/\">API Reference page</a>:\n      </p>\n      <p><b>1.</b> We added the <code>start</code> and <code>limit</code> query parameters for the following 4 endpoints so you can control pagination better:</p>\n   <p>   <ul><ul>\n<li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/DealFields#getDealFields\" target=\"_self\">GET /v1/dealFields</a></code></li>\n<li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/OrganizationFields#getOrganizationFields\" target=\"_self\">GET /v1/organizationFields</a></code></li>\n<li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/PersonFields#getPersonFields\" target=\"_self\">GET /v1/personFields</a></code></li>\n<li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/ProductFields#getProductFields\" target=\"_self\">GET /v1/productFields</a></code></li>\n      </ul></p></ul>\n        <p><b>2.</b> We updated the <code>subscription_url</code> body parameter for the\n<code><a href=\"https://developers.pipedrive.com/docs/api/v1/Webhooks#addWebhook\" target=\"_self\">POST /v1/webhooks</a></code>\n          endpoint to reflect the <a href=\"https://pipedrive.readme.io/docs/changelog#removal-of-webhooks-redirection-support\" target=\"_self\">removal of the Webhooks redirection support</a>.</p>\n  <p><b>3.</b> Duplicate <code>name</code> and <code>options</code> body parameters were removed from the\n<code><a href=\"https://developers.pipedrive.com/docs/api/v1/ProductFields#addProductField\" target=\"_self\">POST /v1/productFields</a></code> endpoint.</p>\n    <p><b>4.</b> We documented the <code>ids</code> query parameter for the\n<code><a href=\"https://developers.pipedrive.com/docs/api/v1/Products#getProducts\" target=\"_self\">GET /v1/products</a></code>\n      endpoint. You can now specify an array of integers with the IDs of the Products that should be returned in the response.</p>\n<p><b>5.</b> The response status code for the following endpoints has been updated from <code>200</code> “OK” to  <code>201</code> “Created” to reflect reality:</p>\n   <p>   <ul><ul>\n<li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/ProductFields#addProductField\" target=\"_self\">POST /v1/productFields</a></code></li>\n<li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Products#addProductFollower\" target=\"_self\">POST /v1/products/{id}/followers</a></code></li>\n<li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Products#addProduct\" target=\"_self\">POST /v1/products</a></code></li>\n      </ul></p></ul>\n    <p><b>6.</b> We updated the <code><a href=\"https://developers.pipedrive.com/docs/api/v1/Products#getProductFollowers\" target=\"_self\">GET /v1/products/{id}/followers</a></code>\n       endpoint response schema so that the <code>data</code> property is a ProductFollower object.\n      Previously, the <code>data</code> property was an array of user IDs.</p>\n<p>Here’s the code example of the improved response in JSON:\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\">true</span>,\n<span class=\"cm-property\">\"data\"</span>: [ <span class=\"cm-variable\">…</span> ]\n   { <span class=\"cm-variable\">…</span> }\n   <span class=\"cm-string\">\"user_id\"</span>: <span class=\"cm-number\">123</span>,\n   <span class=\"cm-string\">\"id\"</span>: <span class=\"cm-number\">456</span>,\n   <span class=\"cm-string\">\"product_id\"</span>: <span class=\"cm-number\">789</span>,\n   <span class=\"cm-string\">\"add_time\"</span>: <span class=\"cm-string\">\"2021-08-03 12:07:05\"</span>\n   <span class=\"cm-string\">\"additional_data\"</span>: { <span class=\"cm-property\">…</span> }\n   <span class=\"cm-string\">\"pagination\"</span>: { <span class=\"cm-property\">…</span> }\n     <span class=\"cm-string\">\"start\"</span>: <span class=\"cm-number\">0</span>,\n     <span class=\"cm-string\">\"limit\"</span>: <span class=\"cm-number\">100</span>,\n     <span class=\"cm-string\">\"more_items_in_collection\"</span>: <span class=\"cm-atom\">false</span>\n}\n</div></code></pre></div></div>\n</p>      \n\n          \n       <br>\n      <p class=\"published-on\"><i>Published on November 30, 2021</i></p>\n  </div>\n</div>"
}
[/block]

[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 30, 2021</span>\n    </div>\n    <div class=\"change-area\">\n       <h3 class=\"heading heading-3 header-scroll\" align=\"\">\n        <div class=\"heading-anchor anchor waypoint\" id=\"documentation-updates-for-api-reference-nov-21\"></div>\n        <div class=\"heading-text\"><div id=\"documentation-updates-for-api-reference-nov-21\" class=\"heading-anchor_backwardsCompatibility\">\n          </div>Documentation updates for API Reference</div>\n        <a aria-label=\"Skip link to Documentation updates for API Reference\" class=\"heading-anchor-icon fa fa-anchor\" \n           href=\"#documentation-updates-for-api-reference-nov-21\"></a></h3>\n      \n     <p>Here are the most recent updates to our <a href=\"https://developers.pipedrive.com/docs/api/v1/\">API Reference page</a>:\n      </p>\n      <p><b>1.</b> We added the <code>start</code> and <code>limit</code> query parameters for the following 4 endpoints so you can control pagination better:</p>\n   <p>   <ul><ul>\n<li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/DealFields#getDealFields\" target=\"_self\">GET /v1/dealFields</a></code></li>\n<li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/OrganizationFields#getOrganizationFields\" target=\"_self\">GET /v1/organizationFields</a></code></li>\n<li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/PersonFields#getPersonFields\" target=\"_self\">GET /v1/personFields</a></code></li>\n<li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/ProductFields#getProductFields\" target=\"_self\">GET /v1/productFields</a></code></li>\n      </ul></p></ul>\n        <p><b>2.</b> We updated the <code>subscription_url</code> body parameter for the\n<code><a href=\"https://developers.pipedrive.com/docs/api/v1/Webhooks#addWebhook\" target=\"_self\">POST /v1/webhooks</a></code>\n          endpoint to reflect the <a href=\"/changelog/post/removal-of-webhooks-redirection-support\" target=\"_self\">removal of the Webhooks redirection support</a>.</p>\n  <p><b>3.</b> Duplicate <code>name</code> and <code>options</code> body parameters were removed from the\n<code><a href=\"https://developers.pipedrive.com/docs/api/v1/ProductFields#addProductField\" target=\"_self\">POST /v1/productFields</a></code> endpoint.</p>\n    <p><b>4.</b> We documented the <code>ids</code> query parameter for the\n<code><a href=\"https://developers.pipedrive.com/docs/api/v1/Products#getProducts\" target=\"_self\">GET /v1/products</a></code>\n      endpoint. You can now specify an array of integers with the IDs of the Products that should be returned in the response.</p>\n<p><b>5.</b> The response status code for the following endpoints has been updated from <code>200</code> “OK” to  <code>201</code> “Created” to reflect reality:</p>\n   <p>   <ul><ul>\n<li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/ProductFields#addProductField\" target=\"_self\">POST /v1/productFields</a></code></li>\n<li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Products#addProductFollower\" target=\"_self\">POST /v1/products/{id}/followers</a></code></li>\n<li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Products#addProduct\" target=\"_self\">POST /v1/products</a></code></li>\n      </ul></p></ul>\n    <p><b>6.</b> We updated the <code><a href=\"https://developers.pipedrive.com/docs/api/v1/Products#getProductFollowers\" target=\"_self\">GET /v1/products/{id}/followers</a></code>\n       endpoint response schema so that the <code>data</code> property is a ProductFollower object.\n      Previously, the <code>data</code> property was an array of user IDs.</p>\n<p>Here’s the code example of the improved response in JSON:\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\">true</span>,\n<span class=\"cm-property\">\"data\"</span>: [ <span class=\"cm-variable\">…</span> ]\n   { <span class=\"cm-variable\">…</span> }\n   <span class=\"cm-string\">\"user_id\"</span>: <span class=\"cm-number\">123</span>,\n   <span class=\"cm-string\">\"id\"</span>: <span class=\"cm-number\">456</span>,\n   <span class=\"cm-string\">\"product_id\"</span>: <span class=\"cm-number\">789</span>,\n   <span class=\"cm-string\">\"add_time\"</span>: <span class=\"cm-string\">\"2021-08-03 12:07:05\"</span>\n   <span class=\"cm-string\">\"additional_data\"</span>: { <span class=\"cm-property\">…</span> }\n   <span class=\"cm-string\">\"pagination\"</span>: { <span class=\"cm-property\">…</span> }\n     <span class=\"cm-string\">\"start\"</span>: <span class=\"cm-number\">0</span>,\n     <span class=\"cm-string\">\"limit\"</span>: <span class=\"cm-number\">100</span>,\n     <span class=\"cm-string\">\"more_items_in_collection\"</span>: <span class=\"cm-atom\">false</span>\n}\n</div></code></pre></div></div>\n</p>      \n\n          \n       <br>\n      <p class=\"published-on\"><i>Published on November 30, 2021</i></p>\n  </div>\n</div>"
}
[/block]

[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\">January 27, 2022</span>\n    </div>\n    <div class=\"change-area\">\n      \n      <h3 class=\"heading heading-2 header-scroll\" align=\"\">\n        <div class=\"heading-anchor anchor waypoint\" id=\"removal-of-webhooks-redirection-support\"></div>\n        <div class=\"heading-text\"><div id=\"removal-of-webhooks-redirection-support\" class=\"heading-anchor_backwardsCompatibility\">\n          </div>Removal of Webhooks redirection support</div>\n        <a aria-label=\"Skip link to Removal of webhooks redirection support\" class=\"heading-anchor-icon fa fa-anchor\" \n           href=\"#removal-of-webhooks-redirection-support\"></a></h3>\n  \n      <p><b>What is changing?</b></p>\n\n<p>We are increasing the security of our Webhooks to provide more established and secure connections for our customers and partners.\n  In order to eliminate the possibility for Webhook interceptions and unknown redirections to unauthorized destinations, we will be removing the support of webhooks using indirect URLs that redirect to another URL.</p>\n\n      <p>Starting from <b>January 27, 2022</b>, we will begin to block webhooks that use indirect URL values for the webhook’s <code>subcription_url</code> if it redirects to another destination.</p>\n\n<p><b>Who is affected?</b></p>\n<p>Anyone who relies on active Webhooks with an indirect URL set as the <code>subscription_url</code> value.</p>\n\n      <p>If you have any questions or comments, let us know in <a href=\"https://devcommunity.pipedrive.com/t/removal-of-webhooks-redirection-support/4769\" target=\"_self\">the Developer’s Community</a>.</p>\n      \n      \n         <p class=\"published-on\"><i>Published on October 28, 2021</i></p>\n  </div>\n</div>"
}
[/block]

Removal of Webhooks redirection support

[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 1, 2021</span>\n    </div>\n    <div class=\"change-area\">\n          <h3 class=\"heading heading-3 header-scroll\" align=\"\">\n        <div class=\"heading-anchor anchor waypoint\" id=\"change-in-the-response-data-of-get-/activityFields-endpoint\"></div>\n        <div class=\"heading-text\"><div id=\"change-in-the-response-data-of-get-/activityFields-endpoint\" class=\"heading-anchor_backwardsCompatibility\">\n          </div>Change in the response data of GET /activityFields endpoint</div>\n        <a aria-label=\"Skip link to Change in the response data of GET /activityFields endpoint\" class=\"heading-anchor-icon fa fa-anchor\" \n           href=\"#change-in-the-response-data-of-get-/activityFields-endpoint\"></a></h3>\n     \n      <p><b>What has changed?</b></p>\n      \n     <p> The response of \n<code> <a href=\"https://developers.pipedrive.com/docs/api/v1/ActivityFields#getActivityFields\"  target=\"_self\">GET /activityFields</a></code> will now include fields with following data\n       <code>\"key\": \"lead_id\"</code> and <code>\"field_type\": \"lead\"</code> instead of <code>\"key\": \"lead_title\"</code> and <code>\"field_type\": \"varchar\"</code>. </p>\n \n       <p>Updated example of response structure for the object:</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-meta\">...</span>\n            <span class=\"cm-string\">\"key\"</span>: <span class=\"cm-string\">\"lead_id\"</span>,\n            <span class=\"cm-property\">\"name\"</span>: <span class=\"cm-string\">\"Lead\"</span>,\n            <span class=\"cm-property\">\"order_nr\"</span>: <span class=\"cm-number\">21</span>,\n            <span class=\"cm-property\">\"picklist_data\"</span>: <span class=\"cm-atom\">null</span>,\n            <span class=\"cm-property\">\"field_type\"</span>: <span class=\"cm-string\">\"lead\"</span>,\n            <span class=\"cm-property\">\"json_column_flag\"</span>: <span class=\"cm-atom\">false</span>,\n            <span class=\"cm-property\">\"add_time\"</span>: <span class=\"cm-string\">\"2019-12-15 12:10:23\"</span>,\n            <span class=\"cm-property\">\"update_time\"</span>: <span class=\"cm-string\">\"2019-12-15 12:10:23\"</span>,\n<span class=\"cm-property\">…</span>\n}\n</div></code></pre></div></div>\n      \n      \n      <p><b>Why was it changed?</b></p>\n      <p>This change was done to unify the information returned by the API to \n        make the response more consistent and clearer for data usage about Leads in Activity fields.</p> \n\n<p>To get data about the lead linked to an Activity, you can use the <code> <a href=\"https://developers.pipedrive.com/docs/api/v1/Leads#getLead\"  target=\"_self\">GET /leads/{id}</a></code> endpoint.\n\n</p>\n      \n      \n         <p class=\"published-on\"><i>Published on October 6, 2021</i></p>\n  </div>\n</div>"
}
[/block]

{"product": ["API"], "features": ["ActivityFields"]}

Change in the response data of <code>GET /activityFields</code> endpoint

[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 22, 2021</span>\n    </div>\n    <div class=\"change-area\">\n        <h3 class=\"heading heading-3 header-scroll\" align=\"\">\n        <div class=\"heading-anchor anchor waypoint\" id=\"breaking-change-in-products-endpoint-and-webhook\"></div>\n        <div class=\"heading-text\"><div id=\"breaking-change-in-products-endpoint-and-webhook\" class=\"heading-anchor_backwardsCompatibility\">\n          </div>Breaking change in Products endpoint and Webhook</div>\n        <a aria-label=\"Skip link to Breaking change in Products endpoint and Webhook\" class=\"heading-anchor-icon fa fa-anchor\" \n           href=\"#breaking-change-in-products-endpoint-and-webhook\"></a></h3>\n      \n         \n      <p><b>What is going to change?</b></p>\n      \n   <p>   The response structure to <code> <a href=\"https://developers.pipedrive.com/docs/api/v1/Products#updateProduct\"  target=\"_self\">PUT v1/products/{id}</a></code> <code>prices</code> property will change.\n     The <code>prices</code> property will be sent as an array of objects instead of an object.\n     This change will also impact the webhook <b><code>updated.product</code></b> response payload as \n     its response structure will change in the same way as the endpoint. </p>\n      \n      <p>Response structure before</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-meta\">...</span>\n            <span class=\"cm-string\">\"key\"</span>: <span class=\"cm-string\">\"lead_id\"</span>,\n            <span class=\"cm-property\">\"name\"</span>: <span class=\"cm-string\">\"Lead\"</span>,\n            <span class=\"cm-property\">\"order_nr\"</span>: <span class=\"cm-number\">21</span>,\n            <span class=\"cm-property\">\"picklist_data\"</span>: <span class=\"cm-atom\">null</span>,\n            <span class=\"cm-property\">\"field_type\"</span>: <span class=\"cm-string\">\"lead\"</span>,\n            <span class=\"cm-property\">\"json_column_flag\"</span>: <span class=\"cm-atom\">false</span>,\n            <span class=\"cm-property\">\"add_time\"</span>: <span class=\"cm-string\">\"2019-12-15 12:10:23\"</span>,\n            <span class=\"cm-property\">\"update_time\"</span>: <span class=\"cm-string\">\"2019-12-15 12:10:23\"</span>,\n<span class=\"cm-property\">…</span>\n}\n</div></code></pre></div></div>\n      \n    <p>Response structure after</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\"><span class=\"cm-meta\">...</span>\n<span class=\"cm-string\">\"add_time\"</span>: <span class=\"cm-string\">\"2019-12-19 11:36:49\"</span>,\n<span class=\"cm-string\">\"update_time\"</span>: <span class=\"cm-string\">\"2019-12-26 13:35:17\"</span>,\n<span class=\"cm-string\">\"prices\"</span>: [{\n  <span class=\"cm-property\">\"EUR\"</span>: {\n   <span class=\"cm-property\">\"id\"</span>: <span class=\"cm-number\">1</span>,\n   <span class=\"cm-property\">\"product_id\"</span>: <span class=\"cm-number\">1</span>,\n   <span class=\"cm-property\">\"price\"</span>: <span class=\"cm-number\">5</span>,\n   <span class=\"cm-property\">\"currency\"</span>: <span class=\"cm-string\">\"EUR\"</span>,\n   <span class=\"cm-property\">\"cost\"</span>: <span class=\"cm-number\">2</span>,\n   <span class=\"cm-property\">\"overhead_cost\"</span>: <span class=\"cm-number\">3</span>\n  }\n ]\n}\n<span class=\"cm-meta\">...</span>\n</div></code></pre></div></div>\n      \n      <p><b> Why is it going to change? </b></p>\n<p>This is done to increase the overall consistency of all Products endpoints and webhooks to align with best practices.</p>\n\n <p><b>Who is affected? </b></p>\n<p><ul> <li>API consumers who strictly check the response structure of the <code><a href=\"https://developers.pipedrive.com/docs/api/v1/Products#updateProduct\"  target=\"_self\">PUT v1/products/{id}</a></code> endpoint.</li>\n<li>Apps or users who either check themselves or use a tool to check the payload structure of <code>updated.products</code> webhook.</li></ul> </p>\n\n\n\n      <p class=\"published-on\"><i>Published on September 24, 2021</i></p>\n  </div>\n</div>"
}
[/block]

Breaking change in Products endpoint and Webhook

[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 20, 2021</span>\n    </div>\n    <div class=\"change-area\">\n       <h3 class=\"heading heading-3 header-scroll\" align=\"\">\n        <div class=\"heading-anchor anchor waypoint\" id=\"change-in-file-download-URLs-for-5-endpoints\"></div>\n        <div class=\"heading-text\"><div id=\"change-in-file-download-URLs-for-5-endpoints\" class=\"heading-anchor_backwardsCompatibility\">\n          </div>Change in file download URLs for 5 endpoints</div>\n        <a aria-label=\"Skip link to Change in file download URLs for 5 endpoints\" class=\"heading-anchor-icon fa fa-anchor\" \n           href=\"#change-in-file-download-URLs-for-5-endpoints\"></a></h3>\n      \n      <p><b>What is going to change?</b></p>\n      <p>\n        The <code>URL</code> value when downloading public files for the following 5 endpoints will now contain generic API download links instead of direct temporary links:\n         <ul>\n<li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Activities#getActivities\" target=\"_self\">GET /v1/activities</a></code></li>\n<li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Activities#getActivity\" target=\"_self\">GET /v1/activities/{id}</a></code></li>\n<li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#getDealUpdates\" target=\"_self\">GET /v1/deals/{id}/flow</a></code></li>\n<li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Organizations#getOrganizationUpdates\" target=\"_self\">GET /v1/organizations/{id}/flow</a></code></li>\n<li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Persons#getPersonUpdates\" target=\"_self\">GET /v1/persons/{id}/flow</a></code></li>\n      </ul>\n      </p>\n  <p>\n    The download links will be the same as the ones given out by the <code><a href=\"https://developers.pipedrive.com/docs/api/v1/Files#getFiles\">GET /v1/files</a></code> endpoint. \n  </p>\n            <p><b>Who is affected?</b></p>\n    <p>Anyone who uses any of the 5 endpoints listed above to download public files. You will now have to use your authentication headers or an <code>api_token</code> to download files from these endpoints.\n  </p>\n      <p class=\"published-on\"><i>Published on September 20, 2021</i></p>\n  </div>\n</div>"
}
[/block]

{"product": ["API"], "features": ["Activities", "Persons", "Deals", "Organizations"]}

Contents

Changelog

Announced changes

Subscribe to our Changelog

Subscribe to our Changelog

Subscribe to our
Changelog