<HTMLBlock>{`
<div class="chlog-box">
    <div class="from-area">
        <span class="from-label">Effective from:</span><br>
        <span class="from-date">August 8, 2022</span>
    </div>
    <div class="change-area">
      <p><b>What is changing?</b></p>
      <p>We are removing the <code>matches_filters</code> field from the <code>additional_data</code> section of the success response of the following POST and PUT endpoints:</p>
      <ul>
        <li><code><a href="https://developers.pipedrive.com/docs/api/v1/Deals#addDeal" target="_self">POST /deals</a></code></li>
        <li><code><a href="https://developers.pipedrive.com/docs/api/v1/Organizations#addOrganization" target="_self">POST /organizations</a></code></li>
        <li><code><a href="https://developers.pipedrive.com/docs/api/v1/Persons#addPerson" target="_self">POST /persons</a></code></li>
        <li><code><a href="https://developers.pipedrive.com/docs/api/v1/Deals#updateDeal" target="_self">PUT /deals/{id}</a></code></li>
        <li><code><a href="https://developers.pipedrive.com/docs/api/v1/Organizations#updateOrganization" target="_self">PUT /organizations/{id}</a></code></li>
        <li><code><a href="https://developers.pipedrive.com/docs/api/v1/Persons#updatePerson" target="_self">PUT /persons/{id}</a></code></li>
      </ul>
      
      <p><b>Why is it changing?</b></p>
      <p>The goal behind removing the field is to improve the performance of the above mentioned endpoints.</p>
      
      <p><b>Who will be affected?</b></p>
      <p>Everyone who is using the <code>matches_filters</code> response field data from these POST and PUT endpoints.</p>
      
      <p>If you have any questions or comments, let us know in <a href="https://devcommunity.pipedrive.com/" target="_self">the Developer’s Community</a>.</p>
    </div>
</div>
`}</HTMLBlock>

{"product": ["API"], "features": ["Deals", "Persons", "Organizations"]}


<div class="chlog-box">
    <div class="from-area">
        <span class="from-label">Effective from:</span><br>
        <span class="from-date">August 8, 2022</span>
    </div>
    <div class="change-area">
      <p><b>What is changing?</b></p>
      <p>We are removing the <code>matches_filters</code> field from the <code>additional_data</code> section of the success response of the following POST and PUT endpoints:</p>
      <ul>
        <li><code><a href="https://developers.pipedrive.com/docs/api/v1/Deals#addDeal" target="_self">POST /deals</a></code></li>
        <li><code><a href="https://developers.pipedrive.com/docs/api/v1/Organizations#addOrganization" target="_self">POST /organizations</a></code></li>
        <li><code><a href="https://developers.pipedrive.com/docs/api/v1/Persons#addPerson" target="_self">POST /persons</a></code></li>
        <li><code><a href="https://developers.pipedrive.com/docs/api/v1/Deals#updateDeal" target="_self">PUT /deals/{id}</a></code></li>
        <li><code><a href="https://developers.pipedrive.com/docs/api/v1/Organizations#updateOrganization" target="_self">PUT /organizations/{id}</a></code></li>
        <li><code><a href="https://developers.pipedrive.com/docs/api/v1/Persons#updatePerson" target="_self">PUT /persons/{id}</a></code></li>
      </ul>
      
      <p><b>Why is it changing?</b></p>
      <p>The goal behind removing the field is to improve the performance of the above mentioned endpoints.</p>
      
      <p><b>Who will be affected?</b></p>
      <p>Everyone who is using the <code>matches_filters</code> response field data from these POST and PUT endpoints.</p>
      
      <p>If you have any questions or comments, let us know in <a href="https://devcommunity.pipedrive.com/" target="_self">the Developer’s Community</a>.</p>
    </div>
</div>


Removal of the <code>matches_filters</code> response field from POST and PUT endpoints

