[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\">May 9, 2023</span>\n    </div>\n    <div class=\"change-area\">\n\t\t\t<p>To ensure a smooth and stable experience for your app’s users, we’ve enhanced the app updating process for publicly available apps in Developer Hub.</p>\n\t\t\t<p><img src=\"https://files.readme.io/dca6901-small-Developer_Hub_-_approved_app_-_merge_changes_-_three-dot_menu.png\"></img></p>    \n    \t<p>When you change/edit <a href=\"https://pipedrive.readme.io/docs/marketplace-updating-the-existing-app#critical-and-non-critical-fields\" target=\"blank\">critical fields</a>, a private copy of your app will be created to ensure continuous stability for your app’s customers. These changes must then go through the approval process to ensure everything works correctly.</p>\n  \t\t<p>Get all the details in our documentation about <a href=\"https://pipedrive.readme.io/docs/marketplace-updating-the-existing-app\" target=\"blank\">updating approved apps</a>.</p>\n      </div>\n</div>"
}
[/block]

To ensure a smooth and stable experience for your app's users, we've enhanced the process of updating your app in Developer Hub.

Enhanced flow for updating your app in Developer Hub

[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\">May 19, 2023</span>\n    </div>\n    <div class=\"change-area\">\n      \n      <p>We have improved the validation for products and deal-products endpoints to ensure that the API behavior works as explained in our API Reference for a consistent and reliable experience.</p>\n      \n      <b><p>We kindly ask you to review the documentation for <a href=\"https://developers.pipedrive.com/docs/api/v1/Products\">Products API</a> and <a href=\"https://developers.pipedrive.com/docs/api/v1/Deals\">deal-products endpoints</a> and update your API consumption logic if necessary.</p></b>\n      \n      <p>We will be providing a 30-day window for reviewing the following logic for products and deal-products endpoints:</p>\n      \n      <b><h3>1. Getting the list of products attached to a deal</h3></b>\n      <p>For the <code><a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#getDealProducts\">GET /deals/{id}/products</a></code> endpoint, the <code>include_product_data</code> query parameter only supports numerical values 1 and 0:</p>\n      <ul>\n        <li>1 – for retrieving the product data along with each attached product</li>\n        <li>0 – for not retrieving the product data. This is the default value for the parameter</li>\n      </ul>\n      \n      <br>\n      <b><h3>2. Adding and updating products</h3></b>\n      \n      <p>For the <code><a href=\"https://developers.pipedrive.com/docs/api/v1/Products#addProduct\">POST /products</a></code> and <code><a href=\"https://developers.pipedrive.com/docs/api/v1/Products#updateProduct\">PUT /products/{id}</a></code> endpoints, the <code>prices</code> body parameter needs to be supplied as an array of objects containing:</p>\n      <ul>\n        <li><code>currency</code> (string) - a required field</li>\n        <li><code>price</code> (number) – a required field</li>\n        <li><code>cost</code> (number) – optional</li>\n        <li><code>overhead_cost</code> (number) – optional</li>\n      </ul>\n      <br>\n      <p>Please note that there can only be one price per product per currency. When the <code>prices</code> parameter is omitted altogether, a default price of 0 and a default currency based on the company’s currency will be assigned.</p>\n      \n      <p>Here’s an example of a PUT payload where one product price (<code>\"id\": 10</code>) is being updated and another price is being created:</p>\n      <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-json theme-light\" data-lang=\"json\" name=\"json\"><div class=\"cm-s-neo\">{\n  <span class=\"cm-property\">\"name\"</span>: <span class=\"cm-string\">\"My product\"</span>,\n  <span class=\"cm-property\">\"prices\"</span>: [\n     {\n         <span class=\"cm-property\">\"id\"</span>: <span class=\"cm-number\">10</span>,\n         <span class=\"cm-property\">\"currency\"</span>: <span class=\"cm-string\">\"EUR\"</span>,\n         <span class=\"cm-property\">\"price\"</span>: <span class=\"cm-number\">20</span>,\n         <span class=\"cm-property\">\"cost\"</span>: <span class=\"cm-number\">2</span>\n     },\n     {\n         <span class=\"cm-property\">\"currency\"</span>: <span class=\"cm-string\">\"USD\"</span>,\n         <span class=\"cm-property\">\"price\"</span>: <span class=\"cm-number\">15</span>,\n         <span class=\"cm-property\">\"cost\"</span>: <span class=\"cm-number\">8</span>\n     }\n   ]\n}\n</div></code></pre></div></div>\n      \n      <br>\n      <b><h3>3. Adding and updating deal-products</h3></b>\n      \n      <p>For the <code><a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#addDealProduct\">POST /deals/{id}/products</a></code> and <code><a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#updateDealProduct\">PUT /deals/{id}/products/{product_attachment_id}</a></code> endpoints, the required body parameters and their data types are as follows:</p>\n      <ul>\n        <li><code>product_id</code> (integer)</li>\n        <li><code>item_price</code> (number)</li>\n        <li><code>quantity</code> (integer)</li>\n      </ul>\n      \n      <br>\n      <p>The optional body parameters and their data types are:</p>\n      <ul>\n        <li><code>discount_percentage</code> (number) – If omitted, the default value is 0</li>\n        <li><code>duration</code> (number) – If omitted, the default value is 1</li>\n      </ul>\n      \n      <br>\n      <p>For the full list of optional parameters, please refer to the documentation of the POST and PUT endpoints.</p>\n \n      <p>If you have any questions or comments, let us know in <a href=\"https://devcommunity.pipedrive.com/\">the Developer’s Community</a>.</p>\n      \n    \n      </div>\n</div>"
}
[/block]

