[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 09, 2024</span>\n    </div>\n    <div class=\"change-area\">\n      <p>We’re launching app onboarding/feature guide as well as app home page functionalities to further support app activation and engagement!\n</p>\n<br/>\n<h2>What is being added?</h2>\n\n<h3>1. App onboarding guide</h3>\n      \n<p>This feature enables app creators to add an onboarding guide that empowers users to familiarize themselves with a newly installed \n  app through an overview of its features or step-by-step instructions. This can help reduce the learning curve, maximize value extraction and foster adoption.\n      </p>  \n\n<p>You can now create the guide directly in the <A href=\"https://app.pipedrive.com/developer-hub\"><b>Developer Hub</b></a> and break it it into individual segments using content blocks. \n  To make the guide more engaging, you can add a link to a tutorial video or add a link to an onboarding article.\n      </p>  \n      \n<p><img alt=\"\" loading=\"lazy\" src=\"https://files.readme.io/9883b7e-Navigation.png\" title=\"\" align=\"center\" class=\"\" caption=\"\" height=\"auto\" width=\"auto\"></p>\n\n<p>Users will be prompted to view the guide upon installing the app and returning to Pipedrive. They can access the guide at any time from the\n  <b>Apps dock</b> (“My apps” panel) or from the app home page under <b>Settings → Tools and apps → Marketplace apps</b>.\n      </p>\n      \n<p><img alt=\"\" loading=\"lazy\" src=\"https://files.readme.io/bbd85d8-example_modal.png\" title=\"\" align=\"center\" class=\"\" caption=\"\" height=\"auto\" width=\"auto\"></p>\n\n<p>\n  Read more about it in the <a href=\"https://pipedrive.readme.io/docs/marketplace-registering-the-app#onboarding-for-users\">documentation</a>.\n</p>\n\n      <br/>\n\n<h3>2. App home page</h3>\n<p>\n      This page serves as a central hub where users who have installed your app can find everything related to it, from general information to permissions, \n  an onboarding/feature guide, support information, <a href=\"https://pipedrive.readme.io/docs/custom-ui-extensions-app-settings\">app settings</a>, \n  <a href=\"https://pipedrive.readme.io/docs/app-sharing-adding-apps-to-multiple-users\">>app sharing management</a> and the option to uninstall it. \n  It’s accessible from the <b>Tools & Apps > Marketplace Apps</b> or the <b>Apps dock</b> (“My apps” panel) in the top menu bar.\n  <a href=\"https://pipedrive.readme.io/docs/app-home-page\">Learn more about it</a>.\n</p>\n\n<p><img alt=\"\" loading=\"lazy\" src=\"https://files.readme.io/a3c27c7-image.png\" align=\"center\" class=\"\" width=\"100%\" caption=\"\" height=\"auto\" title=\"\"></p>\n\n <p>If you have any questions or comments, feel free to let us know in <a href=\"https://devcommunity.pipedrive.com/\">the Developer’s Community</a>.</p>\n      \n\t\t</div>\n</div>"
}
[/block]

"We are launching app onboarding guide and app home page features to help with app activation and engagement."

Introducing app onboarding guide and app home page

[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 08, 2024</span>\n    </div>\n    <div class=\"change-area\">\n      <p>We’re introducing app-sharing functionality for apps. When enabled, it allows an admin user to add the app to other users within the same Pipedrive company. \n        Adding apps to users will significantly increase the number of app installations per company, possibly increasing your app's new users and reducing churn probability of your customers.</p>\n<br/>\n<p><b>What is being added?</b></p>\n<p>The app-sharing feature can be enabled for most apps if they meet some essential criteria. \n  It allows admin users to initiate the sharing process by selecting a group of users within their company upon app installation. \n  Once shared, team members will receive notifications through multiple channels and will need to authorize the app to start using it.\n  Read more about it in the <a href=\"https://pipedrive.readme.io/docs/app-sharing-adding-apps-to-multiple-users\">documentation</a>.\n</p>\n\n    \n\n\n<p><b>Why was it added?</b></p>\n<p>\n      In many companies, due to the lack of a centralized system for sharing information, admins often rely on communication channels like Slack or email to push an app or integration forward, which may result in lower adoption rates and data silos. Allowing admins to add apps to multiple users in one go saves time while encouraging app adoption.\n      </p>\n<p>\nFor users, seamless access to information about added apps from a trustworthy source, along with entry points that redirect them to the authorization page, reduces barriers to installation and boosts confidence in authorizing the app, resulting in a significantly streamlined process.\n</p>\n<p>\nApp creators benefit from increased app visibility, higher utilization of the app within a customer company, and ultimately, better business results.\n</p>\n      </p>\n\n\t\t</div>\n</div>"
}
[/block]


