[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 5, 2022</span>\n    </div>\n    <div class=\"change-area\">\n      <p>Integrate a <b>messaging service directly</b> into Pipedrive with our new Messaging app extension. \n        To enable apps to do this, we’ve created a <b>deep integration point</b> with our <a href=\"https://support.pipedrive.com/en/article/messaging-inbox\">Messaging inbox</a> inside the Leads Inbox of Pipedrive.\n</p>\n      <figure><span aria-label=\"Messaging inbox - active conversation with details from different apps\" class=\"img\" role=\"button\" tabindex=\"0\"><img src=\"https://files.readme.io/2034d9e-app_inbox_2.png\" alt=\"Messaging inbox - active conversation with details from different apps\" title=\"app_inbox (2).png\" class=\"\" align=\"\" caption=\"\" height=\"auto\" width=\"auto\" loading=\"lazy\">\n        <span autofocus=\"\" class=\"lightbox\" role=\"dialog\" tabindex=\"0\"><span class=\"lightbox-inner\"><img src=\"https://files.readme.io/2034d9e-app_inbox_2.png\" title=\"Click to close...\" class=\"lightbox-img\" align=\"\" caption=\"\" height=\"auto\" width=\"auto\" alt=\"Messaging inbox - active conversation with details from different apps\" loading=\"lazy\">\n          </span></span></span><figcaption><p>Messaging inbox - active conversation with details from different apps</p></figcaption></figure>\n      \n      <p>By using the messaging extension, app users can send, view and delete messages right inside Pipedrive, whilst all of their communications are synced with the messaging service. Apps with messaging extension can also be shared company-wide.\n</p>\n      <p>The extension and its access to Messaging inbox go through a manifest-based connection and public API endpoints. This makes the extension controllable from the provider’s side (user action done in service), the user’s side (action done in Pipedrive, sent to messaging service) and the app’s side (action done by app to mimic service conditions in Pipedrive).\n</p>\n      <p>With this extension, we’ve added a couple of new things: \n</p>\n      <p><b>In Developer Documentation</b></p>\n      <p>You can find a complete overview of \n        <a href=\"https://pipedrive.readme.io/docs/messaging-app-extension\" target=\"_self\">Messaging app extension</a>, \n        <a href=\"https://pipedrive.readme.io/docs/implementing-messaging-app-extension\" target=\"_self\">how to implement the manifest</a> and \n       <a href=\"https://pipedrive.readme.io/docs/error-codes-and-troubleshooting-for-messaging-app-extension\" target=\"_self\">custom error codes as well as troubleshooting</a>.\n</p>\n       <p><b>In API Reference</b></p>\n      <p>We’ve added the <a href=\"https://developers.pipedrive.com/docs/api/v1/Channels\" target=\"_self\">Channels API</a> with 4 new endpoints. The endpoints enable you to manage and interact with the channel’s conversations, participants and messages inside the Pipedrive Messaging inbox. Apps can call these endpoints to forward received messages and conversations from the messaging provider service to Pipedrive.</p>\n      <ul>\n        <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Channels#addChannel\" target=\"_self\">POST /v1/channels</a></code></li>\n         <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Channels#receiveMessage\" target=\"_self\">POST /v1/channels/messages/receive</a></code></li>\n         <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Channels#deleteChannel\" target=\"_self\">DELETE /v1/channels/{id}</a></code></li>\n         <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Channels#deleteConversation\" target=\"_self\">DELETE /v1/channels/{channel-id}/conversations/{conversation-id}</a></code></li>\n      </ul>\n       <p><b>In OAuth Scopes </b></p>\n      <p>We’ve added the <code>Messengers integrations</code> access scope, which is key to building the Messaging app extension. By enabling this scope for your app, users can now grant your app access to their data for connection building between messaging channels. This scope also covers all Channels API endpoints mentioned above.\n</p>\n        </div>\n</div>"
}
[/block]

New feature: Messaging app extension