We have improved the validation for products and deal-products endpoints to ensure a consistent and reliable experience as documented in our API Reference. We kindly ask you to review the documentation for Products API and deal-products endpoints and update your API consumption logic if necessary.

Improved validation for products and deal-products endpoints

[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\">April 4, 2023</span>\n    </div>\n    <div class=\"change-area\">\n      \n      <p>1. Two new endpoints related to the <a href=\"https://support.pipedrive.com/en/article/pipeline-visibility\">pipeline visibility feature</a> are now available:</p>\n      <ul>\n        <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Roles#getRolePipelines\">GET /roles/{id}/pipelines</a></code> - returns the list of either visible or hidden pipeline IDs for a specific role</li>\n        <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Roles#updateRolePipelines\">PUT /roles/{id}/pipelines</a></code> - updates the specified pipelines to be visible and/or hidden for a specific role</li>\n      </ul>\n     \n      <p>These endpoints can be accessed by apps with the <code>admin</code> <a href=\"https://pipedrive.readme.io/docs/marketplace-scopes-and-permissions-explanations\">OAuth scope</a>.</p>\n      \n       </div>\n</div>"
}
[/block]

The latest updates to our API include new GET and PUT endpoints related to pipeline visibility - <code>GET /roles/{id}/pipelines</code> and <code>PUT /roles/{id}/pipelines</code>.

March 2023 release notes