<br>

We are announcing a new developer platform feature that allows you to enable app sharing for your app.

App sharing: Adding apps to multiple users

[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 14, 2024</span>\n    </div>\n    <div class=\"change-area\">\n<p><b>What is being added?</b></p>\n<p>We've introduced new endpoints to retrieve updates about field values of different entities:\n</p>\n\n      <ul>\n        <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#getDealChangelog\" target=\"blank\">GET /deals/{id}/changelog</a></code></li>\n        <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Persons#getPersonChangelog\" target=\"blank\">GET /persons/{id}/changelog</a></code></li>\n        <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Organizations#getOrganizationChangelog\" target=\"blank\">GET /organizations/{id}/changelog</a></code></li>\n      </ul>\n\n\n<p><b>Why is it changing?</b></p>\n<p>We are providing new endpoints specifically to fetch changes in deal, person and organization field values. They are similar to the existing \n  <code><a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#getDealUpdates\" target=\"blank\">/flow</a></code> endpoints but are more performant due to returning only one type of change and using cursor pagination.      \n      </p>\n\n\n<p>If you have any questions or comments, please let us know in <a href=\"https://devcommunity.pipedrive.com/\">the Developer’s Community</a>.</p>\n\n\t\t</div>\n</div>"
}
[/block]


<br>

We are introducing several new <code>/changelog</code> endpoints with improved performance compared to existing /flow endpoints.

New <code>/changelog</code> 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\">May 20, 2024</span>\n    </div>\n    <div class=\"change-area\">\n      <p><b>What is changing?</b></p>\n      \n      <p>From May 20, 2024, fields <code>deal_id</code> and <code>org_id</code> must be either an integer or a string representing an integer. </p>\n      <p>The change affects the following endpoints:</p>              \n              <ul>\n                <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Activities#addActivity\" target=\"blank\">POST /v1/activities</a></code></li>\n                <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Activities#updateActivity\" target=\"blank\">PUT /v1/activities/{id}</a></code></li>\n              </ul>\n      \n      <p><b>Why is this changing?</b></p>\n      <p>We’re making this change to ensure the reliable processing of requests in Activities API and avoid interruptions in later stages.</p>\n\n\n      <p>If you have any questions or comments, please let us know in <a href=\"https://devcommunity.pipedrive.com/\">the Developer’s Community</a>.</p>\n\n\t\t</div>\n</div>"
}
[/block]

Fields deal_id and org_id must be either an integer or a string representing an integer.

Breaking change: updated validation rules for <code>POST/PUT /activities/{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\">February 29, 2024</span>\n    </div>\n    <div class=\"change-area\">\n      <p>Between the 29th of February and 4th of March, we rolled out the possibility of deleting users permanently from a company account upon deactivation. Deleted users’ personal information, including their name, email, phone number and profile picture, will be deleted and replaced with  “(deleted user)”, whereas their non-personal data will remain visible. </p>\n<br/>\n<p><b>What is changing?</b></p>\n<p>To indicate this new user’s status, we’ll include a new response boolean field <code>is_deleted: true | false</code> to the following endpoints in <code>Users API</code>:\n</p>\n      <ul>\n        <li><code>GET</code> endpoints \n          <code><a href=\"https://developers.pipedrive.com/docs/api/v1/Users#getUsers\" target=\"blank\">/v1/users</a></code>,\n          <code><a href=\"https://developers.pipedrive.com/docs/api/v1/Users#findUsersByName\" target=\"blank\">/v1/users/find</a></code>,\n          <code><a href=\"https://developers.pipedrive.com/docs/api/v1/Users#getCurrentUser\" target=\"blank\">/v1/users/me</a></code>,\n          <code><a href=\"https://developers.pipedrive.com/docs/api/v1/Users#getUser\" target=\"blank\">/v1/users/{id}</a></code>\n          </li>\n        <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Users#addUser\" target=\"blank\">POST /v1/users</a></code></li>\n        <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Users#updateUser\" target=\"blank\">PUT /v1/users/{id}</a></code></li>\n      </ul>\n\n<p>If you have any questions or comments, please let us know in <a href=\"https://devcommunity.pipedrive.com/\">the Developer’s Community</a>.</p>\n\n\t\t</div>\n</div>"
}
[/block]