[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 28, 2022</span>\n    </div>\n    <div class=\"change-area\">\n      <p>1. We included <code>Workflow automation</code> as a success response field for the <code><a href=\"https://developers.pipedrive.com/docs/api/v1/LeadSources#getLeadSources\" target=\"_self\">GET /leadSources</a></code> endpoint.\n      </p>\n      \n      <p>2. <code>Leadbooster</code> is now documented as a possible lead source for the <a href=\"https://developers.pipedrive.com/docs/api/v1/LeadSources\" target=\"_self\">LeadSources API</a>:\n        </p>\n\t\t\t\t<ul>\n         \t<li><code>Leadbooster</code> - the value assigned to leads sourced from the Chatbot feature</li>\n      </ul>\n      \n      <p>3. We updated the data type label of the <code>visible_to</code> body parameter from <code>number</code> to <code>string</code> to reflect reality for the following endpoints:\n        </p>\n\t\t\t<ul>\n        <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#addDeal\" target=\"_self\">POST /deals</a></code></li>\n        <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#updateDeal\" target=\"_self\">PUT /deals/{id}</a></code></li>\n        <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Leads#addLead\" target=\"_self\">POST /leads</a></code></li>\n        <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Leads#updateLead\" target=\"_self\">PATCH /leads/{id}</a></code></li>\n        <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Organizations#addOrganization\" target=\"_self\">POST /organizations</a></code></li>\n        <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Organizations#updateOrganization\" target=\"_self\">PUT /organizations/{id}</a></code></li>\n        <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Persons#addPerson\" target=\"_self\">POST /persons</a></code></li>\n        <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Persons#updatePerson\" target=\"_self\">PUT /persons/{id}</a></code></li>\n      </ul>\n     \n      <p>4. The <code>visible_to</code> response field’s documentation was updated from <code>number</code> to <code>string</code> type to reflect reality for 2 endpoints:\n      </p>\n      <ul>\n        <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Organizations#addOrganization\" target=\"_self\">POST /organizations</a></code></li>\n        <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Organizations#updateOrganization\" target=\"_self\">PUT /organizations/{id}</a></code></li>\n        </ul>\n    </div>\n</div>"
}
[/block]

April release notes

April 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\">March 31, 2022</span>\n    </div>\n    <div class=\"change-area\">\n      <p>1. We documented the <code>everyone</code> query parameter for the <code><a href=\"https://developers.pipedrive.com/docs/api/v1/Stages#getStage\" target=\"_self\">GET /stages/{id}</a></code> endpoint.\n</p>\n      <p>2. The <code>pipeline_id</code> body parameter is now documented for the <code><a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#addDeal\" target=\"_self\">POST /deals</a></code> endpoint.\n</p>\n      <p>3. We updated the description of the <code>rotten_flag</code> parameter from <b>integer</b> to <b>boolean</b> type to reflect reality for  the <code><a href=\"https://developers.pipedrive.com/docs/api/v1/Stages#addStage\" target=\"_self\">POST /stages </a></code> and <code><a href=\"https://developers.pipedrive.com/docs/api/v1/Stages#updateStage\" target=\"_self\">PUT /stages/{id}</a></code> endpoints.\n</p>\n      <p>4. The <code>leads:full</code> scope now allows apps to have access to the <code><a href=\"https://developers.pipedrive.com/docs/api/v1/Leads#searchLeads\" target=\"_self\">GET leads/search</a></code> endpoint.\n</p>\n       \n       </div>\n</div>"
}
[/block]

{"product": ["API", "Authentication"], "features": ["Stages", "Deals", "Leads", "Scopes"]}