[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\">April 3, 2023</span>\n    </div>\n    <div class=\"change-area\">\n      \n      <p>We are introducing <b>ownership permissions</b> inside the <a href=\"https://support.pipedrive.com/en/article/permission-sets\">Permission sets feature</a> in our web app and API to allow or disable changing the item’s owner for the main entities (activities, deals, leads, organizations, persons, and products).</p>\n      \n      <b><h3>What is changing?</h3></b>\n      <p>We will be rolling the feature out to all companies between April 3 and April 12, 2023.</p>\n      \n      <b><p>By default, nothing will be changed in the API behavior.</b></p>\n  \n  <p>When the permission for changing the owner of an entity is disabled for the user making the API request and the user is not a current owner of the entity, the following errors will be thrown:</p>\n  \n  <b><p>1. Activities API</p></b>\n  <p>For the <code><a href=\"https://developers.pipedrive.com/docs/api/v1/Activities#updateActivity\">PUT /activities/{id}</a></code> endpoint, updating the <code>user_id</code> of an activity will throw a <code>403</code> error.</p>\n  <br>\n  <b><p>2. Deals API</p></b>\n  <p>For the <code><a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#updateDeal\">PUT /deals/{id}</a></code> endpoint, updating the <code>user_id</code> of a deal will throw a <code>403</code> error.</p>\n  <br>\n  <b><p>3. Leads API</p></b>\n  <p>For the <code><a href=\"https://developers.pipedrive.com/docs/api/v1/Leads#updateLead\">PATCH /leads/{id}</a></code> endpoint, updating the <code>owner_id</code> of a lead will throw a <code>403</code> error.</p>\n  <br>\n  <b><p>4. Persons API</p></b>\n  <p>For the <code><a href=\"https://developers.pipedrive.com/docs/api/v1/Persons#updatePerson\">PUT /persons/{id}</a></code> endpoint, updating the <code>owner_id</code> of a person will throw a <code>403</code> error.</p>\n  <br>\n  <b><p>5. Products API</p></b>\n  <p>For the <code><a href=\"https://developers.pipedrive.com/docs/api/v1/Products#updateProduct\">PUT /products/{id}</a></code> endpoint, updating the <code>owner_id</code> of a product will throw a <code>403</code> error.</p>\n  <br>\n  <b><p>6. Organizations API</p></b>\n  <p>For the <code><a href=\"https://developers.pipedrive.com/docs/api/v1/Organizations#updateOrganization\">PUT /organizations/{id}</a></code> endpoint, updating the <code>owner_id</code> of an organization will throw a <code>403</code> error.</p>\n  \n  <br>\n  <p>Here’s an example <code>403</code> error response:</p>\n  <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-json theme-light\" data-lang=\"json\" name=\"\"><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\">\"You do not have permission to change the owner.\"</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  <br>\n  <p>Please note that the Deals app and Global permissions admin users and the owners of an entity are always able to transfer the ownership of an entity to other users.</p>\n  \n  <br>\n  <b><h3>Where can I find the permissions for a user?</h3></b>\n  <p>The <code><a href=\"https://developers.pipedrive.com/docs/api/v1/Users#getUserPermissions\">GET /users/{id}/permissions</a></code> endpoint can be used to find the user’s permissions.</p>\n  \n  <p>The specified user has permission to update the owner of the entity if the following field(s) are present in the response:</p>\n  <ul>\n    <li>activities - the <code>can_modify_owner_for_activities</code> field</li>\n    <li>deals - the <code>can_modify_owner_for_deals</code> field</li>\n    <li>leads - the <code>can_modify_owner_for_leads</code> field</li>\n    <li>organizations - the <code>can_modify_owner_for_organizations</code> field</li>\n    <li>persons - the <code>can_modify_owner_for_people</code> field</li>\n    <li>products - the <code>can_modify_owner_for_products</code> field</li>\n  </ul>\n  <br>\n  <p>If you have any questions or comments, let us know in <a href=\"https://devcommunity.pipedrive.com/\">the Developer’s Community</a>.</p>\n\n      \n      </div>\n</div>"
}
[/block]

We are introducing the <b>ownership permission</b> inside the Permission sets feature in our web app and API to allow or disable changing the item’s owner for the main entities (activities, deals, leads, organizations, persons, and products).

Introducing a new permission: changing the owner of an entity