<HTMLBlock>{`
<div class="chlog-box">
    <div class="from-area">
        <span class="from-label">Effective from:</span><br>
        <span class="from-date">May 31, 2022</span>
    </div>
    <div class="change-area">
      <p>1. We have removed the <code>required</code>label from the <code>name</code> body parameter to reflect reality for the following two endpoints:
      </p>
      <ul>
         	<li><code><a href="https://developers.pipedrive.com/docs/api/v1/Persons#updatePerson" target="_self">PUT /persons/{id}</a></code></li>
          <li><code><a href="https://developers.pipedrive.com/docs/api/v1/ProductFields#updateProductField" target="_self">PUT /productFields/{id}</a></code></li>
      </ul>
      
      <p>2. Regarding the <a href="https://developers.pipedrive.com/changelog/post/breaking-change-in-teams-api-path-url" target="_self">breaking change in Teams API path URL</a> we announced on May 10, 2022, we have deprecated all LegacyTeams API endpoints as we are preparing for an upgraded version of the Teams API.
        </p>
    </div>
</div>
`}</HTMLBlock>

{"product": ["Developer Platform"], "features": ["Persons", "Products", "Teams"]}


<div class="chlog-box">
    <div class="from-area">
        <span class="from-label">Effective from:</span><br>
        <span class="from-date">May 31, 2022</span>
    </div>
    <div class="change-area">
      <p>1. We have removed the <code>required</code>label from the <code>name</code> body parameter to reflect reality for the following two endpoints:
      </p>
      <ul>
         	<li><code><a href="https://developers.pipedrive.com/docs/api/v1/Persons#updatePerson" target="_self">PUT /persons/{id}</a></code></li>
          <li><code><a href="https://developers.pipedrive.com/docs/api/v1/ProductFields#updateProductField" target="_self">PUT /productFields/{id}</a></code></li>
      </ul>
      
      <p>2. Regarding the <a href="https://developers.pipedrive.com/changelog/post/breaking-change-in-teams-api-path-url" target="_self">breaking change in Teams API path URL</a> we announced on May 10, 2022, we have deprecated all LegacyTeams API endpoints as we are preparing for an upgraded version of the Teams API.
        </p>
    </div>
</div>


May 2022 release notes

<HTMLBlock>{`
<div class="chlog-box">
    <div class="from-area">
        <span class="from-label">Effective from:</span><br>
        <span class="from-date">July 11, 2022</span>
    </div>
    <div class="change-area">
      <p>The Teams feature, currently available for Professional and Enterprise tier users, allows to form groups of users within the organization for more efficient management.</p>
      
      <p><b>What is changing?</b></p>
      <p><a href="https://developers.pipedrive.com/docs/api/v1/LegacyTeams" target="_self">Teams API</a> will remain available, but on a different path URL: 
        the current <b><code>/teams/</code></b> path will be replaced by the <b><code>/legacyTeams/</code></b> path.</p>
      
      <p>For example, the endpoint for <a href="https://developers.pipedrive.com/docs/api/v1/LegacyTeams#getTeam" target="_self">getting a single team</a>:</p>
      <ul>
        <li>Previous path: <code>https://&lt;companydomain&gt;.pipedrive.com/v1/teams/{id}</code></li>
        <li>New path: <code>https://&lt;companydomain&gt;.pipedrive.com/v1/legacyTeams/{id}</code></li>
      </ul>
      
      <p>Therefore, we are asking you to migrate all Teams-related requests over to the new <code>/legacyTeams/</code> path, as we will stop supporting the <code>/teams/</code> path on July 11, 2022.</p>
      
      <p>The functionality and <a href="https://pipedrive.readme.io/docs/marketplace-scopes-and-permissions-explanations" target="_self">OAuth scopes</a> of all the Teams API endpoints will remain the same.</p>
      
      <p><b>Why is it changing?</b></p>
      <p>We are preparing for an upgraded version of the Teams API, which requires migrating the current functionality to a new path URL.</p>
      
      <p><b>Who will be affected?</b></p>
      <p>Everyone who is using the Teams API to access, modify and/or add data.</p>
      <p>If you have any questions or comments, let us know in <a href="https://devcommunity.pipedrive.com/" target="_self">the Developer’s Community</a>.</p>
  
  </div>
</div>
`}</HTMLBlock>

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

Breaking change in Teams API path URLs