March 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\">March 23, 2022</span>\n    </div>\n    <div class=\"change-area\">\n      <p>We have added a new Billing resource with one new <code>GET</code> endpoint to our API Reference.\n</p>\n      <p><b>What is being added?\n</b></p>\n      <p>The new Billing API currently includes the following endpoint:\n</p>\n      <ul><li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Billing#getCompanyAddons\" target=\"_self\">GET /billing/subscriptions/addons\n        </a>\n        </code>\n        </li>\n      </ul>\n      <p>The endpoint has been also added to the <code>users:read</code> <a href=\"https://pipedrive.readme.io/docs/marketplace-scopes-and-permissions-explanations\" target=\"_self\"> OAuth scope</a>.\n</p>\n      \n      <p>The new endpoint allows an integration to retrieve the add-ons of a single company. \n        This means that the app will be able to get information around access to additional Pipedrive products the customer is using (e.g. Campaigns, LeadBooster) \n        and seamlessly provide the customer with more functionality directly inside the integration.\n</p>\n      \n       </div>\n</div>"
}
[/block]

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

Introducing Billing API

[block:html]
{
  "html": "<div class=\"chlog-box\">\n    <div class=\"from-area\">\n        <span class=\"from-label\">Effective from:</span><br>\n        <span class=\"from-date\">March 30, 2022</span>\n    </div>\n    <div class=\"change-area\">\n      <p>Starting from March 30th, 2022 open <b>deals</b> and <b>custom fields</b> that are created via our public API will be counted towards a new limit for Pipedrive accounts. This means that customers will have a <a href=\"https://support.pipedrive.com/en/article/usage-limits-in-pipedrive\" target=\"_self\">set amount of open deals and custom fields they can have for their accounts depending on their account plan</a>.\n</p>\n       <p>If the customer reaches a limit on their account, all requests made to the following 6 endpoints will start to respond with a <code>403</code> error message. \n</p>\n      <ul>\n        <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#addDeal\" target=\"_self\">POST /deals</a></code></li>\n        <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#duplicateDeal\" target=\"_self\">POST /deals/{id}/duplicate</a></code></li>\n        <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/DealFields#addDealField\" target=\"_self\">POST /dealsFields</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#addPersonField\" target=\"_self\">POST /productFields</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      </ul>\n      \n       <p>The error message will follow a new structure for these 6 endpoints and contain a new parameter <code>code</code>. </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\">\"Couldn't add the deal. Open deals limit reached.\"</span>,\n    <span class=\"cm-property\">\"error_info\"</span>: <span class=\"cm-string\">\"Please check developers.pipedrive.com for more information about Pipedrive API.\"</span>,\n    <span class=\"cm-property\">\"data\"</span>: <span class=\"cm-atom\">null</span>,\n    <span class=\"cm-property\">\"additional_data\"</span>: <span class=\"cm-atom\">null</span>,\n    <span class=\"cm-property\">\"code\"</span>: <span class=\"cm-string\">\"feature_capping_deals_limit\"</span>\n}\n</div></code></pre></div></div>\n      \n      <p>We want to ensure that Pipedrive users get the most from using apps and continue to have a fluid experience between multiple platforms. Therefore, we will be tracking clients who receive the 403 error with the specified code and <b>trigger an email to direct them to upgrade on Pipedrive’s side</b>.\n</p>\n      <p>\nTo ensure that customers are aware that the entity creation might fail on the app’s side, we highly recommend you implement a redirect or an error message screen to provide this information to your users. </p>\n      \n       </div>\n</div>"
}
[/block]

New error message and code for POST Deals and Custom Fields 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\">March 17, 2022</span>\n    </div>\n    <div class=\"change-area\">\n      \n      <p> <code>products:full</code> and <code>products:read</code> scopes now allow apps to have access to a new endpoint: </p>\n<ul><li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Products#getProductUsers\" target=\"_self\">GET products/{id}/permittedUsers</a></code> - for retrieving the users who are allowed to access a product.</li></ul>\n      \n      <p>You can read more about the scopes and permission explanations <a href=\"https://pipedrive.readme.io/docs/marketplace-scopes-and-permissions-explanations\" target=\"_self\">here</a>.</p>\n<p>If you wish to update the scopes of an already approved or published app, be sure to <a href=\"https://pipedrive.readme.io/docs/marketplace-updating-the-existing-app#changing-the-scopes\" target=\"_self\">learn how changing the scopes will affect your app's existing users</a>.</p>\n        </div>\n</div>"
}
[/block]