We'll add a new field to <code>Users API.</code>

New field added to <code>Users API</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 12, 2024</span>\n    </div>\n    <div class=\"change-area\">\n      <p><b>What is changing?</b></p>\n      \n      <p><code>Label</code> field can store up to 100 values per entity.</p>\n      <p>The change affects the following deals-related endpoints:</p>\n              \n              <ul>\n                <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#addDeal\" target=\"blank\">POST /deals</a></code></li>\n                <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#duplicateDeal\" target=\"blank\">POST /deals/{id}/duplicate</a></code></li>\n                <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#updateDeal\" target=\"blank\">PUT /deals/{id}</a></code></li>\n                <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#mergeDeals\" target=\"blank\">PUT /deals/{id}/merge</a></code></li>\n              </ul>\n      \n      <p><b>Why is this changing?</b></p>\n      <p>We are changing the behavior of the <code>Label</code> field to improve API performance and ensure logic consistency across entities.</p>\n\n\n      <p>If you have any questions or comments, please let us know in <a href=\"https://devcommunity.pipedrive.com/\">the Developer’s Community</a>.</p>\n\n\t\t</div>\n</div>"
}
[/block]

We are limiting the number of values the Label field can store per Deal

Limiting the number of values the Label field can store per Deal

[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 12, 2024</span>\n    </div>\n    <div class=\"change-area\">\n      <p><b>What is changing?</b></p>\n      <ol>\n        <li>We’re adding a new Labels field (<code>label_ids</code>), with the type <code>set</code> for the following <b>Persons</b> and <b>Organizations</b> API endpoints. The <code>Labels</code> field <b>can store up to 100 values per entity</b>.</li>\n              \n              <ul>\n                <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#getDealParticipants\" target=\"blank\">GET /v1/deals/{id}/participants</a></code></li>\n                <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Organizations#getOrganizations\" target=\"blank\">GET /v1/organizations</a></code></li>\n                <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Organizations#getOrganization\" target=\"blank\">GET /v1/organizations/{id}</a></code></li>\n                <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Organizations#getOrganizationPersons\" target=\"blank\">GET /v1/organizations/{id}/persons</a></code></li>\n                <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Organizations#addOrganization\" target=\"blank\">POST /v1/organizations</a></code></li>\n                <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Organizations#updateOrganization\" target=\"blank\">PUT /v1/organizations/{id}</a></code></li>\n                <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Organizations#mergeOrganizations\" target=\"blank\">PUT /v1/organizations/{id}/merge</a></code></li>\n                <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Persons#getPersons\" target=\"blank\">GET /v1/persons</a></code></li>\n                <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Persons#getPerson\" target=\"blank\">GET /v1/persons/{id}</a></code></li>\n                <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Persons#addPerson\" target=\"blank\">POST /v1/persons</a></code></li>\n                <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Persons#updatePerson\" target=\"blank\">PUT /v1/persons/{id}</a></code></li>\n                <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Persons#mergePersons\" target=\"blank\">PUT /v1/persons/{id}/merge</a></code></li>\n              </ul>\n\n        <li>The endpoints <code><a href=\"https://developers.pipedrive.com/docs/api/v1/PersonFields#getPersonFields\" target=\"blank\">GET /v1/personFields</a></code> and <code><a href=\"https://developers.pipedrive.com/docs/api/v1/OrganizationFields#getOrganizationFields\" target=\"blank\">GET /v1/organizationFields</a></code> will return the definition of these fields</li>\n\n        <li>The old <code>Label</code> field and the new <code>Labels</code> field are updated synchronously based on these rules:</li>\n              \n              <ul>\n                <li>When the <code>Labels</code> field is updated, the <code>Label</code> field value will be set to the first value of the <code>Labels</code> field.</li>\n                <li>When the <code>Label</code> field is updated, the <code>Labels</code> field value will be overwritten by the <code>Label</code> field value.</li>\n              </ul>\n      </ol>\n      \n      <p><b>Why is this changing?</b></p>\n      <p>We’re changing the behavior of the existing Label field to prevent data inconsistency between the old and new fields.</p>\n\n\n      <p>If you have any questions or comments, please let us know in <a href=\"https://devcommunity.pipedrive.com/\">the Developer’s Community</a>.</p>\n\n\t\t</div>\n</div>"
}
[/block]

