[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 15, 2023</span>\n    </div>\n    <div class=\"change-area\">\n      \n      <p><b>What is changing?</b></p>\n      \n      <p>From <b>March 15, 2023</b>, we will be adding <code>limit</code> and <code>start</code> query parameters to the <code><a href=\"https://developers.pipedrive.com/docs/api/v1/Stages#getStages\">GET /stages</a></code> endpoint to support pagination:</p>\n      <ul>\n        <li><code>limit</code> - The limit of entries to be returned</li>\n        <li><code>start</code> - The position that represents the first result for the page</li>\n      </ul>\n      \n      <p>If the <code>limit</code> value is not provided, 100 stage items will be returned.</p>\n      <p>Please refer to our Developer Documentation for more information on <a href=\"https://pipedrive.readme.io/docs/core-api-concepts-pagination\">pagination</a>.</p>\n      \n      <p><b>Why is it changing?</b></p>\n      <p>We are introducing pagination support for this endpoint to ensure that responses with a big amount of data are easier to handle.</p>\n      \n\t\t\t<p><b>Who will be affected?</b></p>\n      <p>Everyone using the specified endpoint to retrieve stages.</p>\n\t\t\t<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 pagination for the GET /stages endpoint.

Breaking change: pagination for the <code>GET /stages</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\">December 30, 2022</span>\n    </div>\n    <div class=\"change-area\">\n      \n      <p>1. The <code><a href=\"https://developers.pipedrive.com/docs/api/v1/Files#addFile\">POST /files</a></code> endpoint now supports adding files to leads with the <code>lead_id</code> body parameter.</p>\n      \n      </div>\n</div>"
}
[/block]

The latest update to our API Reference includes adding files to leads with the POST /files endpoint.

December 2022 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\">February 13, 2023</span>\n    </div>\n    <div class=\"change-area\">\n      <p><b>What is changing?</b></p>\n      \n      <p>From <b>February 13, 2023</b>, we will be introducing breaking changes to 4 products-related endpoints.</p>\n      \n      <p>1. For the <code><a href=\"https://developers.pipedrive.com/docs/api/v1/Products#getProductFiles\">GET /products/{id}/files</a></code> endpoint:</p>\n      <ul>\n        <li>The following fields will no longer be included in the response:\n        \t<ul>\n          \t<li><code>deal_id</code></li>\n          \t<li><code>person_id</code></li>\n          \t<li><code>org_id</code></li>\n          \t<li><code>activity_id</code></li>\n          \t<li><code>lead_id</code></li>\n          \t<li><code>mail_message_id</code></li>\n          \t<li><code>mail_template_id</code></li>\n          \t<li><code>deal_name</code></li>\n          \t<li><code>person_name</code></li>\n          \t<li><code>people_name</code></li>\n          \t<li><code>org_name</code></li>\n          \t<li><code>lead_name</code></li>\n          \t<li><code>cid</code></li>\n          \t<li><code>log_id</code></li>\n        \t</ul>\n        </li>\n        </br>\n        <li>The <code>sort</code> query parameter will no longer support the following field keys:\n          <ul>\n            <li><code>user_id</code></li>\n            <li><code>deal_id</code></li>\n            <li><code>person_id</code></li>\n            <li><code>org_id</code></li>\n            <li><code>product_id</code></li>\n            <li><code>add_time</code></li>\n            <li><code>file_name</code></li>\n            <li><code>file_type</code></li>\n            <li><code>file_size</code></li>\n            <li><code>comment</code></li>\n          </ul>\n        </li>\n        <p>You can use the <code>id</code> and <code>update_time</code> field keys inside the <code>sort</code> query parameter to filter the response.</p>\n      </ul>\n      </br>\n      \n      \n      <p>2. The <code>product_attachment_id</code> response field will be removed from the responses of 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#deleteDealProduct\">DELETE /deals/{id}/products/{product_attachment_id}</a></code> endpoints.</p>\n      </br>\n      <p>3. The <code>item_price</code> and <code>quantity</code> body parameters are no longer required fields for the <code><a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#updateDealProduct\">PUT /deals/{id}/products/{product_attachment_id}</a></code> endpoint.</p>\n      </br>\n\n      <p><b>Why is it changing?</b></p>\n      <p>The goal of the changes is to ensure that the Deals and Products API endpoints mentioned above return only the most relevant fields according to each endpoint and to support the performance of our API.</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      \n      \n      </div>\n</div>"
}
[/block]

We have announced the removal of response fields and changes to query parameters in 4 Deals and Products API endpoints.

