[block:html]
{
  "html": "<div class=\"chlog-box\">\n    <div class=\"from-area\">\n        <span class=\"from-label\">Effective from:</span><br>\n        <span class=\"from-date\">August 25, 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=\"app-panels-become-interactive\"></div>\n        <div class=\"heading-text\"><div id=\"app-panels-become-interactive\" class=\"heading-anchor_backwardsCompatibility\">\n          </div>App panels become interactive</div>\n        <a aria-label=\"Skip link to App panels become interactive\" class=\"heading-anchor-icon fa fa-anchor\" \n           href=\"#app-panels-become-interactive\"></a></h3>\n   \n     <p>One of the main app extension points in Pipedrive, app panels, now allows you to include field and objects actions in the form of <a href=\"https://pipedrive.readme.io/docs/app-extensions-actions\" target=\"_self\">basic</a> or <a href=\"https://pipedrive.readme.io/docs/app-extensions-embedded-actions\" target=\"_self\">embedded app actions</a>. \n         With one click, users can use the app’s data displayed in the panel by clicking an action.\n         This will allow them to modify, update, send new information to your app. </p>\n\n\n\n<div class=\"magic-block-image\">\n\t<figure><a href=\"https://files.readme.io/7bfc696-App_extensions_-_structure_of_an_app_panel_-_Pipedrive.png\" class=\"block-display-image-parent block-display-image-size-80\"><img src=\"https://files.readme.io/7bfc696-App_extensions_-_structure_of_an_app_panel_-_Pipedrive.png\" alt=\"Structure of the app panel\"></a>\n\t</figure>\n\t<figcaption><p>Structure of the app panel</p>\n</figcaption>\n</div>\n      \n       \n<p>With new capabilities, we have also introduced some new field types (say \"Hi!\" to <code>tags</code> and markdown support in <code>text</code>) as well as providing an easily accessible way \n  for different types of global actions through a green action button. </p>\n\n<p>Also, you can now include a custom error state so users will immediately \n  know what to do if something out of order happens.</p>\n\n      <p>Read more in our guides for <a href=\"https://pipedrive.readme.io/docs/app-extensions-panels\" target=\"_self\">what are app panels</a>, <a href=\"https://pipedrive.readme.io/docs/app-panels-adding-a-panel\" target=\"_self\">how to create one</a>, and <a href=\"https://pipedrive.readme.io/docs/app-panels-actions-in-panels\" target=\"_self\">how to add different actions to the panel</a>. \nFor discussions, requests and feedback, join us in <a href=\"https://devcommunity.pipedrive.com/t/app-panels-become-interactive/4545\" target=\"_self\">the DevCommunity thread</a>!\n      </p>\n      \n      \n       <br>\n      <p class=\"published-on\"><i>Published on August 25, 2021</i></p>\n  </div>\n</div>"
}
[/block]

{"product": ["App extensions"], "features": ["App panels"]}

App panels become interactive