We are introducing a new Labels field for the Contacts.

Introducing a new Labels field and modifying the behavior of the existing Label field

[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\">June 10, 2024</span>\n    </div>\n    <div class=\"change-area\">\n      <p><b>What is changing?</b></p>\n      <p>The <b><code>duration</code></b> and <b><code>duration_unit</code></b> request body and response parameters will be removed from three deal-products endpoints on June 10th, 2024:</p>\n            <ul>\n              <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#getDealProducts\" target=\"blank\">GET /deals/{id}/products</a></code></li>\n              <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#addDealProduct\" target=\"blank\">POST /deals/{id}/products</a></code></li>\n              <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#updateDealProduct\" target=\"blank\">PUT /deals/{id}/products/{product_attachment_id}</a></code></li>\n            </ul>\n\n      <p><b>What is changing?</b></p>\n      <p>We’re replacing product durations with a new recurring products feature to allow users to attach products with a recurring billing cycle to deals. Users will be able to see the revenue of recurring products based on the billing frequency, cycles and start dates in reporting and forecasting via the Insights feature. This change should better serve the needs of our customers who sell subscriptions, licenses and recurring products and services.</p>\n      <p>New fields are now available for customers who <b>meet both</b> of the terms below:</p>\n      <ul>\n      \t<li>Have a subscription to Advanced plans and above.</li>\n        <li>Have previously used durations in the POST and PUT endpoints to edit the billing frequency and billing cycles (for example, a monthly subscription active for 12 months).</li>\n      </ul>\n      \n      <p>Instead of using product durations in product attachments as a time quantity, users can now use a combination of the product attachment quantity and the product unit fields. For example, a service charged by the number of work hours.</p>\n      \n      <p><b>Migration guide</b></p>\n      \n      <p>On the API change’s effective date of June 10th, 2024, the product attachments’ <b><code>duration</code></b> and <b><code>duration_unit</code></b> fields will be removed from the API.</p>\n      <ul>\n      \t<li>The product attachment <b><code>duration</code></b> field value will be merged into the <b><code>quantity</code></b> field value where <code>quantity = quantity * duration</code>.</li>\n        <li>The <b><code>duration_unit</code></b> values will be lost.</li>\n      </ul>\n      \n      <p>To migrate duration data to the new product subscriptions feature, it’s now possible to move values to the new <b><code>billing frequency</code></b> and <b><code>billing cycles</code></b> product attachment fields through these endpoints:</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>The fields are available in beta testing for users subscribed to the <b>Advanced</b> plan and above with previously used durations. Customers who aren’t included in the beta testing group can contact Pipedrive’s support and ask to be included. These are the new fields request body parameters:</p>\n      \n      <ul>\n      \t<li><b><code>billing_frequency</code></b></li>\n        \t<ul>\n      \t\t\t<li>Type: <code><b>string</b></code></li>\n        \t\t<li>Description: <code>How often a customer is billed for access to a service or product.</code></li>\n                <li>Values: <code><b>one-time</b>, <b>annually</b>, <b>semi-annually</b>, <b>quarterly</b>, <b>monthly</b>, <b>weekly</b></code></li>\n                \t<ul>\n      \t\t\t\t\t<li>Default: <code><b>one-time</b></code></li>\n                \t</ul>\n      \t\t</ul>\n        <li><b><code>billing_frequency_cycles</code></b></li>\n        \t<ul>\n      \t\t\t<li>Type: <code><b>number</b></code></li>\n        \t\t<li>Description: <code>The number of times the billing frequency repeats for a product in a deal. It can be set to null if the number of cycles is infinite, in which case the deal value will be incremented with 1 year of cycles.</code></li>\n                <li>Values: <code><b>null</b></code> or higher than <code><b>1</b></code>. When billing frequency is set to <code><b>one-time</b></code>, this value must be set to <code><b>null</b></code>.</li>\n                \t<ul>\n      \t\t\t\t\t<li>Default: <code><b>null</b></code></li>\n                \t</ul>\n      \t\t</ul>\n      </ul>\n      \n      <p>Some things to consider when copying the <b><code>duration</code></b> values to the new fields:</p>\n      \n      <ul>\n      \t<li>The <b><code>duration</code></b> value should be set to <code><b>1</b></code> so that it’s no longer considered for the deal value.</li>\n        <li>The <b>deal value</b> will change if there are <b>amount discounts</b> in either the updated product attachment or additional discounts.</li>\n        <li>For <b>companies</b> in the <b>Essential plan</b>, we recommend merging the <b><code>duration</code></b> value with <b><code>quantity</code></b> and updating the product unit with the <b><code>duration_unit</code></b> value.</li>\n      </ul>\n\n\n      <p>If you have any questions or comments, please let us know in <a href=\"https://devcommunity.pipedrive.com/\">the Developer’s Community</a>.</p>\n\n\t\t</div>\n</div>\n"
}
[/block]