Breaking changes in 4 products-related 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\">December 8, 2022</span>\n    </div>\n    <div class=\"change-area\">\n      \n      <p>1. The <a href=\"https://developers.pipedrive.com/docs/api/v1/ItemSearch\">ItemSearch API</a> now supports searching for projects.</p>\n      <p>For the <code><a href=\"https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem\">GET /itemSearch</a></code> endpoint:</p>\n      <ul>\n        <li>the <code>item_types</code> query parameter has a new possible value <code>project</code></li>\n        <li>the <code>fields</code> query parameter now allows you to use search from the following project fields: <code>custom_fields</code>, <code>notes</code>, <code>title</code>, <code>description</code></li>\n      </ul>\n      \n      <p>For the <code><a href=\"https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItemByField\">GET /itemSearch/field</a></code> endpoint:</p>\n      <ul>\n        <li> the <code>field_type</code> query parameter supports a new value <code>projectField</code></li>\n      </ul>\n      \n      <p>2. We have documented the <code>product_id</code> required body parameter for the <code><a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#addDealProduct\">POST /deals/{id}/products</a></code> endpoint.</p>\n      \n      <p>3. Required labels were documented to reflect reality for the <code>assignee</code>, <code>type</code>, <code>expected_outcome</code>, <code>duration</code>, and <code>interval</code> body parameters of the <code><a href=\"https://developers.pipedrive.com/docs/api/v1/Goals#addGoal\">POST /goals</a></code> endpoint.</p>\n      \n      <p>4. We have removed the mistakenly documented <code>primary_email</code> body parameter from  <code><a href=\"https://developers.pipedrive.com/docs/api/v1/Persons#addPerson\">POST /persons</a></code> and <code><a href=\"https://developers.pipedrive.com/docs/api/v1/Persons#updatePerson\">PUT /persons/{id}</a></code> endpoints.</p>\n      \n     \n       </div>\n</div>"
}
[/block]

The latest improvements to our API Reference include projects support for ItemSearch API, adding the project_id body parameter for POST /deals/{id}/products, and documenting required labels for the body parameters of the POST /goals endpoint.

November 2022 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\">January 17, 2023</span>\n    </div>\n    <div class=\"change-area\">\n      <p>UPDATE: The implementation of this change has been delayed. We apologize for any confusion or inconvenience this may have caused. From <b>March 29, 2023</b>, we are starting the gradual rollout of this change. Please refer to the <a href=\"https://developers.pipedrive.com/changelog/post/update-to-the-breaking-change-in-codelabelcode-response-fields-data-type-for-deals\">updated announcement in Changelog</a> for further details.</p>\n      \n      <p><b>What is changing?</b></p>\n      <p>From <b>January 17, 2023</b>, the data type of a <b>deal’s</b> <code>label</code> response field will be changed from <code>integer</code> to <code>string</code>:</p>\n      <ul>\n        <li>If the deal has a single label specified, the label ID will be returned as a <code>string</code></li>\n        <li>If the deal has multiple labels specified, the label IDs 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>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    </div>\n</div>"
}
[/block]

The data type of a deal’s label response field will be changed from integer to string to support the functionality of having multiple labels in one deal, which will be introduced in our web app.

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\">January 4, 2023</span>\n    </div>\n    <div class=\"change-area\">\n      <p><b>What is changing?</b></p>\n      <p>From <b>January 4, 2023</b>, we will be removing the <code>followers_count</code> response field from the following Products-related endpoints:</p>\n      <ul>\n        <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#getDealProducts\">GET /deals/{id}/products</a></code></li>\n        <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Products#getProducts\">GET /products</a></code></li>\n        <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Products#getProduct\">GET /products/{id}</a></code></li>\n        <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Products#addProduct\">POST /products</a></code></li>\n        <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Products#updateProduct\">PUT /products/{id}</a></code></li>\n      </ul>\n      <p>Additionally, this field will be removed from the response payload of the <code>product</code> webhook.</p>\n      \n      <p><b>Why is it changing?</b></p>\n      <p>We’re removing the response field because the Products API contains a specified endpoint for retrieving the followers of a product - <code><a href=\"https://developers.pipedrive.com/docs/api/v1/Products#getProductFollowers\">GET /products/{id}/followers</a></code>. We recommend using this endpoint to get followers’ information in more detail.</p>\n      \n      <p><b>Who will be affected?</b></p>\n      <p>Everyone using the 5 specified endpoints to find the number of followers for a product.</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    </div>\n</div>"
}
[/block]

The followers_count response field will be removed from Products-related endpoints and the product webhook.

Removal of <code>followers_count</code> response field from Products endpoints 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 31, 2022</span>\n    </div>\n    <div class=\"change-area\">\n      \n      <p>1. We have corrected the documentation of <code>Content-Type</code> for body parameters from <code>application/x-www-form-urlencoded</code> to <code>application/json</code> to reflect reality for the following ActivityTypes endpoints: </p>\n      <ul>\n        <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/ActivityTypes#addActivityType\">POST /activityTypes</a></code></li>\n        <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/ActivityTypes#updateActivityType\">PUT /activityTypes/{id}</a></code></li>\n      </ul>\n      \n      <p>2. The <code>related_objects</code> section of the response example now includes <code>stage</code> and <code>pipeline</code> information to reflect reality for the following 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/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/Products#getProductDeals\">GET /products/{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#updateDeal\">PUT /deals/{id}</a></code></li>\n      </ul>\n      \n    </div>\n</div>"
}
[/block]