[block:html]
{
  "html": "<div class=\"chlog-box\">\n    <div class=\"from-area\">\n        <span class=\"from-label\">Effective from:</span><br>\n        <span class=\"from-date\">August 4, 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\"></div>\n        <div class=\"heading-text\"><div id=\"documentation-updates-for-api-reference\" 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\"></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      \n      <p><b>1.</b> We documented the <b>required</b> flag for the <code>name</code> parameter for \n<code><a href=\"https://developers.pipedrive.com/docs/api/v1/DealFields#addDealField\" target=\"_self\">POST /dealFields</a></code>, \n<code><a href=\"https://developers.pipedrive.com/docs/api/v1/PersonFields#addPersonField\" target=\"_self\">POST /personFields</a></code> and \n<code><a href=\"https://developers.pipedrive.com/docs/api/v1/OrganizationFields#addOrganizationField\" target=\"_self\">POST /organizationFields</a></code> endpoints to reflect the actual functionality;</p>\n      <p><b>2.</b> We added <code>product</code> and <code>related_objects</code> objects to <code><a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#getDealProducts\" target=\"_self\">GET /deals/{id}/products</a></code> response schema; </p>\n      <p><b>3.</b> We corrected the type of the <code>user_id</code> parameter from query parameter to body parameter for <code><a href=\"https://developers.pipedrive.com/docs/api/v1/Roles#deleteRoleAssignment\" target=\"_self\">DELETE /roles/{id}/assignments</a></code>;</p>\n      <p><b>4.</b> For <code><a href=\"https://developers.pipedrive.com/docs/api/v1/Goals#addGoal\" target=\"_self\">POST /goals</a></code> endpoint, we fixed the description of the <code>interval</code> body parameter and changed it to accept <code>application/json</code> instead of <code>application/x-www-form-urlencoded</code> to reflect reality;</p>\n      <p><b>5.</b> We documented the <code>add_visible_flag</code> body parameter in the documentation of the following six endpoints: </p>\n   <p>   <ul><ul>\n<li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/DealFields#addDealField\" target=\"_self\">POST /dealFields </a></code></li>\n<li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/DealFields#updateDealField\" target=\"_self\">PUT /dealFields</a></code></li>\n<li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/PersonFields#addPersonField\" target=\"_self\">POST  /personFields </a></code></li>\n<li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/PersonFields#updatePersonField\" target=\"_self\">PUT  /personFields</a></code></li>\n<li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/OrganizationFields#addOrganizationField\" target=\"_self\">POST /organizationFields </a></code></li>\n<li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/OrganizationFields#updateOrganizationField\" target=\"_self\">PUT /organizationFields</a></code></li>\n      </ul></p></ul>\n          \n       <br>\n      <p class=\"published-on\"><i>Published on August 4, 2021</i></p>\n  </div>\n</div>"
}
[/block]

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

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\">July 28, 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=\"improving-leads-API\"></div>\n        <div class=\"heading-text\"><div id=\"improving-leads-API\" class=\"heading-anchor_backwardsCompatibility\">\n          </div>Improving Leads API</div>\n        <a aria-label=\"Skip link to Improving Leads API\" class=\"heading-anchor-icon fa fa-anchor\" \n           href=\"#improving-leads-API\"></a></h3>\n      \n     <p>We have made a few updates to our <a href=\"https://developers.pipedrive.com/docs/api/v1/Leads\">Leads API</a>:\n      </p>\n<ul>\n        <p>1. You can now indicate whether the Lead has been seen by someone in the Pipedrive UI via the new <code>was_seen</code> flag added to <code><a href=\"https://developers.pipedrive.com/docs/api/v1/Leads#addLead\">POST /v1/leads/</a></code> and <code><a href=\"https://developers.pipedrive.com/docs/api/v1/Leads#updateLead\">PATCH /v1/leads/{id}</a></code> endpoints.</li>\n</p>\n      \n        <p>2. We have added the <code>visible_to</code> and the <code>cc_email</code> parameters to the responses of the following four endpoints:       </a></code>\n</p>\n<ul><ul>\n<li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Leads#getLeads\" target=\"_self\">GET /v1/leads</a></code></li>\n<li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Leads#getLead\" target=\"_self\">GET /v1/leads/${id}</a></code></li>\n<li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Leads#addLead\" target=\"_self\">POST /v1/leads/</a></code></li>\n<li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Leads#updateLead\" target=\"_self\">PATCH /v1/leads/{id}</a></code></li>\n</ul></ul>\n     \n        <p>3. It is now possible to set the <code>visible_to</code> body parameter when requesting the following two endpoints:\n       </a></code>\n</p>\n<ul><ul>\n<li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Leads#addLead\" target=\"_self\">POST /v1/leads/</a></code></li>\n<li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Leads#updateLead\" target=\"_self\">PATCH /v1/leads/{id}</a></code></li>\n</ul></ul>\n     \n     \n        <br>\n        <p class=\"published-on\"><i>Published on July 28, 2021</i></p>\n  </div>\n</div>"
}
[/block]

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