[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\">May 29, 2023</span>\n    </div>\n    <div class=\"change-area\">\n      \n      <b><p>What is changing?</p></b>\n\n      <b><p>1. <code>last_update_user_id</code> response field</b></p>\n      \n  <p>From <b>May 29, 2023</b>, the <code>last_update_user_id</code> field will only be included in the response of the <code><a href=\"https://developers.pipedrive.com/docs/api/v1/Notes#updateNote\">PUT /notes/{id}</a></code> endpoint if the <code>content</code> of the note was updated within the same request or has been updated previously.</p>\n      \n  <p><b>2. <code>update_time</code> field</p></b>\n  \n<p>From <b>May 29, 2023</b>, the <code>update_time</code> for a note will only be updated when the <code>content</code> of the note has been edited. </p>  \n\n<p>Updating other note fields (e.g. the <code>lead_id</code>, <code>deal_id</code>, or <code>org_id</code>) via the <code><a href=\"https://developers.pipedrive.com/docs/api/v1/Notes#updateNote\">PUT /notes/{id}</a></code> endpoint will not change the <code>update_time</code> for the note.</p>\n<br>\n      <p><b>Why is it changing?</b></p>\n\n<p>We are changing the behavior of the <code>last_update_user_id</code> and <code>update_time</code> fields for the <code>PUT</code> endpoint to ensure consistent behavior within the Notes API. </p>\n      \n      <p>If you have any questions or comments, let us know in <a href=\"https://devcommunity.pipedrive.com/\">the Developer’s Community</a>.</p>\n      \n       </div>\n</div>"
}
[/block]

We are introducing an update to the behavior of the <code>last_update_user_id</code> and <code>update_time</code> response fields for Notes API.

Breaking change: update to the behavior of 2 response fields for <code>PUT /notes/{id}</code>

[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\">March 21, 2023</span>\n    </div>\n    <div class=\"change-area\">\n      <p>We are introducing two new endpoints with cursor-based pagination for Activities and Deals API to give you an improved user experience when paging through large data sets:\n      <ul>\n        <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Activities#getActivitiesCollection\" target=\"blank\">GET /activities/collection</a></code> – for querying all activities</li>\n        <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#getDealsCollection\" target=\"blank\">GET /deals/collection</a></code> – for querying all deals</li>\n      </ul></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 (an opaque string value) 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<br>\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\t\t\t<br>\n<p><b>Note</b>: Only global admins (those with global permissions) can access these endpoints. Users with regular permissions will receive a 403 response. Read more about global permissions <a href=\"https://support.pipedrive.com/en/article/global-user-management\" target=\"blank\">here</a>.</p>\n<br>\n<p><b>Example response schema for the <code>GET /activities/collection</code> endpoint:</b></p>\n\t\t\t<div class=\"CodeTabs CodeTabs_initial theme-light\"><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-json theme-light\" data-lang=\"json\" name=\"\"><div class=\"cm-s-neo\">{\n  \t  <span class=\"cm-property\">\"success\"</span>: <span class=\"cm-atom\">true</span>,\n   \t  <span class=\"cm-property\">\"data\"</span>: [\n        {\n            <span class=\"cm-property\">\"id\"</span>: <span class=\"cm-number\">1</span>,\n            <span class=\"cm-property\">\"creator_user_id\"</span>: <span class=\"cm-number\">42</span>,\n            <span class=\"cm-property\">\"user_id\"</span>: <span class=\"cm-number\">42</span>,\n            <span class=\"cm-property\">\"person_id\"</span>: <span class=\"cm-number\">47</span>,\n            <span class=\"cm-property\">\"org_id\"</span>: <span class=\"cm-number\">42</span>,\n            <span class=\"cm-property\">\"stage_id\"</span>: <span class=\"cm-number\">1</span>,\n            <span class=\"cm-property\">\"title\"</span>: <span class=\"cm-string\">\"New name for a great deal\"</span>,\n            <span class=\"cm-property\">\"value\"</span>: <span class=\"cm-number\">1000000</span>,\n            <span class=\"cm-property\">\"currency\"</span>: <span class=\"cm-string\">\"EUR\"</span>,\n            <span class=\"cm-property\">\"add_time\"</span>: <span class=\"cm-string\">\"2022-01-04 10:44:11\"</span>,\n            <span class=\"cm-property\">\"update_time\"</span>: <span class=\"cm-string\">\"2022-09-27 13:21:10\"</span>,\n            <span class=\"cm-property\">\"status\"</span>: <span class=\"cm-string\">\"open\"</span>,\n            <span class=\"cm-property\">\"probability\"</span>: <span class=\"cm-number\">50</span>,\n            <span class=\"cm-property\">\"lost_reason\"</span>: <span class=\"cm-atom\">null</span>,\n            <span class=\"cm-property\">\"visible_to\"</span>: <span class=\"cm-string\">\"7\"</span>,\n            <span class=\"cm-property\">\"close_time\"</span>: <span class=\"cm-atom\">null</span>,\n            <span class=\"cm-property\">\"pipeline_id\"</span>: <span class=\"cm-number\">2</span>,\n            <span class=\"cm-property\">\"won_time\"</span>: <span class=\"cm-atom\">null</span>,\n            <span class=\"cm-property\">\"lost_time\"</span>: <span class=\"cm-atom\">null</span>,\n            <span class=\"cm-property\">\"expected_close_date\"</span>: <span class=\"cm-atom\">null</span>,\n            <span class=\"cm-property\">\"label\"</span>: <span class=\"cm-atom\">null</span>,\n        }\n    ],\n    <span class=\"cm-property\">\"additional_data\"</span>: {\n        <span class=\"cm-property\">\"next_cursor\"</span>: <span class=\"cm-string\">\"eyJkZWFscyI6Mn0\"</span>\n    }\n}\n\t\t\t</div></code></pre></div></div>\n<br>\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<br>\n<p><b>What is the benefit of the new endpoints?</b></p>\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<p>We are planning to roll out cursor-based pagination for the other main entities (e.g., Persons and Organizations API) in the near future.</p>\n\t\t\t<p>If you have any questions or comments, let us know in our <a href=\"https://devcommunity.pipedrive.com/\" target=\"blank\">Developers’ Community</a>!</p>\n  </div>\n</div>"
}
[/block]