<div class="chlog-box">
    <div class="from-area">
        <span class="from-label">Effective from:</span><br>
        <span class="from-date">July 11, 2022</span>
    </div>
    <div class="change-area">
      <p>The Teams feature, currently available for Professional and Enterprise tier users, allows to form groups of users within the organization for more efficient management.</p>
      
      <p><b>What is changing?</b></p>
      <p><a href="https://developers.pipedrive.com/docs/api/v1/LegacyTeams" target="_self">Teams API</a> will remain available, but on a different path URL: 
        the current <b><code>/teams/</code></b> path will be replaced by the <b><code>/legacyTeams/</code></b> path.</p>
      
      <p>For example, the endpoint for <a href="https://developers.pipedrive.com/docs/api/v1/LegacyTeams#getTeam" target="_self">getting a single team</a>:</p>
      <ul>
        <li>Previous path: <code>https://&lt;companydomain&gt;.pipedrive.com/v1/teams/{id}</code></li>
        <li>New path: <code>https://&lt;companydomain&gt;.pipedrive.com/v1/legacyTeams/{id}</code></li>
      </ul>
      
      <p>Therefore, we are asking you to migrate all Teams-related requests over to the new <code>/legacyTeams/</code> path, as we will stop supporting the <code>/teams/</code> path on July 11, 2022.</p>
      
      <p>The functionality and <a href="https://pipedrive.readme.io/docs/marketplace-scopes-and-permissions-explanations" target="_self">OAuth scopes</a> of all the Teams API endpoints will remain the same.</p>
      
      <p><b>Why is it changing?</b></p>
      <p>We are preparing for an upgraded version of the Teams API, which requires migrating the current functionality to a new path URL.</p>
      
      <p><b>Who will be affected?</b></p>
      <p>Everyone who is using the Teams API to access, modify and/or add data.</p>
      <p>If you have any questions or comments, let us know in <a href="https://devcommunity.pipedrive.com/" target="_self">the Developer’s Community</a>.</p>
  
  </div>
</div>


Breaking change in Teams API path URL

<HTMLBlock>{`
<div class="chlog-box">
    <div class="from-area">
        <span class="from-label">Effective from:</span><br>
        <span class="from-date">May 5, 2022</span>
    </div>
    <div class="change-area">
      <p>Integrate a <b>messaging service directly</b> into Pipedrive with our new Messaging app extension. 
        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.
</p>
      <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">
        <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">
          </span></span></span><figcaption><p>Messaging inbox - active conversation with details from different apps</p></figcaption></figure>
      
      <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.
</p>
      <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).
</p>
      <p>With this extension, we’ve added a couple of new things: 
</p>
      <p><b>In Developer Documentation</b></p>
      <p>You can find a complete overview of 
        <a href="https://pipedrive.readme.io/docs/messaging-app-extension" target="_self">Messaging app extension</a>, 
        <a href="https://pipedrive.readme.io/docs/implementing-messaging-app-extension" target="_self">how to implement the manifest</a> and 
       <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>.
</p>
       <p><b>In API Reference</b></p>
      <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>
      <ul>
        <li><code><a href="https://developers.pipedrive.com/docs/api/v1/Channels#addChannel" target="_self">POST /v1/channels</a></code></li>
         <li><code><a href="https://developers.pipedrive.com/docs/api/v1/Channels#receiveMessage" target="_self">POST /v1/channels/messages/receive</a></code></li>
         <li><code><a href="https://developers.pipedrive.com/docs/api/v1/Channels#deleteChannel" target="_self">DELETE /v1/channels/{id}</a></code></li>
         <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>
      </ul>
       <p><b>In OAuth Scopes </b></p>
      <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.
</p>
        </div>
</div>
`}</HTMLBlock>


<div class="chlog-box">
    <div class="from-area">
        <span class="from-label">Effective from:</span><br>
        <span class="from-date">May 5, 2022</span>
    </div>
    <div class="change-area">
      <p>Integrate a <b>messaging service directly</b> into Pipedrive with our new Messaging app extension. 
        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.
</p>
      <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">
        <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">
          </span></span></span><figcaption><p>Messaging inbox - active conversation with details from different apps</p></figcaption></figure>
      
      <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.
</p>
      <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).