{"product": ["Authorization"], "features": ["Products", "Scopes"]}

New endpoint in <code>products:full</code> and <code>products:read</code> scopes

[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 1, 2022</span>\n    </div>\n    <div class=\"change-area\">\n      <p>We have made updates to the <a href=\"https://developers.pipedrive.com/docs/api/v1/Leads\" target=\"_self\">Leads API </a>:</p>\n       <p>1. We documented a new endpoint to improve the experience of using Leads:</p>\n      <ul>\n        <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Leads#searchLeads\" target=\"_self\">GET /leads/search</a></code> - for searching leads by title, notes and/or custom fields</li>\n      </ul>\n       <p>2. Three new query parameters are available in the <code><a href=\"https://developers.pipedrive.com/docs/api/v1/Leads#getLeads\" target=\"_self\">GET /leads</a></code> endpoint:\n</p>\n       <ul>\n         <li><code>filter_id</code> - for retrieving leads by a filter</li>\n          <li><code>owner_id</code> - for retrieving leads by their owner</li>\n          <li><code>sort</code> - for sorting leads by a field name and a sorting mode</li>\n      </ul>\n      <p>3. We added the <code>lead_id</code> body parameter to support linking leads to activities for the following Activities endpoints:\n</p>\n       <ul>\n        <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Activities#addActivity\" target=\"_self\">POST /activities</a></code></li>\n          <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Activities#updateActivity\" target=\"_self\">PUT /activities/{id}</a></code></li>\n      </ul>\n      <p>4. <code>leads</code> is now documented as a possible value of the <code>type</code> parameter for these Filters endpoints:</p>\n       <ul>\n         <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Filters#getFilters\" target=\"_self\">GET /filters</a></code></li>\n          <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Filters#addFilter\" target=\"_self\">POST /filters</a></code></li>\n      </ul>\n\n        </div>\n</div>"
}
[/block]

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