Improving Leads 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\">July 27, 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=\"introducing-comments-API\"></div>\n        <div class=\"heading-text\"><div id=\"introducing-comments-API\" class=\"heading-anchor_backwardsCompatibility\">\n          </div>Introducing Comments API</div>\n        <a aria-label=\"Skip link to Introducing Comments API\" class=\"heading-anchor-icon fa fa-anchor\" \n           href=\"#introducing-comments-API\"></a></h3>\n      \n     <p>We have added brand new Comments endpoints to the <a href=\"https://developers.pipedrive.com/docs/api/v1/Notes\">Notes</a> resource of the Pipedrive API.\n      </p>\n            <p><b>What is being added?</b></p>\n    <p>The Comments API allows one to get, create, update and delete Comments for Notes.\n      </p>\n      <p>Comments can be added via the public API to existing Notes that are linked to Deals, Persons or Organizations. The User can edit and/or delete the comment(s) via the API if that specific comment was originally posted by the same User or if the User is an admin.\n      </p>\n      <p>The list of Comments under each Note can also be fetched if the User has permission to view the Note that is linked to the Deal, Person or Organization. \n      </p>\n         <p><b>What is the Comments API useful for?</b></p>\n      <p>The User can see, add, update and delete comments to Notes programmatically from one’s own applications. More information on the Comments feature can be found on the Pipedrive help center’s <a href=\"https://support.pipedrive.com/en/article/mentions-and-comments-beta\">Mentions and Comments article</a>. \n      </p>\n        <p><b>Here’s the list of the Comments API endpoints added:</b></p>\n <ul>\n<li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Notes#getNoteComments\" target=\"_self\">GET /v1/notes/{id}/comments</a></code></li>\n<li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Notes#getComment\" target=\"_self\">GET /v1/notes/{id}/comments/{commentId}</a></code></li>\n<li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Notes#addNoteComment\" target=\"_self\">POST /v1/notes/{id}/comments</a></code></li>\n<li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Notes#updateCommentForNote\" target=\"_self\">PUT /v1/notes/{id}/comments/{commentId}</a></code></li>\n<li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Notes#deleteComment\" target=\"_self\">DELETE /v1/notes/{id}/comments/{commentId}</a></code></li>\n      </ul>\n      <p>Please note the OAuth scopes these endpoints have been added to: <code>deals:full</code>, <code>deals:read</code>, <code>contacts:full</code>, <code>contacts:read</code> (the same scopes as <a href=\"https://developers.pipedrive.com/docs/api/v1/Notes\">the Notes API</a>).\n        <p>\n        <br>\n      <p class=\"published-on\"><i>Published on July 27, 2021</i></p>\n  </div>\n</div>"
}
[/block]

{"product": ["API", "Authorization"], "features": ["Notes", "Scopes"]}

Introducing Comments API

[block:html]
{
  "html": "<div class=\"chlog-box\">\n    <div class=\"from-area\">\n        <span class=\"from-label\">Effective from:</span><br>\n        <span class=\"from-date\">September 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=\"permissionsets-API-breaking-changes-postponed\"></div>\n        <div class=\"heading-text\"><div id=\"permissionsets-API-breaking-changes-postponed\" class=\"heading-anchor_backwardsCompatibility\">\n          </div>PermissionSets API breaking change postponed</div>\n        <a aria-label=\"Skip link to PermissionSets API breaking change postponed\" class=\"heading-anchor-icon fa fa-anchor\" \n           href=\"#permissionsets-API-breaking-changes-postponed\"></a></h3>\n\n     <p>Note: If you are simply using our Pipedrive web app and don’t have any custom integrations that you (or a developer) has built, you should have nothing to worry about.<br>\n       If you have, or someone else has, built a custom integration that you are currently using to enhance your Pipedrive experience, please forward this information to the relevant stakeholders.\n      </p>\n      <p>Recently on July 8, 2021, we announced <a href=\"https://developers.pipedrive.com/changelog/post/permissionsets-api-breaking-change\">breaking changes for three PermissionSets API endpoints</a>.\n      </p>\n      <p>Based on your feedback and to give you more time to align with our API changes, we’ve decided to postpone the breaking changes to our <a href=\"https://developers.pipedrive.com/docs/api/v1/PermissionSets\">PermissionSets API</a> from July 26, 2021 to <b>September 1, 2021</b>.\n      </p>\n        <p><b>Who is affected?</b></p>\n      <p>All consumers of the listed API endpoints are affected in case they\n</p>\n      <ul>\n        <li>specifically expect Permission Set ID to be an integer\n</li>\n<li>rely on the removed Permission Set Assignment ID field\n</li>\n        </ul>\n        <br>\n      <p class=\"published-on\"><i>Published on July 23, 2021</i></p>\n  </div>\n</div>"
}
[/block]

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