</p>
      <p>With this extension, we’ve added a couple of new things: 
</p>
      <p><b>In Developer Documentation</b></p>
      <p>You can find a complete overview of 
        <a href="https://pipedrive.readme.io/docs/messaging-app-extension" target="_self">Messaging app extension</a>, 
        <a href="https://pipedrive.readme.io/docs/implementing-messaging-app-extension" target="_self">how to implement the manifest</a> and 
       <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>.
</p>
       <p><b>In API Reference</b></p>
      <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>
      <ul>
        <li><code><a href="https://developers.pipedrive.com/docs/api/v1/Channels#addChannel" target="_self">POST /v1/channels</a></code></li>
         <li><code><a href="https://developers.pipedrive.com/docs/api/v1/Channels#receiveMessage" target="_self">POST /v1/channels/messages/receive</a></code></li>
         <li><code><a href="https://developers.pipedrive.com/docs/api/v1/Channels#deleteChannel" target="_self">DELETE /v1/channels/{id}</a></code></li>
         <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>
      </ul>
       <p><b>In OAuth Scopes </b></p>
      <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.
</p>
        </div>
</div>


New feature: Messaging app extension

<HTMLBlock>{`
<div class="chlog-box">
    <div class="from-area">
        <span class="from-label">Effective from:</span><br>
        <span class="from-date">April 28, 2022</span>
    </div>
    <div class="change-area">
      <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.
      </p>
      
      <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>:
        </p>
				<ul>
         	<li><code>Leadbooster</code> - the value assigned to leads sourced from the Chatbot feature</li>
      </ul>
      
      <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:
        </p>
			<ul>
        <li><code><a href="https://developers.pipedrive.com/docs/api/v1/Deals#addDeal" target="_self">POST /deals</a></code></li>
        <li><code><a href="https://developers.pipedrive.com/docs/api/v1/Deals#updateDeal" target="_self">PUT /deals/{id}</a></code></li>
        <li><code><a href="https://developers.pipedrive.com/docs/api/v1/Leads#addLead" target="_self">POST /leads</a></code></li>
        <li><code><a href="https://developers.pipedrive.com/docs/api/v1/Leads#updateLead" target="_self">PATCH /leads/{id}</a></code></li>
        <li><code><a href="https://developers.pipedrive.com/docs/api/v1/Organizations#addOrganization" target="_self">POST /organizations</a></code></li>
        <li><code><a href="https://developers.pipedrive.com/docs/api/v1/Organizations#updateOrganization" target="_self">PUT /organizations/{id}</a></code></li>
        <li><code><a href="https://developers.pipedrive.com/docs/api/v1/Persons#addPerson" target="_self">POST /persons</a></code></li>
        <li><code><a href="https://developers.pipedrive.com/docs/api/v1/Persons#updatePerson" target="_self">PUT /persons/{id}</a></code></li>
      </ul>
     
      <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:
      </p>
      <ul>
        <li><code><a href="https://developers.pipedrive.com/docs/api/v1/Organizations#addOrganization" target="_self">POST /organizations</a></code></li>
        <li><code><a href="https://developers.pipedrive.com/docs/api/v1/Organizations#updateOrganization" target="_self">PUT /organizations/{id}</a></code></li>
        </ul>
    </div>
</div>
`}</HTMLBlock>

April release notes