New endpoint and functionality in 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\">February 28, 2022</span>\n    </div>\n    <div class=\"change-area\">\n      <p>1. We updated the description of the <code>visible_to</code> body parameter for the following endpoints:\n</p>\n      <ul>\n         <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#addDeal\" target=\"_self\">POST /deals</a></code></li>\n            <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#updateDeal\" target=\"_self\">PUT /deals/{id}</a></code></li>\n               <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Leads#addLead\" target=\"_self\">POST /leads</a></code></li>\n                  <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Leads#updateLead\" target=\"_self\">PATCH /leads/{id}</a></code></li>\n                     <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Organizations#addOrganization\" target=\"_self\">POST /organizations</a></code></li>\n                        <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Organizations#updateOrganization\" target=\"_self\">PUT /organizations/{id}</a></code></li>\n                           <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Persons#addPerson\" target=\"_self\">POST /persons</a></code></li>\n                              <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Persons#updatePerson\" target=\"_self\">PUT /persons/{id}</a></code></li>\n                                 <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Products#addProduct\" target=\"_self\">POST /products</a></code></li>\n                                    <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Products#updateProduct\" target=\"_self\">PUT /products/{id}</a></code></li>\n                                      \n      </ul>\n      <p>Similarly, the description of the <code>value</code> body parameter was updated for the <code><a href=\"hhttps://developers.pipedrive.com/docs/api/v1/Roles#addOrUpdateRoleSetting\" target=\"_self\">POST /roles/{id}/settings</a></code> endpoint.\n</p>\n      \n      <p>Possible values for the visibility setting are <code>1</code>, <code>3</code>, <code>5</code> and <code>7</code>:</p>\n      <p><b>Essential / Advanced plan</b></p>\n      <div class=\"rdmd-table\"><div class=\"rdmd-table-inner\"><table><thead><tr><th style=\"text-align:left\"><p>Value</p></th><th style=\"text-align:left\"><p>Description</p></th></tr></thead><tbody><tr><td style=\"text-align:left\"><p><code class=\"rdmd-code lang- theme-light\" data-lang=\"\" name=\"\"><button aria-label=\"Copy Code\" class=\"rdmd-code-copy fa\"></button><span class=\"cm-s-neo\">1</span></code></p></td><td style=\"text-align:left\"><p>Owner &amp; followers</p></td></tr><tr><td style=\"text-align:left\"><p><code class=\"rdmd-code lang- theme-light\" data-lang=\"\" name=\"\"><button aria-label=\"Copy Code\" class=\"rdmd-code-copy fa\"></button><span class=\"cm-s-neo\">3</span></code></p></td><td style=\"text-align:left\"><p>Entire company</p></td></tr></tbody></table></div></div>\n      <br>\n      <p><b>Professional / Enterprise plan</b></p>\n      <div class=\"rdmd-table\"><div class=\"rdmd-table-inner\"><table><thead><tr><th style=\"text-align:left\"><p>Value</p></th><th style=\"text-align:left\"><p>Description</p></th></tr></thead><tbody><tr><td style=\"text-align:left\"><p><code class=\"rdmd-code lang- theme-light\" data-lang=\"\" name=\"\"><button aria-label=\"Copy Code\" class=\"rdmd-code-copy fa\"></button><span class=\"cm-s-neo\">1</span></code></p></td><td style=\"text-align:left\"><p>Owner only</p></td></tr><tr><td style=\"text-align:left\"><p><code class=\"rdmd-code lang- theme-light\" data-lang=\"\" name=\"\"><button aria-label=\"Copy Code\" class=\"rdmd-code-copy fa\"></button><span class=\"cm-s-neo\">3</span></code></p></td><td style=\"text-align:left\"><p>Owner's visibility group</p></td></tr><tr><td style=\"text-align:left\"><p><code class=\"rdmd-code lang- theme-light\" data-lang=\"\" name=\"\"><button aria-label=\"Copy Code\" class=\"rdmd-code-copy fa\"></button><span class=\"cm-s-neo\">5</span></code></p></td><td style=\"text-align:left\"><p>Owner's visibility group and sub-groups</p></td></tr><tr><td style=\"text-align:left\"><p><code class=\"rdmd-code lang- theme-light\" data-lang=\"\" name=\"\"><button aria-label=\"Copy Code\" class=\"rdmd-code-copy fa\"></button><span class=\"cm-s-neo\">7</span></code></p></td><td style=\"text-align:left\"><p>Entire company</p></td></tr></tbody></table></div></div>\n      <br>\n      <p>2. We removed the deprecated <code>write_flag</code> property from the responses of all Mailbox endpoints:</p>\n      <ul>\n      <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Mailbox#getMailMessage\" target=\"_self\">GET /mailbox/mailMessages/{id}</a></code></li>\n        <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Mailbox#getMailThreads\" target=\"_self\">GET /mailbox/mailThreads</a></code></li>\n          <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Mailbox#getMailThread\" target=\"_self\">GET /mailbox/mailThreads/{id}</a></code></li>\n            <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Mailbox#getMailThreadMessages\" target=\"_self\">GET /mailbox/mailThreads/{id}/mailMessages</a></code></li>\n              <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Mailbox#updateMailThreadDetails\" target=\"_self\">PUT /mailbox/mailThreads/{id}</a></code></li>\n                <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Mailbox#deleteMailThread\" target=\"_self\">DELETE /mailbox/mailThreads/{id}</a></code></li>\n      </ul>\n      <br>\n      <p>3. We documented <code>required</code> labels for the body parameters of the following endpoints:\n</p><ul>\n      <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#addDealProduct\" target=\"_self\">POST /deals/{id}/products</a></code> - <code>item_price</code> and <code>quantity</code> are required\n</li>\n        <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#updateDealProduct\" target=\"_self\">PUT /deals/{id}/products/{product_attachment_id}</a></code>- <code>item_price</code> and <code>quantity</code> are required\n</li>\n          <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Notes#addNote\" target=\"_self\">POST /notes</a></code> - <code>content</code> is required\n</li>\n            <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Organizations#addOrganization\" target=\"_self\">POST /organizations</a></code> - <code>name</code> is required\n</li>\n              <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Persons#addPerson\" target=\"_self\">POST /persons</a></code> -<code> name</code> is required\n</li>\n                <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Persons#deletePersons\" target=\"_self\">DELETE /persons</a></code> - <code>ids</code> is required</li>\n                  <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Products#addProduct\" target=\"_self\">POST /products</a></code> -<code> name</code> is required</li>\n                 \n      </ul>\n      </div>\n</div>"
}
[/block]