We are introducing two new endpoints with cursor-based pagination for Activities and Deals API to give you an improved user experience when paging through large data sets.

Introducing 2 new cursor-paginated <code>GET</code> endpoints for Activities and Deals 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\">March 29, 2023</span>\n    </div>\n    <div class=\"change-area\">\n      \n      <p>On November 18, 2022, we announced a <a href=\"https://developers.pipedrive.com/changelog/post/breaking-change-in-codelabelcode-response-fields-data-type-for-deals\">breaking change in the <code>label</code> response field’s data type for Deals</a> with a 2-month warning period.</p>\n      <p>The initial end date of the grace period has passed without the change going live. We want to apologize for any confusion or inconvenience this may have caused. Our team has been working hard to ensure that the change is fully ready to be rolled out, and we strongly believe this will improve the capabilities of our platform in the long run.</p>\n      \n      <p>We are now excited to announce that from <b>March 29, 2023</b>, we will start the gradual rollout of this change.</p>\n      \n      <b><p>What is changing?</p></b>\n      \n      <p>All the technical details from the original announcement still apply:</p>\n      \n      <p>For deals, the data type of a label’s ID will be changed from <code>integer</code> to </code>string</code>:</p>\n      <ul>\n        <li>If the deal has a single label specified, it will be returned as a <code>string</code></li>\n        <li>If the deal has multiple labels specified, it will be returned as a comma-separated <code>string</code></li>\n      </ul>\n      \n      <p>The change affects the following deals-related endpoints:</p>\n      <ul>\n        <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#getDeals\">GET /deals</a></code></li>\n        <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#getDeal\">GET /deals/{id} </a></code></li>\n        <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#getDealsTimeline\">GET /deals/timeline</a></code></li>\n        <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Organizations#getOrganizationDeals\">GET /organizations/{id}/deals</a></code></li>\n        <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Persons#getPersonDeals\">GET /persons/{id}/deals </a></code></li>\n        <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Pipelines#getPipelineDeals\">GET /pipelines/{id}/deals </a></code></li>\n        <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Products#getProductDeals\">GET /products/{id}/deals </a></code></li>\n        <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Stages#getStageDeals\">GET /stages/{id}/deals</a></code></li>\n        <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#addDeal\">POST /deals</a></code></li>\n        <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#duplicateDeal\">POST /deals/{id}/duplicate</a></code></li>\n        <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#updateDeal\">PUT /deals/{id}</a></code></li>\n        <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#mergeDeals\">PUT /deals/{id}/merge</a></code></li>\n      </ul>\n\n<p>Similarly, the data type of a label’s ID will be changed from <code>integer</code> to <code>string</code> in the response payload of the <code>deal</code> v1 webhook.</p>\n      \n      <p>For the <code><a href=\"https://developers.pipedrive.com/docs/api/v1/DealFields#getDealFields\">GET /dealFields</a></code> and <code><a href=\"https://developers.pipedrive.com/docs/api/v1/DealFields#getDealField\">GET /dealFields/{id}</a></code> endpoints, the <code>field_type</code> associated with the <code>“key”: “label”</code> response object will be <code>set</code>, instead of the current <code>enum</code> type.</p>\n      \n      <p><b>Why is it changing?</b></p>\n      <p>We are changing the data type of a deal’s label response field from <code>integer</code> to <code>string</code> to support the functionality of having multiple labels in one deal, which will be introduced in our web app.</p>\n      \n      <p><b>Who will be affected?</b></p>\n      <p>Everyone using the specified endpoints to retrieve the labels of a deal.</p>\n      <p>If you have any questions or comments, let us know in <a href=\"https://devcommunity.pipedrive.com/\">the Developer’s Community</a>.</p>\n     \n      </div>\n</div>"
}
[/block]