PermissionSets API breaking change postponed

[block:html]
{
  "html": "<div class=\"chlog-box\">\n    <div class=\"from-area\">\n        <span class=\"from-label\">Effective from:</span><br>\n        <span class=\"from-date\">August 2, 2021</span>\n    </div>\n    <div class=\"change-area\">\n         <h3 class=\"header-scroll\">\n           <h3 class=\"heading heading-3 header-scroll\" align=\"\">\n        <div class=\"heading-anchor anchor waypoint\" id=\"breaking-change-for-post-stages-endpoint\"></div>\n        <div class=\"heading-text\"><div id=\"breaking-change-for-post-stages-endpoint\" class=\"heading-anchor_backwardsCompatibility\">\n          </div>Breaking change for POST /stages endpoint</div>\n        <a aria-label=\"Skip link to Breaking change for POST /stages endpoint\" class=\"heading-anchor-icon fa fa-anchor\" \n           href=\"#breaking-change-for-post-stages-endpoint\"></a></h3>\n           \n         \n      <p><b>What is going to change?</b></p>\n      <p>The body parameter <code>name</code> of the <code><a href=\"https://developers.pipedrive.com/docs/api/v1/Stages#addStage\">POST /stages</a></code> endpoint is a required property (both under the hood and in the documentation), but its existence is not validated when making the request. The endpoint returns <code>201</code> even when there is no value given to the name body parameter. \n      </p>\n      <p>We are going to add validation to the <code>name</code> body parameter when requesting the <code><a href=\"https://developers.pipedrive.com/docs/api/v1/Stages#addStage\">POST /stages</a></code> endpoint. When the value is not present, then the response error will be <code>400</code> “Bad request”.\n      </p>\n\n      <p><b>Why is it going to change?</b></p>\n<p>The <code>name</code> body parameter should be required according to the documentation and common sense.\n      </p>\n      <p><b>Who is affected?</b></p>\n<p>Anyone with functionality built on top of using the endpoint without specifying the stage <code>name</code>. Although it is marked as required in our <a href=\"https://developers.pipedrive.com/docs/api/v1/Stages#addStage\">API Reference page documentation</a>, we encourage you to please check how you are using the endpoint.\n      </p>\n          <br>\n      <p class=\"published-on\"><i>Published on July 19, 2021</i></p>\n  </div>\n</div>"
}
[/block]

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

Breaking change for <code>POST /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\">July 9, 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=\"fix-in-post-pipelines-endpoint-documentation\"></div>\n        <div class=\"heading-text\"><div id=\"fix-in-post-pipelines-endpoint-documentation\" class=\"heading-anchor_backwardsCompatibility\">\n          </div>Fix in POST /pipelines endpoint documentation</div>\n        <a aria-label=\"Skip link to Fix in POST /pipelines endpoint documentation\" class=\"heading-anchor-icon fa fa-anchor\" \n           href=\"#fix-in-post-pipelines-endpoint-documentation\"></a></h3>\n     \n      <p>\n        We had the <code>name</code> parameter not marked as required in the documentation of <code><a href=\"https://developers.pipedrive.com/docs/api/v1/Pipelines#addPipeline\" targert=\"_self\">POST /v1/pipelines</a></code> endpoint in our API Reference, but under the hood it has always been a required parameter. We have now corrected the documentation and assigned the “required”  flag to the <code>name</code> parameter.</p>\n        <br>\n      <p class=\"published-on\"><i>Published on July 9, 2021</i></p>\n  </div>\n</div>"
}
[/block]

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

Fix in <code>POST /pipelines</code> endpoint documentation