<div class="chlog-box">
    <div class="from-area">
        <span class="from-label">Effective from:</span><br>
        <span class="from-date">April 28, 2022</span>
    </div>
    <div class="change-area">
      <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.
      </p>
      
      <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>:
        </p>
				<ul>
         	<li><code>Leadbooster</code> - the value assigned to leads sourced from the Chatbot feature</li>
      </ul>
      
      <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:
        </p>
			<ul>
        <li><code><a href="https://developers.pipedrive.com/docs/api/v1/Deals#addDeal" target="_self">POST /deals</a></code></li>
        <li><code><a href="https://developers.pipedrive.com/docs/api/v1/Deals#updateDeal" target="_self">PUT /deals/{id}</a></code></li>
        <li><code><a href="https://developers.pipedrive.com/docs/api/v1/Leads#addLead" target="_self">POST /leads</a></code></li>
        <li><code><a href="https://developers.pipedrive.com/docs/api/v1/Leads#updateLead" target="_self">PATCH /leads/{id}</a></code></li>
        <li><code><a href="https://developers.pipedrive.com/docs/api/v1/Organizations#addOrganization" target="_self">POST /organizations</a></code></li>
        <li><code><a href="https://developers.pipedrive.com/docs/api/v1/Organizations#updateOrganization" target="_self">PUT /organizations/{id}</a></code></li>
        <li><code><a href="https://developers.pipedrive.com/docs/api/v1/Persons#addPerson" target="_self">POST /persons</a></code></li>
        <li><code><a href="https://developers.pipedrive.com/docs/api/v1/Persons#updatePerson" target="_self">PUT /persons/{id}</a></code></li>
      </ul>
     
      <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:
      </p>
      <ul>
        <li><code><a href="https://developers.pipedrive.com/docs/api/v1/Organizations#addOrganization" target="_self">POST /organizations</a></code></li>
        <li><code><a href="https://developers.pipedrive.com/docs/api/v1/Organizations#updateOrganization" target="_self">PUT /organizations/{id}</a></code></li>
        </ul>
    </div>
</div>


April 2022 release notes

<HTMLBlock>{`
<div class="chlog-box">
    <div class="from-area">
        <span class="from-label">Effective from:</span><br>
        <span class="from-date">March 31, 2022</span>
    </div>
    <div class="change-area">
      <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.
</p>
      <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.
</p>
      <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.
</p>
      <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.
</p>
       
       </div>
</div>
`}</HTMLBlock>

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


<div class="chlog-box">
    <div class="from-area">
        <span class="from-label">Effective from:</span><br>
        <span class="from-date">March 31, 2022</span>
    </div>
    <div class="change-area">
      <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.
</p>
      <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.
</p>
      <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.
</p>
      <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.
</p>
       
       </div>
</div>


March 2022 release notes

<HTMLBlock>{`
<div class="chlog-box">
    <div class="from-area">
        <span class="from-label">Effective from:</span><br>
        <span class="from-date">March 23, 2022</span>
    </div>
    <div class="change-area">
      <p>We have added a new Billing resource with one new <code>GET</code> endpoint to our API Reference.
</p>
      <p><b>What is being added?
</b></p>
      <p>The new Billing API currently includes the following endpoint:
</p>
      <ul><li><code><a href="https://developers.pipedrive.com/docs/api/v1/Billing#getCompanyAddons" target="_self">GET /billing/subscriptions/addons
        </a>
        </code>
        </li>
      </ul>
      <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>.
</p>
      
      <p>The new endpoint allows an integration to retrieve the add-ons of a single company. 
        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) 
        and seamlessly provide the customer with more functionality directly inside the integration.
</p>
      
       </div>
</div>
`}</HTMLBlock>

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


<div class="chlog-box">
    <div class="from-area">
        <span class="from-label">Effective from:</span><br>
        <span class="from-date">March 23, 2022</span>
    </div>
    <div class="change-area">
      <p>We have added a new Billing resource with one new <code>GET</code> endpoint to our API Reference.
</p>
      <p><b>What is being added?
</b></p>
      <p>The new Billing API currently includes the following endpoint:
</p>
      <ul><li><code><a href="https://developers.pipedrive.com/docs/api/v1/Billing#getCompanyAddons" target="_self">GET /billing/subscriptions/addons
        </a>
        </code>
        </li>
      </ul>
      <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>.
</p>
      
      <p>The new endpoint allows an integration to retrieve the add-ons of a single company. 
        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) 
        and seamlessly provide the customer with more functionality directly inside the integration.
</p>
      
       </div>
</div>


Introducing Billing API