February 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 25, 2022</span>\n    </div>\n    <div class=\"change-area\">\n      \n      <p>The Account Settings access is a free seat in Pipedrive without access to Deals, but allows access to user management, billing details, company settings, security settings, and personal settings.</p>\n      <p><b>What is changing?</b></p>\n\n      <ul>\n        <li><p>Users without access to Deals can now access all <code>GET</code> endpoints of the \n          Users API to view users’ data. This includes the following endpoints:</p>\n          <ul>\n            <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Users#getUsers\" target=\"_self\">GET /users</a></code></li>\n            <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Users#findUsersByName\" target=\"_self\">GET /users/find</a></code></li>\n            <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Users#getCurrentUser\" target=\"_self\">GET /users/me</a></code></li>\n            <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Users#getUser\" target=\"_self\">GET /users/{id}</a></code></li>\n            <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Users#getUserFollowers\" target=\"_self\">GET /users/{id}/followers</a></code></li>\n            <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Users#getUserPermissions\" target=\"_self\">GET /users/{id}/permissions</a></code></li>\n            <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Users#getUserRoleAssignments\" target=\"_self\">GET /users/{id}/roleAssignments</a></code></li>\n            <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Users#getUserRoleSettings\" target=\"_self\">GET /users/{id}/roleSettings</a></code></li>\n          \n          </ul>\n        </li>\n        <br>\n        <li><p>Endpoints for adding and modifying users now require the user to have the Account Settings access. \n            It means that being an <b>admin</b> type user only, you'll no longer have access to the <code>POST</code>, <code>PUT</code> and <code>DELETE</code> endpoints of the Users API, including:\n          </p>\n          <ul>\n          <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Users#addUser\" target=\"_self\">POST /users</a></code></li>\n            <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Users#addUserRoleAssignment\" target=\"_self\">POST /users/{id}/roleAssignments</a></code></li>\n            <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Users#updateUser\" target=\"_self\">PUT /users/{id}</a></code></li>\n            <li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Users#deleteUserRoleAssignment\" target=\"_self\">DELETE /users/{id}/roleAssignments</a></code></li>\n          </ul>\n\n        </li>\n      </ul>\n      \n <p><b>Why is it changing?</b></p>\n      <p>This change unifies the Users API’s access to the Account Settings functionality of the Pipedrive web app to ensure consistency between the API and the web app.\n</p>\n      \n       <p><b>Who will be affected?</b></p>\n      <p>Anyone without Deals access who wishes to view users’ data or who relies on the modifying and adding endpoints of the Users API as an admin user only.\nYou can read more about <a href=\"https://support.pipedrive.com/en/article/global-user-management\">user types in Pipedrive</a> and <a href=\"https://support.pipedrive.com/en/article/user-types-in-pipedrive-account-settings\">the Account Settings user type</a> in our Knowledge Base.\n</p>\n  </div>\n</div>"
}
[/block]

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