[block:html]
{
  "html": "<div class=\"chlog-box\">\n    <div class=\"from-area\">\n        <span class=\"from-label\">Effective from:</span><br>\n        <span class=\"from-date\">July 26, 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=\"permissionsets-API-breaking-changes\"></div>\n        <div class=\"heading-text\"><div id=\"permissionsets-API-breaking-changes\" class=\"heading-anchor_backwardsCompatibility\">\n          </div>PermissionSets API breaking change</div>\n        <a aria-label=\"Skip link to PermissionSets API breaking change\" class=\"heading-anchor-icon fa fa-anchor\" \n           href=\"#permissionsets-API-breaking-changes\"></a></h3>\n      \n         \n      <p><strong>UPDATE (July 23, 2021)</strong>: Based on your feedback and to give you more time to align with our API changes, we’ve decided to postpone the breaking changes to our <a href=\"https://developers.pipedrive.com/docs/api/v1/PermissionSets\">PermissionSets API</a> to <b>September 1, 2021</b>.\nSee <a href=\"https://pipedrive.readme.io/docs/changelog#permissionsets-API-breaking-changes-postponed\" target=\"_self\">the announcement</a> for more.</p>\n\n\n      <p>There are the following breaking changes happening to <a href=\"https://developers.pipedrive.com/docs/api/v1/PermissionSets\" target=\"_self\">PermissionSets API</a>:</p>\n      <p><b>What is going to change?</b></p>\n      <p>1. The Permission Set ID format will be changed from integer to UUID (universally unique identifier) string. This means that the current IDs will be replaced with <b>new</b> values both in the endpoint path and the response body for the following three endpoints:\n</p>\n      <ul>\n <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/PermissionSets#getPermissionSets\" target=\"_self\">GET /v1/permissionSets</a></code></li>\n<li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/PermissionSets#getPermissionSet\" target=\"_self\">GET /v1/permissionSets/:id</a></code></li>\n<li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/PermissionSets#getPermissionSetAssignments\" target=\"_self\">GET /v1/permissionSets/:id/assignments</a></code></li>\n      </ul>\n      \n      <p>2. The response of <code><a href=\"https://developers.pipedrive.com/docs/api/v1/PermissionSets#getPermissionSetAssignments\" target=\"_self\">GET /v1/permissionSets/:id/assignments</a></code>\n        will no longer include the <code>id</code> field per assignment. An assignment is an object which currently includes the following fields\n</p>\n      <ul>\n        <li><code>id</code> (which will be removed)</li>\n       <li><code>user_id</code></li>\n        <li><code>permission_set_id</code></li>\n        <li><code>name</code> (the name of the PermissionSet)</li>\n      </ul>\n      \n      <p>3. Permission Set objects returned from  <code><a href=\"https://developers.pipedrive.com/docs/api/v1/PermissionSets#getPermissionSets\" target=\"_self\">GET /v1/permissionSets</a></code>\n and <code><a href=\"https://developers.pipedrive.com/docs/api/v1/PermissionSets#getPermissionSet\" target=\"_self\">GET /v1/permissionSets/:id</a></code>\n        will temporarily (for the next 2 months) have an additional field <code>old_id</code> of type integer, which will contain the old ID value </p>\n      \n      <p>4. Permission Set Assignment objects returned from <code><a href=\"https://developers.pipedrive.com/docs/api/v1/PermissionSets#getPermissionSetAssignments\" target=\"_self\">GET /v1/permissionSets/:id/assignments</a></code>\n will temporarily (for the next 2 months) have an additional field <code>permission_set_id_old</code> of type integer, which will contain the old Permission Set ID value\n</p>\n      \n      <p><b>Why is it going to change?</b></p>\n     <p> We are updating our data storage in preparation for providing the new Permission Set functionality in the near future.</p>\n            <p><b>Who is affected?</b></p>\n      <p>All consumers of the listed API endpoints are affected in case they\n</p>\n      <ul>\n        <li>specifically expect Permission Set ID to be an integer\n</li>\n<li>rely on the removed Permission Set Assignment id field\n</li>\n        </ul>\n        <br>\n      <p class=\"published-on\"><i>Published on July 8, 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\">July 26, 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=\"permissionsets-API-breaking-changes\"></div>\n        <div class=\"heading-text\"><div id=\"permissionsets-API-breaking-changes\" class=\"heading-anchor_backwardsCompatibility\">\n          </div>PermissionSets API breaking change</div>\n        <a aria-label=\"Skip link to PermissionSets API breaking change\" class=\"heading-anchor-icon fa fa-anchor\" \n           href=\"#permissionsets-API-breaking-changes\"></a></h3>\n      \n         \n      <p><strong>UPDATE (July 23, 2021)</strong>: Based on your feedback and to give you more time to align with our API changes, we’ve decided to postpone the breaking changes to our <a href=\"https://developers.pipedrive.com/docs/api/v1/PermissionSets\">PermissionSets API</a> to <b>September 1, 2021</b>.\nSee <a href=\"/changelog/post/permissionsets-API-breaking-changes-postponed\" target=\"_self\">the announcement</a> for more.</p>\n\n\n      <p>There are the following breaking changes happening to <a href=\"https://developers.pipedrive.com/docs/api/v1/PermissionSets\" target=\"_self\">PermissionSets API</a>:</p>\n      <p><b>What is going to change?</b></p>\n      <p>1. The Permission Set ID format will be changed from integer to UUID (universally unique identifier) string. This means that the current IDs will be replaced with <b>new</b> values both in the endpoint path and the response body for the following three endpoints:\n</p>\n      <ul>\n <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/PermissionSets#getPermissionSets\" target=\"_self\">GET /v1/permissionSets</a></code></li>\n<li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/PermissionSets#getPermissionSet\" target=\"_self\">GET /v1/permissionSets/:id</a></code></li>\n<li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/PermissionSets#getPermissionSetAssignments\" target=\"_self\">GET /v1/permissionSets/:id/assignments</a></code></li>\n      </ul>\n      \n      <p>2. The response of <code><a href=\"https://developers.pipedrive.com/docs/api/v1/PermissionSets#getPermissionSetAssignments\" target=\"_self\">GET /v1/permissionSets/:id/assignments</a></code>\n        will no longer include the <code>id</code> field per assignment. An assignment is an object which currently includes the following fields\n</p>\n      <ul>\n        <li><code>id</code> (which will be removed)</li>\n       <li><code>user_id</code></li>\n        <li><code>permission_set_id</code></li>\n        <li><code>name</code> (the name of the PermissionSet)</li>\n      </ul>\n      \n      <p>3. Permission Set objects returned from  <code><a href=\"https://developers.pipedrive.com/docs/api/v1/PermissionSets#getPermissionSets\" target=\"_self\">GET /v1/permissionSets</a></code>\n and <code><a href=\"https://developers.pipedrive.com/docs/api/v1/PermissionSets#getPermissionSet\" target=\"_self\">GET /v1/permissionSets/:id</a></code>\n        will temporarily (for the next 2 months) have an additional field <code>old_id</code> of type integer, which will contain the old ID value </p>\n      \n      <p>4. Permission Set Assignment objects returned from <code><a href=\"https://developers.pipedrive.com/docs/api/v1/PermissionSets#getPermissionSetAssignments\" target=\"_self\">GET /v1/permissionSets/:id/assignments</a></code>\n will temporarily (for the next 2 months) have an additional field <code>permission_set_id_old</code> of type integer, which will contain the old Permission Set ID value\n</p>\n      \n      <p><b>Why is it going to change?</b></p>\n     <p> We are updating our data storage in preparation for providing the new Permission Set functionality in the near future.</p>\n            <p><b>Who is affected?</b></p>\n      <p>All consumers of the listed API endpoints are affected in case they\n</p>\n      <ul>\n        <li>specifically expect Permission Set ID to be an integer\n</li>\n<li>rely on the removed Permission Set Assignment id field\n</li>\n        </ul>\n        <br>\n      <p class=\"published-on\"><i>Published on July 8, 2021</i></p>\n  </div>\n</div>"
}
[/block]