<HTMLBlock>{`
<div class="chlog-box">
    <div class="from-area">
        <span class="from-label">Effective from:</span><br>
        <span class="from-date">March 30, 2022</span>
    </div>
    <div class="change-area">
      <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>.
</p>
       <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. 
</p>
      <ul>
        <li><code><a href="https://developers.pipedrive.com/docs/api/v1/Deals#addDeal" target="_self">POST /deals</a></code></li>
        <li><code><a href="https://developers.pipedrive.com/docs/api/v1/Deals#duplicateDeal" target="_self">POST /deals/{id}/duplicate</a></code></li>
        <li><code><a href="https://developers.pipedrive.com/docs/api/v1/DealFields#addDealField" target="_self">POST /dealsFields</a></code></li>
        <li><code><a href="https://developers.pipedrive.com/docs/api/v1/PersonFields#addPersonField" target="_self">POST /personFields</a></code></li>
        <li><code><a href="https://developers.pipedrive.com/docs/api/v1/PersonFields#addPersonField" target="_self">POST /productFields</a></code></li>
        <li><code><a href="https://developers.pipedrive.com/docs/api/v1/OrganizationFields#addOrganizationField" target="_self">POST /organizationFields</a></code></li>
      </ul>
      
       <p>The error message will follow a new structure for these 6 endpoints and contain a new parameter <code>code</code>. </p>
      <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">{
    <span class="cm-property">"success"</span>: <span class="cm-atom">false</span>,
    <span class="cm-property">"error"</span>: <span class="cm-string">"Couldn't add the deal. Open deals limit reached."</span>,
    <span class="cm-property">"error_info"</span>: <span class="cm-string">"Please check developers.pipedrive.com for more information about Pipedrive API."</span>,
    <span class="cm-property">"data"</span>: <span class="cm-atom">null</span>,
    <span class="cm-property">"additional_data"</span>: <span class="cm-atom">null</span>,
    <span class="cm-property">"code"</span>: <span class="cm-string">"feature_capping_deals_limit"</span>
}
</div></code></pre></div></div>
      
      <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>.
</p>
      <p>
To 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>
      
       </div>
</div>
`}</HTMLBlock>


<div class="chlog-box">
    <div class="from-area">
        <span class="from-label">Effective from:</span><br>
        <span class="from-date">March 30, 2022</span>
    </div>
    <div class="change-area">
      <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>.
</p>
       <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. 
</p>
      <ul>
        <li><code><a href="https://developers.pipedrive.com/docs/api/v1/Deals#addDeal" target="_self">POST /deals</a></code></li>
        <li><code><a href="https://developers.pipedrive.com/docs/api/v1/Deals#duplicateDeal" target="_self">POST /deals/{id}/duplicate</a></code></li>
        <li><code><a href="https://developers.pipedrive.com/docs/api/v1/DealFields#addDealField" target="_self">POST /dealsFields</a></code></li>
        <li><code><a href="https://developers.pipedrive.com/docs/api/v1/PersonFields#addPersonField" target="_self">POST /personFields</a></code></li>
        <li><code><a href="https://developers.pipedrive.com/docs/api/v1/PersonFields#addPersonField" target="_self">POST /productFields</a></code></li>
        <li><code><a href="https://developers.pipedrive.com/docs/api/v1/OrganizationFields#addOrganizationField" target="_self">POST /organizationFields</a></code></li>
      </ul>
      
       <p>The error message will follow a new structure for these 6 endpoints and contain a new parameter <code>code</code>. </p>
      <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">{
    <span class="cm-property">"success"</span>: <span class="cm-atom">false</span>,
    <span class="cm-property">"error"</span>: <span class="cm-string">"Couldn't add the deal. Open deals limit reached."</span>,
    <span class="cm-property">"error_info"</span>: <span class="cm-string">"Please check developers.pipedrive.com for more information about Pipedrive API."</span>,
    <span class="cm-property">"data"</span>: <span class="cm-atom">null</span>,
    <span class="cm-property">"additional_data"</span>: <span class="cm-atom">null</span>,
    <span class="cm-property">"code"</span>: <span class="cm-string">"feature_capping_deals_limit"</span>
}
</div></code></pre></div></div>
      
      <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>.
</p>
      <p>
To 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>
      
       </div>
</div>


New error message and code for POST Deals and Custom Fields endpoints

