[block:html]
{
 "html": "<div class=\"chlog-box\">\n <div class=\"from-area\">\n Effective from: \n June 10, 2024\n </div>\n <div class=\"change-area\">\n What is changing?\n The <code>duration</code> and <code>duration_unit</code> request body and response parameters will be removed from three deal-products endpoints on June 10th, 2024:\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 What is changing?\n 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.\n New fields are now available for customers who meet both of the terms below:\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 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.\n \n Migration guide\n \n On the API change’s effective date of June 10th, 2024, the product attachments’ <code>duration</code> and <code>duration_unit</code> fields will be removed from the API.\n <ul>\n \t<li>The product attachment <code>duration</code> field value will be merged into the <code>quantity</code> field value where <code>quantity = quantity * duration</code>.</li>\n <li>The <code>duration_unit</code> values will be lost.</li>\n </ul>\n \n To migrate duration data to the new product subscriptions feature, it’s now possible to move values to the new <code>billing frequency</code> and <code>billing cycles</code> product attachment fields through these endpoints:\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 The fields are available in beta testing for users subscribed to the Advanced 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:\n \n <ul>\n \t<li><code>billing_frequency</code></li>\n \t<ul>\n \t\t\t<li>Type: <code>string</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>one-time, annually, semi-annually, quarterly, monthly, weekly</code></li>\n \t<ul>\n \t\t\t\t\t<li>Default: <code>one-time</code></li>\n \t</ul>\n \t\t</ul>\n <li><code>billing_frequency_cycles</code></li>\n \t<ul>\n \t\t\t<li>Type: <code>number</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>null</code> or higher than <code>1</code>. When billing frequency is set to <code>one-time</code>, this value must be set to <code>null</code>.</li>\n \t<ul>\n \t\t\t\t\t<li>Default: <code>null</code></li>\n \t</ul>\n \t\t</ul>\n </ul>\n \n Some things to consider when copying the <code>duration</code> values to the new fields:\n \n <ul>\n \t<li>The <code>duration</code> value should be set to <code>1</code> so that it’s no longer considered for the deal value.</li>\n <li>The deal value will change if there are amount discounts in either the updated product attachment or additional discounts.</li>\n <li>For companies in the Essential plan, we recommend merging the <code>duration</code> value with <code>quantity</code> and updating the product unit with the <code>duration_unit</code> value.</li>\n </ul>\n\n\n If you have any questions or comments, please let us know in <a href=\"https://devcommunity.pipedrive.com/\">the Developer’s Community</a>.\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 Effective from: \n February 02, 2024\n </div>\n <div class=\"change-area\">\nWhat is changing?\nWe've introduced a new cursor-paginated endpoint to retrieve deal participants' changelog:\n\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>\nThis 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.\n\nWhy is it changing?\nIn 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.\n\n\nIf you have any questions or comments, please let us know in <a href=\"https://devcommunity.pipedrive.com/\">the Developer’s Community</a>.\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 Effective from: \n March 4, 2024\n </div>\n <div class=\"change-area\">\n <h3>What is changing?</h3>\n During the webhook creation via API, all non-reserved fields were stored as part of the webhook “additional_data” object and sent in the API request response.\n Starting from March 4th, this field will be removed from the webhooks API responses.\n \n <h3>Why is it changing?</h3>\n “additional_data” 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.\n\n Reach out to us through the <a href=\"https://devcommunity.pipedrive.com/\" target=\"blank\">Developers’ Community</a> for any questions or comments.\n\t</div>\n</div>"
}
[/block]

Removing <code>additional_data</code> from webhooks API responses

[block:html]
{
 "html": "<div class=\"chlog-box\">\n <div class=\"from-area\">\n Effective from: \n March 25, 2024\n </div>\n <div class=\"change-area\">\n We are changing how deals, leads and projects can be linked to activities.\n \nWhat is changing?\nAt the moment when creating or updating an activity via Public API it is possible to link it with a deal, lead and a project at the same time. \nAfter the changes are applied, it will only be possible to link an activity to one of the mentioned entities at once. The change affects the following 2 endpoints:\n\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>\nIt means that an activity can only be linked either to a deal, lead or a project. \nIf passing several of the mentioned entities in the payload the following hierarchy for linking will be used:\n <ul>\n <li>If <code>deal_id</code> is passed together with <code>lead_id</code> or <code>project_id</code> the activity will be only linked to the deal</li>\n <li>If <code>lead_id</code> is passed together with <code>project_id</code> the activity will be only linked to the lead</li>\n </ul>\n\nWhat is changing?\nActivities have always been intended to work like this but this limitation has never been implemented in our public API. This brings confusion for our users because Pipedrive UI has been built considering this limitation.\n\n\nIf you have any questions or comments, please let us know in <a href=\"https://devcommunity.pipedrive.com/\">the Developer’s Community</a>.\n\n\t\t</div>\n</div>"
}
[/block]