PermissionSets API breaking change

[block:html]
{
  "html": "<div class=\"chlog-box\">\n    <div class=\"from-area\">\n        <span class=\"from-label\">Effective from:</span><br>\n        <span class=\"from-date\">July 6, 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=\"removal-of-app-extensions-for-products\"></div>\n        <div class=\"heading-text\"><div id=\"removal-of-app-extensions-for-products\" class=\"heading-anchor_backwardsCompatibility\">\n          </div>Removal of App Extensions for Products</div>\n        <a aria-label=\"Skip link to Removal of app extensions for Products\" class=\"heading-anchor-icon fa fa-anchor\" \n           href=\"#removal-of-app-extensions-for-products\"></a></h3>\n        \n      <p><b>What has changed?</b></p>\n     <p>Support for app extensions inside Products List view, including basic app actions and embedded app actions, is now discontinued.\n      </p>\n\n      <p><b>Why was it discontinued?</b></p>\n\n<p>It was discontinued due to a technical change. As we have noticed that no submitted app has been making use of app extensions for Products in List view, we decided to discontinue support for it.\n      </p>\n<p>Should you be keen on using basic app actions or embedded app actions inside Product details or list views, please contact us directly at <a href:\"mailto\"marketplace.devs@pipedrive.com\">marketplace.devs@pipedrive.com</a> and tell us your use case. We’d be very happy to hear from you!\n</p>\n          <br>\n      <p class=\"published-on\"><i>Published on July 6, 2021</i></p>\n  </div>\n</div>"
}
[/block]