<HTMLBlock>{`
<div class="chlog-box">
    <div class="from-area">
        <span class="from-label">Effective from:</span><br>
        <span class="from-date">March 17, 2022</span>
    </div>
    <div class="change-area">
      
      <p> <code>products:full</code> and <code>products:read</code> scopes now allow apps to have access to a new endpoint: </p>
<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>
      
      <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>
<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>
        </div>
</div>
`}</HTMLBlock>

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


<div class="chlog-box">
    <div class="from-area">
        <span class="from-label">Effective from:</span><br>
        <span class="from-date">March 17, 2022</span>
    </div>
    <div class="change-area">
      
      <p> <code>products:full</code> and <code>products:read</code> scopes now allow apps to have access to a new endpoint: </p>
<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>
      
      <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>
<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>
        </div>
</div>


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

<HTMLBlock>{`
<div class="chlog-box">
    <div class="from-area">
        <span class="from-label">Effective from:</span><br>
        <span class="from-date">March 1, 2022</span>
    </div>
    <div class="change-area">
      <p>We have made updates to the <a href="https://developers.pipedrive.com/docs/api/v1/Leads" target="_self">Leads API </a>:</p>
       <p>1. We documented a new endpoint to improve the experience of using Leads:</p>
      <ul>
        <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>
      </ul>
       <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:
</p>
       <ul>
         <li><code>filter_id</code> - for retrieving leads by a filter</li>
          <li><code>owner_id</code> - for retrieving leads by their owner</li>
          <li><code>sort</code> - for sorting leads by a field name and a sorting mode</li>
      </ul>
      <p>3. We added the <code>lead_id</code> body parameter to support linking leads to activities for the following Activities endpoints:
</p>
       <ul>
        <li><code><a href="https://developers.pipedrive.com/docs/api/v1/Activities#addActivity" target="_self">POST /activities</a></code></li>
          <li><code><a href="https://developers.pipedrive.com/docs/api/v1/Activities#updateActivity" target="_self">PUT /activities/{id}</a></code></li>
      </ul>
      <p>4. <code>leads</code> is now documented as a possible value of the <code>type</code> parameter for these Filters endpoints:</p>
       <ul>
         <li><code><a href="https://developers.pipedrive.com/docs/api/v1/Filters#getFilters" target="_self">GET /filters</a></code></li>
          <li><code><a href="https://developers.pipedrive.com/docs/api/v1/Filters#addFilter" target="_self">POST /filters</a></code></li>
      </ul>

        </div>
</div>
`}</HTMLBlock>

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


<div class="chlog-box">
    <div class="from-area">
        <span class="from-label">Effective from:</span><br>
        <span class="from-date">March 1, 2022</span>
    </div>
    <div class="change-area">
      <p>We have made updates to the <a href="https://developers.pipedrive.com/docs/api/v1/Leads" target="_self">Leads API </a>:</p>
       <p>1. We documented a new endpoint to improve the experience of using Leads:</p>
      <ul>
        <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>
      </ul>
       <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:
</p>
       <ul>
         <li><code>filter_id</code> - for retrieving leads by a filter</li>
          <li><code>owner_id</code> - for retrieving leads by their owner</li>
          <li><code>sort</code> - for sorting leads by a field name and a sorting mode</li>
      </ul>
      <p>3. We added the <code>lead_id</code> body parameter to support linking leads to activities for the following Activities endpoints:
</p>
       <ul>
        <li><code><a href="https://developers.pipedrive.com/docs/api/v1/Activities#addActivity" target="_self">POST /activities</a></code></li>
          <li><code><a href="https://developers.pipedrive.com/docs/api/v1/Activities#updateActivity" target="_self">PUT /activities/{id}</a></code></li>
      </ul>
      <p>4. <code>leads</code> is now documented as a possible value of the <code>type</code> parameter for these Filters endpoints:</p>
       <ul>
         <li><code><a href="https://developers.pipedrive.com/docs/api/v1/Filters#getFilters" target="_self">GET /filters</a></code></li>
          <li><code><a href="https://developers.pipedrive.com/docs/api/v1/Filters#addFilter" target="_self">POST /filters</a></code></li>
      </ul>

        </div>
</div>


Contents

Changelog

Announced changes

Subscribe to our Changelog

Subscribe to our Changelog

Subscribe to our
Changelog