{"product": ["API"], "features": ["Products”,”Deals"], label:”Update”, “email_description”: “We are deprecating duration and duration_unit request body and response parameters from three deal-products endpoints” }

Breaking change: Product durations deprecation

[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 02, 2024</span>\n    </div>\n    <div class=\"change-area\">\n<p><b>What is changing?</b></p>\n<p>We've introduced a new cursor-paginated endpoint to retrieve deal participants' changelog:\n</p>\n\n      <ul>\n        <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#getDealParticipantsChangelog\" target=\"blank\">GET /deals/{id}/participantsChangelog</a></code></li>\n      </ul>\n<p>This new endpoint is specifically tailored for accessing deal participants' changelog data. It's designed to enhance performance and reduce payload size compared to the existing \n      <code><a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#getDealUpdates\" target=\"blank\">GET /deals/{id}/flow</a></code> endpoint, which includes changelogs of various entity types.</p>\n\n<p><b>Why is it changing?</b></p>\n<p>In response to user feedback and to provide more granular access to changelog data, we're introducing this specialized endpoint. Other similar endpoints will follow suit. By offering dedicated routes for different types of changelog data, we aim to optimize data retrieval processes and improve overall API efficiency.</p>\n\n\n<p>If you have any questions or comments, please let us know in <a href=\"https://devcommunity.pipedrive.com/\">the Developer’s Community</a>.</p>\n\n\t\t</div>\n</div>"
}
[/block]

We are introducing a new /deals/{id}/participantsChangelog endpoint

New <code>/deals/{id}/participantsChangelog</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\">March 4, 2024</span>\n    </div>\n    <div class=\"change-area\">\n      <h3><b>What is changing?</b></h3>\n      <p>During the webhook creation via API, all non-reserved fields were stored as part of the webhook <b>“additional_data”</b> object and sent in the API request response.</p>\n      <p>Starting from March 4th, this field will be removed from the webhooks API responses.</p>\n      \n      <h3><b>Why is it changing?</b></h3>\n      <p><b>“additional_data”</b> is a legacy field that isn’t used in the webhook payloads delivery, which slows down events processing. Removing it from the webhooks configuration body will improve system performance and stability.</p>\n\n      <p>Reach out to us through the <a href=\"https://devcommunity.pipedrive.com/\" target=\"blank\">Developers’ Community</a> for any questions or comments.</p>\n\t</div>\n</div>"
}
[/block]

Contents

Changelog

Announced changes

Subscribe to our Changelog

Subscribe to our Changelog

Subscribe to our
Changelog