The latest improvements to our API Reference include a Content-Type update for ActivityTypes endpoints and documented stage and pipeline information in the response examples of Deals-related endpoints.

October 2022 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\">December 16, 2022</span>\n    </div>\n    <div class=\"change-area\">\n     \n      <p><b>What is changing?</b></p>\n      <p>From <b>December 16, 2022</b>, the <code>type.params.pipeline_id</code> \n        and <code>type.params.activity_type_id</code> query parameters will only \n        accept the specified IDs as an <b>array</b> for the \n        <code><a href=\"https://developers.pipedrive.com/docs/api/v1/Goals#getGoals\">GET /goals/find</a></code> endpoint.</p>\n      \n      <p>Similarly, the <code>pipeline_id</code> and <code>activity_type_id</code>\n        response fields will be returned as an <b>array</b> in the following \n        endpoints’ responses:</p>\n      <ul>\n        <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Goals#getGoals\">GET /goals/find</a></code></li>\n        <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Goals#getGoalResult\">GET /goals/{id}/results</a></code></li>\n        <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Goals#addGoal\">POST /goals</a></code></li>\n        <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Goals#updateGoal\">PUT /goals/{id}</a></code></li>\n      </ul>\n      \n      <p><b>Why is it changing?</b></p>\n      <p>Due to a legacy implementation on our side, the \n        <code>type.params.pipeline_id</code> and \n        <code>type.params.activity_type_id</code> query parameters have so far \n        accepted both integer and array data types. From December 16, 2022, \n        they will accept and return an array to support the inclusion of \n        multiple pipelines and/or activity types for your goals.</p>\n      \n      <p><b>Who will be affected?</b></p>\n      <p>Everyone using the specified query parameters to find goals and/or strictly checking the response structure of these endpoints.</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 type.params.pipeline_id and type.params.activity_type_id query parameters will only accept the specified IDs as an array for the GET /goals/find endpoint. Additionally, these parameters will be returned as arrays in the responses of Goals API endpoints.

Breaking change in Goals API <code>pipeline_id</code> and <code>activity_type_id</code> data types

[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 5, 2022</span>\n    </div>\n    <div class=\"change-area\">\n     \n      <p><b>What is changing?</b></p>\n      <p>We have deprecated and will remove the <code><a href=\"https://developers.pipedrive.com/docs/api/v1/Roles#getRoleSubRoles\">GET /roles/{id}/roles</a></code> endpoint from the Roles API on <b>December 5, 2022</b>.</p>\n      <p>We strongly advise you to avoid using the deprecated endpoint.</p>\n      \n      <p><b>Who will be affected?</b></p>\n      <p>Everyone who is using the deprecated <code>GET</code> endpoint for retrieving the sub-roles of a role.</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    \n  </div>\n</div>"
}
[/block]

We have deprecated and will remove the GET /roles/{id}/roles endpoint from the Roles API.

Removal of the <code>GET /roles/{id}/roles</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\">September 29, 2022</span>\n    </div>\n    <div class=\"change-area\">\n     \n      <p>1. We have corrected the documentation of Content-Type for body parameters from <code>application/x-www-form-urlencoded</code> to <code>application/json</code> to reflect reality for the following Goals, Roles and Users API endpoints:</p>\n      <ul>\n        <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Goals#updateGoal\">PUT /goals/{id}</a></code></li>\n        <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Roles#addRole\">POST /roles</a></code></li>\n        <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Roles#addRoleAssignment\">POST /roles/{id}/assignments </a></code></li>\n        <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Roles#addOrUpdateRoleSetting\">POST /roles/{id}/settings</a></code></li>\n        <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Roles#updateRole\">PUT /roles/{id}</a></code></li>\n        <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Roles#deleteRoleAssignment\">DELETE /roles/{id}/assignments</a></code></li>\n        <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Users#updateUser\">PUT /users/{id}</a></code></li>\n      </ul>\n      \n      <p>2. The <code>name</code> body parameter was labeled as <code>required</code> to reflect reality for the <code><a href=\"https://developers.pipedrive.com/docs/api/v1/Roles#addRole\">POST /roles</a></code> endpoint.</p>\n    \n  </div>\n</div>"
}
[/block]

The latest changes to our API Reference include: updated Content-Type for Goals, Roles and Users API body parameters and removed the required label from POST /roles name parameter.

Contents

Changelog

Announced changes

Subscribe to our Changelog

Subscribe to our Changelog

Subscribe to our
Changelog