We are changing how deals, leads and projects can be linked to activities

Changes to activities connected entities

[block:html]
{
 "html": "<div class=\"chlog-box\">\n <div class=\"from-area\">\n Effective from: \n January 26, 2024\n </div>\n <div class=\"change-area\">\n <h3>What is changing?</h3>\n We’ve introduced new read-only and full-access OAuth scopes for Webhooks, which allow apps to create, fetch and delete webhooks on users’ behalf.\n \n webhooks:read\n When the <code>webhooks:read</code> scope is selected, an app can access the endpoint below, allowing it to list webhooks associated with its user.\n <ul>\n <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Webhooks#getWebhooks\" target=\"blank\">GET /v1/webhooks</a></code></li>\n </ul>\n \n webhooks:full\n When the <code>webhooks:full</code> scope is selected, an app can access the endpoints below, allowing it to list webhooks associated with its user, create and delete webhooks for them.\n <ul>\n <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Webhooks#getWebhooks\" target=\"blank\">GET /v1/webhooks</a></code></li>\n <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Webhooks#addWebhook\" target=\"blank\">POST /v1/webhooks</a></code></li>\n <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Webhooks#deleteWebhook\" target=\"blank\">DELETE /v1/webhooks/{id}</a></code></li>\n </ul>\n Learn more about Pipedrive webhooks <a href=\"https://pipedrive.readme.io/docs/guide-for-webhooks-v2\" target=\"blank\">here</a> and about scopes and permission <a href=\"https://pipedrive.readme.io/docs/marketplace-scopes-and-permissions-explanations\" target=\"blank\">here</a>.\n \n <h3>Why is it changing?</h3>\n We’ve implemented this change to allow flexible, more granular access to users’ data and improve app accessibility.\n \n <h3>Migration guide</h3>\n Please note that webhook-specific endpoints are still available under the <code>admin</code> scope. No changes were made to existing public or private apps.\n We’re also working on a separate solution that would allow apps with webhooks to switch from the <code>admin</code> scope to a new scope without asking users to re-install the app. We’ll share more details about it soon!\n If you still want to add or remove the scopes of an approved or published app, <a href=\"https://pipedrive.readme.io/docs/marketplace-updating-the-existing-app#changing-the-scopes\" target=\"blank\">learn how changing the scopes will affect your app's existing users</a>.\n If you have any questions or comments, please let us know in the <a href=\"https://devcommunity.pipedrive.com/\" target=\"blank\">Developers’ Community</a>.\n \n\t\t</div>\n</div>"
}
[/block]

Introducing new OAuth scopes for Webhooks

[block:html]
{
 "html": "<div class=\"chlog-box\">\n <div class=\"from-area\">\n Effective from: \n January 16, 2024\n </div>\n <div class=\"change-area\">\n We’ve introduced new endpoints to allow you to integrate video-calling apps into Pipedrive through a <a href=\"https://pipedrive.readme.io/docs/video-calling-app-extension\">video calling app extension</a>.\n <ul>\n <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Meetings#saveUserProviderLink\" target=\"blank\">POST /meetings/userProviderLinks</a></code> – to link a user to the installed video call integration, allowing them to create video call links for their activities.</li>\n <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Meetings#deleteUserProviderLink\" target=\"blank\">DELETE /meetings/userProviderLinks/{id}</a></code> – to unlink a user from the video call integration when uninstalling it.</li>\n </ul>\n \n\t\tIf you have any questions or comments, please let us know in <a href=\"https://devcommunity.pipedrive.com/\">the Developer’s Community</a>.\n\n\t\t</div>\n</div>"
}
[/block]