The previously announced breaking change in the data type of a deal’s <code>label</code> response field has been postponed. We apologize for any confusion or inconvenience this may have caused. We are now excited to announce a new start date for the gradual rollout of this change.

Update to the breaking change in <code>label</code> response field’s data type for Deals

[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\">March 3, 2023</span>\n    </div>\n    <div class=\"change-area\">\n      <p>1. Leads API now supports querying for users that are allowed to access a lead via the <code><a href=\"https://developers.pipedrive.com/docs/api/v1/Leads#getLeadUsers\" target=\"blank\">GET /leads/{id}/permittedUsers</a></code> endpoint.</p>\n      \n      <p>2. A new optional body parameter <code>duration_unit</code> can be used to specify the unit when editing a product’s duration. The following endpoints include the new parameter:</p>\n      <ul>\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      <p>3. We have removed the mistakenly documented pagination parameters <code>start</code> and <code>limit</code> from the <code><a href=\"https://developers.pipedrive.com/docs/api/v1/Products#getProductUsers\" target=\"blank\">GET /products/{id}/permittedUsers</a></code> endpoint.</p>\n      \n      <p>4. We have corrected the HTTP code for erroneous requests to be <code>404</code> for the <code><a href=\"https://developers.pipedrive.com/docs/api/v1/Leads#getLeads\" target=\"blank\">GET /leads</a></code> endpoint.</p>\n  \n  </div>\n</div>"
}
[/block]

The latest updates to our API Reference include a new <code>GET /leads/{id}/permittedUsers</code> endpoint, a new <code>duration_unit</code> parameter for POST and PUT deal-products, and a corrected error code and error messages for <code>GET /leads</code>.

February 2023 release notes

[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\">May 1, 2023</span>\n    </div>\n    <div class=\"change-area\">\n      \n      <b><p>What is changing?</p></b>\n      <p>From <b>May 1, 2023</b>, the <code>variations_enabled</code> field will be removed from the response of the <code><a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#getDealProducts\" target=\"blank\">GET /deals/{id}/products</a></code> endpoint.</p>\n      \n      <b><p>Why is it changing?</p></b>\n      <p>With the  <a href=\"https://support.pipedrive.com/en/article/can-i-have-one-product-in-different-price-variations\" target=\"blank\">Price variations feature</a> now enabled for all companies, the <code>variations_enabled</code> response field is always returned as <code>true</code>. Hence, it no longer serves its purpose.</p>\n      <p>If you have any feedback, please let us know in <a href=\"https://devcommunity.pipedrive.com/\" target=\"blank\">the Developers’ Community</a>.</p>\n      \n      \n      </div>\n</div>"
}
[/block]