Account Settings access for Users 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\">January 28, 2022</span>\n    </div>\n    <div class=\"change-area\">\n      \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      <p><b>1.</b> We added <code>required</code> labels to reflect reality for the \n        <code><a href=\"https://developers.pipedrive.com/docs/api/v1/OrganizationRelationships#addOrganizationRelationship\" target=\"_self\">POST /organizationRelationships</a></code> endpoint.</p>\n        <p><b>2.</b> We updated the response status code from <code>200</code> “OK” to <code>201</code> “Created” to reflect reality for the following 3 endpoints: \n   <p>   <ul><ul>\n<li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Organizations#addOrganization\" target=\"_self\">POST /organizations</a></code></li>\n<li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Persons#addPerson\" target=\"_self\">POST /persons</a></code></li>\n<li><code><a href=\"https://developers.pipedrive.com/docs/api/v1/Deals#addDeal\" target=\"_self\">POST /deals</a></code></li>\n      </ul></p></ul>\n  <p><b>3.</b>  We added <code>leadField</code> to <code>field_type</code> parameter value options for the\n<code><a href=\"https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItemByField\" target=\"_self\">GET /itemSearch/field</a></code> endpoint.</p>\n    <p><b>4.</b> We updated the response structure to reflect reality for the <code><a href=\"https://developers.pipedrive.com/docs/api/v1/Subscriptions#findSubscriptionByDeal\" target=\"_self\">GET /subscriptions/find/{dealId}</a></code> endpoint.</p>\n  <p>Previously, the response was documented as: <code>response -> recurring -> value -> data -> id</code>.\n    In reality, the structure is: <code>response -> data -> id</code>.</p>\n  <p>Here’s the code example of the correct response structure:</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\">true</span>,\n   <span class=\"cm-property\">\"data\"</span>: {\n      <span class=\"cm-property\">\"id\"</span>: <span class=\"cm-number\">21</span>,\n      <span class=\"cm-property\">\"user_id\"</span>: <span class=\"cm-number\">10382754</span>,\n      <span class=\"cm-property\">\"deal_id\"</span>: <span class=\"cm-number\">1121</span>,\n      <span class=\"cm-property\">\"is_active\"</span>: <span class=\"cm-atom\">true</span>,\n      <span class=\"cm-property\">\"cycle_amount\"</span>: <span class=\"cm-number\">100.3</span>,\n      <span class=\"cm-property\">\"cycles_count\"</span>: <span class=\"cm-number\">15</span>,\n      <span class=\"cm-property\">\"infinite\"</span>: <span class=\"cm-atom\">true</span>,\n      <span class=\"cm-property\">\"currency\"</span>: <span class=\"cm-string\">\"USD\"</span>,\n      <span class=\"cm-property\">\"start_date\"</span>: <span class=\"cm-string\">\"2020-10-20\"</span>,\n      <span class=\"cm-property\">\"end_date\"</span>: <span class=\"cm-string\">\"2022-01-20\"</span>,\n      <span class=\"cm-property\">\"description\"</span>: <span class=\"cm-string\">\"pizza delivery\"</span>,\n      <span class=\"cm-property\">\"add_time\"</span>: <span class=\"cm-string\">\"2020-07-07 08:32:57\"</span>,\n      <span class=\"cm-property\">\"update_time\"</span>: <span class=\"cm-string\">\"2020-07-07 08:32:57\"</span>,\n      <span class=\"cm-property\">\"lifetime_value\"</span>: <span class=\"cm-number\">1504.5</span>,\n      <span class=\"cm-property\">\"cadence_type\"</span>: <span class=\"cm-string\">\"monthly\"</span>,\n      <span class=\"cm-property\">\"final_status\"</span>: <span class=\"cm-atom\">null</span>\n   }\n};\n</div></code></pre></div></div>\n     \n  </div>\n</div>"
}
[/block]

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

Contents

Changelog

Announced changes

Subscribe to our Changelog

Subscribe to our Changelog

Subscribe to our
Changelog