We are introducing endpoints for linking and unlinking a user to/from a video call integration.

New <code>/userProviderLinks</code> endpoints

[block:html]
{
 "html": "<div class=\"chlog-box\">\n <div class=\"from-area\">\n Effective from: \n March 18, 2024\n </div>\n <div class=\"change-area\">\n \n What is changing?\n \n From March 18, 2023, we are starting to restrict editing of soft-deleted deals via <code><a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#updateDeal\">PUT deals/{id}</a></code> endpoint. This means that it is not possible to edit any fields (except restoring the deal) once the <code>status</code> of the deal has changed to <code>deleted</code>. In order to be able to edit that soft deleted deal, you must first restore that deal.\n \n Why is it changing?\n \n We already have similar behavior for <code><a href=\"https://developers.pipedrive.com/docs/api/v1/Persons#updatePerson\">PUT persons/{id}</a></code> and <code><a href=\"https://developers.pipedrive.com/docs/api/v1/Organizations#updateOrganization\">PUT organizations/{id}</a></code>. Editing fields after the entity has been soft deleted will push the deadline for permanent deletion further which may cause confusion and additional issues for our customers.\n \n If you have any questions or comments, please let us know in <a href=\"https://devcommunity.pipedrive.com/\">the Developer’s Community</a>.\n \n </div>\n</div>"
}
[/block]

We are starting to restrict editing of soft deleted deals

Breaking change: update to the behavior of <code>PUT deals/{id}</code> endpoint for soft-deleted deals

[block:html]
{
 "html": "<div class=\"chlog-box\">\n <div class=\"from-area\">\n Effective from: \n December 18, 2023\n </div>\n <div class=\"change-area\">\n \n We’ve introduced a new body parameter in the <code><a href=\"https://developers.pipedrive.com/docs/api/v1/CallLogs#addCallLog\">POST /callLogs</a></code> endpoint allowing you to associate call logs with leads.\n \n What was added\n \n From December 18, 2023, you can add a new body parameter to the <code><a href=\"https://developers.pipedrive.com/docs/api/v1/CallLogs#addCallLog\">POST /callLogs</a></code> endpoint:\n <ul>\n <li><code>lead_id</code> - The ID of the lead the call log is associated with in UUID format (optional)</li>\n </ul>\n \n Please note that a single call log can only be associated with either a deal or a lead, not both at the same time.\n If you have any questions or comments, please let us know in <a href=\"https://devcommunity.pipedrive.com/\">the Developer’s Community</a>.\n \n </div>\n</div>"
}
[/block]

We are introducing a new optional parameter in POST /callLogs endpoint

New optional parameter in <code>POST /callLogs</code> endpoint

[block:html]
{
 "html": "<div class=\"chlog-box\">\n <div class=\"from-area\">\n Effective from: \n October 18, 2023\n </div>\n <div class=\"change-area\">\n What is new?\n We’re launching three new API resources with a range of endpoints to help you modify the data around the Projects feature space, allowing integrations and automations to join in on providing solutions in the project and task management problem space. The endpoints are tied with the Projects add-on which has to be enabled for the functionality to be used.\n\n <a href=\"https://developers.pipedrive.com/docs/api/v1/Projects\" target=\"blank\">Projects API</a> allows to create and manage ongoing, completed or canceled projects attached to an organization, person or to deals. Each project has an owner and must be placed in a phase. Each project consists of standard data fields but can also contain a number of custom fields. The custom fields can be recognized by long hashes as keys.\n \n <a href=\"https://developers.pipedrive.com/docs/api/v1/ProjectsTemplates\" target=\"blank\">ProjectsTemplates API</a> allows to have a reusable and dynamic structure to simplify creation of a project. Project templates can contain information about activities, tasks and groups that will be used when creating a project. Currently, only GET functionality is available.\n \n <a href=\"https://developers.pipedrive.com/docs/api/v1/Tasks\" target=\"blank\">Tasks API</a> allows to create and manage actions that need to be completed inside a project. A task must be associated with a project. Tasks have an optional due date, can be assigned to a user and can have subtasks.\n\n \n All new endpoints support querying based on <a href=\"https://pipedrive.readme.io/docs/core-api-concepts-pagination#cursor-pagination\" target=\"blank\">cursor pagination</a>.\nThe endpoints are also included in two new OAuth scopes: Projects read and Projects full, see the full division of endpoints in scopes <a href=\"https://pipedrive.readme.io/docs/marketplace-scopes-and-permissions-explanations\" target=\"blank\">here</a>.\n\n \n Timeline of the launch\n \n We’re releasing the public BETA today, October 18th, and the API will be available for usage and testing on all accounts. We’ll notify you here in the changelog once the full version of the API is released, so remember to subscribe.\nKeep in mind that between the BETA and the full release of the API, the endpoints are subject to changes.\n \n We are eager to hear your feedback, questions or comments in\n<a href=\"https://devcommunity.pipedrive.com/\" target=\"_self\">the Developers’ Community</a>.\n </div>\n</div>"
}
[/block]