{"product": ["App extensions"], "features": ["App actions"]}

Removal of App Extensions for 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\">July 15, 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=\"error-response-correction-for-search-api\"></div>\n        <div class=\"heading-text\"><div id=\"error-response-correction-for-search-api\" class=\"heading-anchor_backwardsCompatibility\">\n          </div>Error response correction for Search API</div>\n        <a aria-label=\"Skip link to Error response correction for Search API\" class=\"heading-anchor-icon fa fa-anchor\" \n           href=\"#error-response-correction-for-search-api\"></a></h3>\n\n  <p><b>What is going to change?</b></p>\n     <p>We are going to update the current incorrect error response to match <a href=\"https://pipedrive.readme.io/docs/core-api-concepts-responses\">Pipedrive API’s core concepts of responses</a> for the following Search endpoints:\n      </p>\n      <ul>\n        <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#searchDeals\">GET /v1/deals/search</a></code></li>\n        <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem\">GET /v1/itemSearch</a></code></li>\n        <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItemByField\">GET /itemSearch/field</a></code></li>\n        <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Organizations#searchOrganization\">GET /organizations/search</a></code></li>\n        <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Persons#searchPersons\">GET /persons/search</a></code></li>\n      </ul>\n         <p>Here is an example of a correct error response which will be applied for the endpoints listed above:\n      </p>\n     <div class=\"CodeTabs CodeTabs_initial theme-light\"><div class=\"CodeTabs-toolbar\"><button type=\"button\">JSON</button></div><div class=\"CodeTabs-inner\"><pre><code class=\"rdmd-code lang-json theme-light\" data-lang=\"json\" name=\"\"><button aria-label=\"Copy Code\" class=\"rdmd-code-copy fa\"></button><div class=\"cm-s-neo\">{\n <span class=\"cm-property\">\"success\"</span>: <span class=\"cm-atom\">false</span>,\n <span class=\"cm-property\">\"error\"</span>: <span class=\"cm-string\">\"Requested service is not available\"</span>, <span class=\"cm-comment\">//main error message</span>\n <span class=\"cm-property\">\"error_info\"</span>: <span class=\"cm-string\">\"Please check developers.pipedrive.com\"</span>,\n <span class=\"cm-property\">\"data\"</span>: <span class=\"cm-atom\">null</span>,\n <span class=\"cm-property\">\"additional data\"</span>: <span class=\"cm-atom\">null</span>\n}\n</div></code></pre></div></div>\n      \n      <p><b>Who is affected?</b></p>\n\n<p>Anyone with functionality built on top of the previous behavior will need to alter their code.\n</p>\n          <br>\n      <p class=\"published-on\"><i>Published on July 1, 2021</i></p>\n  </div>\n</div>\n"
}
[/block]

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

Contents

Changelog

Announced changes

Subscribe to our Changelog

Subscribe to our Changelog

Subscribe to our
Changelog