The <code>variations_enabled</code> field will be removed from the response of the <code>GET /deals/{id}/products</code> endpoint.

Removal of the <code>variations_enabled</code> response field from <code>GET /deals/{id}/products</code>

[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 22, 2023</span>\n    </div>\n    <div class=\"change-area\">\n      <p>We’re introducing webhooks version 2 (v2) to give you <b>more reliability and stability</b> and <b><code>lead</code> webhooks</b>!</p>      \n      <h3>What is new?</h3>\n\t\t\t<p>Built on a new technology platform, webhooks v2 is more reliable so there should be <b>no more duplicate or missing webhooks</b>. \n        In addition, you can now <b>create <code>lead</code> webhooks</b>.</p>\n      <p>Get all the details in our <a href=\"https://pipedrive.readme.io/docs/webhooks-v2-migration-guide\" target=\"blank\">v1 to v2 migration guide</a> \n        and our <a href=\"https://pipedrive.readme.io/docs/guide-for-webhooks-v2\" target=\"blank\">guide for webhooks v2</a>.</p>\n      <h3>How to create v2 webhooks</h3>\n\t\t\t<p>At the moment, webhooks v2 can only be created via the API. Find out how to create them in our <a href=\"https://pipedrive.readme.io/docs/guide-for-webhooks-v2#how-to-create-webhooks-v2-via-api\" target=\"blank\">guide</a>.</p>\n      <h3>5 things to know about webhooks v2</h3>\n\t\t\t<ol type=\"1\">\n        <li>Webhooks v2 is still in BETA, so it may be subject to change</li>\n  \t\t\t<li>Webhooks v2 and v1 will continue to run in parallel for the time being. You will be notified of any changes via our <a href=\"https://developers.pipedrive.com/changelog\" target=\"blank\">Changelog</a>, so make sure you subscribe to it.</li>\n  \t\t\t<li>Please review the <a href=\"https://pipedrive.readme.io/docs/webhooks-v2-migration-guide\" target=\"blank\">v1 to v2 migration guide</a> closely as there are significant differences in webhooks v2’s payload</li>\n  \t\t\t<li>Webhooks v2 covers all event objects except <code>pipeline</code>, <code>stage</code> and <code>activityType</code> events. For those, please use v1.</li>\n  \t\t\t<li>Should a field no longer be available in the payload of a v2 webhook, please query it from our API</li>\n  \t\t</ol>\n\t\t\t<p>Learn about webhooks v2 <a href=\"https://pipedrive.readme.io/docs/guide-for-webhooks-v2\" target=\"blank\">here</a> and how to migrate your webhooks from v1 to v2 <a href=\"https://pipedrive.readme.io/docs/webhooks-v2-migration-guide\" target=\"blank\">here</a>. \n      If you have any feedback or run into any issues, please do let us know in our <a href=\"https://devcommunity.pipedrive.com/\" target=\"blank\">Developers’ Community</a>!</p>\n  </div>\n</div>"
}
[/block]

{"product": [“API”, "Webhooks"], "features": ["Activities", "Deals", "Leads", "Notes", "Organizations", "Persons", "Products", "Users"], "email_description": "Built on a new technology platform, webhooks v2 is more reliable, which means there should be <b>no more duplicate or missing webhooks</b>. In addition, you can now <b>create <code>lead</code> webhooks</b>." }

Contents

Changelog

Announced changes

Subscribe to our Changelog

Subscribe to our Changelog

Subscribe to our
Changelog