{“product”: [“API”], “features”: [“Projects, ProjectTemplates, Tasks”], “email_description”: “We’re happy to share the public BETA launch of Project API together with ProjectTemplates API and Tasks API.“}

Introducing Projects API in public BETA

[block:html]
{
 "html": "<div class=\"chlog-box\">\n <div class=\"from-area\">\n Effective from: \n September 7, 2023\n </div>\n <div class=\"change-area\">\n \n <blockquote class=\"callout callout_info\" theme=\"📘\">📘We've decided to retract the change to Deals API: After careful consideration and valuable input from feedback from our API users, we have decided to retract the previously announced breaking change to the API.Why are we retracting the change?Upon reviewing the concerns raised, it became evident that the implementation of workarounds to get the exact time of deal closures would impose undue burdens on our technology partners and customers. Therefore, we have opted to maintain the current functionality, where the relevant fields will continue to return full datetime values as they presently do.Will this retraction affect those using the existing API?There will be no alterations to the current API behavior, and consequently, no adverse effects will arise for those utilizing the established client code.What about those who have already made adjustments towards the new API behavior?For those who have proactively updated their code in anticipation of the new API specifications, firstly, thank you for your proactive work. With this retraction, we advise reverting any modifications pertaining to the now-retracted change. The API will continue to function as it did prior to the announcement, negating the necessity for these adjustments.We apologize for any inconvenience this announcement may have caused and are committed to ensuring that our API remains user-friendly. Your continued support, feedback and understanding are greatly appreciated.We at Pipedrive are committed to ensuring that every customer and partner has a stable and trustworthy experience with all of our products and services. Therefore, we’ll continue with transparent communications regarding our API and developer platform.</blockquote>\n \n What is changing?\n The data type for the <code>close_time</code>, <code>won_time</code>, <code>first_won_time</code>, and <code>lost_time</code> response fields will be changed from <code>datetime</code> to <code>date</code> for the following Deals API endpoints:\n <ul>\n <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#getDeals\" target=\"blank\">GET /deals</a></code></li>\n <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#getDealsTimeline\" target=\"blank\">GET /deals/timeline</a></code></li>\n <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#getDeal\" target=\"blank\">GET /deals/{id}</a></code></li>\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 <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Persons#getPersonDeals\" target=\"blank\">GET /persons/{id}/deals</a></code></li>\n <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Pipelines#getPipelineDeals\" target=\"blank\">GET /pipelines/{id}/deals</a></code></li>\n <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Products#getProductDeals\" target=\"blank\">GET /products/{id}/deals</a></code></li>\n <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Recents#getRecents\" target=\"blank\">GET /recents</a></code></li>\n <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Stages#getStageDeals\" target=\"blank\">GET /stages/{id}/deals</a></code></li>\n </ul>\n \n \n Similarly, the <code>won_time</code> and <code>lost_time</code> response fields will be changed from <code>datetime</code> to <code>date</code> in the <code><a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#getDealsCollection\" target=\"blank\">GET /deals/collection</a></code> endpoint.\n \n The update will be gradually rolled out between December 6 and December 13, 2023.\n \n If you have any questions or comments, let us know in <a href=\"https://devcommunity.pipedrive.com/\" target=\"_self\">the Developers' Community</a>.\n \n \n </div>\n</div> "
}
[/block]

We are updating the data type for four deals-related response fields from datetime to date.

Contents

Changelog

Announced changes

Subscribe to our Changelog

Subscribe to our Changelog

Subscribe to our
Changelog