<HTMLBlock>{`
<div class="chlog-box">
    <div class="from-area">
        <span class="from-label">Effective from:</span><br>
        <span class="from-date">October 3, 2022</span>
    </div>
    <div class="change-area">
      
      <p><b>What is changing?</b></p>
      <p>We have now deprecated and will soon be removing the following two Users API endpoints:</p>
      <ul>
        <li><code><a href="https://developers.pipedrive.com/docs/api/v1/Users#addUserRoleAssignment" target="_self">POST /users/{id}/roleAssignments</a></code></li>
        <li><code><a href="https://developers.pipedrive.com/docs/api/v1/Users#deleteUserRoleAssignment" target="_self">DELETE /users/{id}/roleAssignments</a></code></li>
      </ul>
      <p>We strongly advise you to avoid using these two deprecated endpoints.</p>
      
      <p><b>Why are we removing these?</b></p>
      <p>The endpoints mentioned above are part of a legacy way of assigning user roles via API.</p>
      <p>We recommend using more reliable <code><a href="https://developers.pipedrive.com/docs/api/v1/Roles#addRoleAssignment" target="_self">POST /roles/{id}/assignments</a></code> and <code><a href="https://developers.pipedrive.com/docs/api/v1/Roles#deleteRoleAssignment" target="_self">DELETE /roles/{id}/assignments</a></code> endpoints within the Roles API to add and delete roles from a user.</p>
      
      <p><b>Who will be affected?</b></p> 
      <p>Everyone who is using the deprecated <code>POST</code> and <code>DELETE</code> 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": ["Users"]}


<div class="chlog-box">
    <div class="from-area">
        <span class="from-label">Effective from:</span><br>
        <span class="from-date">October 3, 2022</span>
    </div>
    <div class="change-area">
      
      <p><b>What is changing?</b></p>
      <p>We have now deprecated and will soon be removing the following two Users API endpoints:</p>
      <ul>
        <li><code><a href="https://developers.pipedrive.com/docs/api/v1/Users#addUserRoleAssignment" target="_self">POST /users/{id}/roleAssignments</a></code></li>
        <li><code><a href="https://developers.pipedrive.com/docs/api/v1/Users#deleteUserRoleAssignment" target="_self">DELETE /users/{id}/roleAssignments</a></code></li>
      </ul>
      <p>We strongly advise you to avoid using these two deprecated endpoints.</p>
      
      <p><b>Why are we removing these?</b></p>
      <p>The endpoints mentioned above are part of a legacy way of assigning user roles via API.</p>
      <p>We recommend using more reliable <code><a href="https://developers.pipedrive.com/docs/api/v1/Roles#addRoleAssignment" target="_self">POST /roles/{id}/assignments</a></code> and <code><a href="https://developers.pipedrive.com/docs/api/v1/Roles#deleteRoleAssignment" target="_self">DELETE /roles/{id}/assignments</a></code> endpoints within the Roles API to add and delete roles from a user.</p>
      
      <p><b>Who will be affected?</b></p> 
      <p>Everyone who is using the deprecated <code>POST</code> and <code>DELETE</code> 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 <code>POST</code> and <code>DELETE /users/{id}/roleAssignments</code> endpoints

<HTMLBlock>{`
<div class="chlog-box">
    <div class="from-area">
        <span class="from-label">Effective from:</span><br>
        <span class="from-date">July 29, 2022</span>
    </div>
    <div class="change-area">
      <p>1. We added the <code>person_id</code> and <code>organization_id</code>
        query parameters for the <code><a href="https://developers.pipedrive.com/docs/api/v1/Leads#getLeads" target="_self">GET /leads</a></code> 
        endpoint to retrieve all leads that match the parameter(s).
      </p>
      
    </div>
</div>
`}</HTMLBlock>

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


<div class="chlog-box">
    <div class="from-area">
        <span class="from-label">Effective from:</span><br>
        <span class="from-date">July 29, 2022</span>
    </div>
    <div class="change-area">
      <p>1. We added the <code>person_id</code> and <code>organization_id</code>
        query parameters for the <code><a href="https://developers.pipedrive.com/docs/api/v1/Leads#getLeads" target="_self">GET /leads</a></code> 
        endpoint to retrieve all leads that match the parameter(s).
      </p>
      
    </div>
</div>


July 2022 release notes

<HTMLBlock>{`
<div class="chlog-box">
    <div class="from-area">
        <span class="from-label">Effective from:</span><br>
        <span class="from-date">June 30, 2022</span>
    </div>
    <div class="change-area">
      <p>1. 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 2 Products API endpoints:</p>
      <ul>
        <li><code><a href="https://developers.pipedrive.com/docs/api/v1/Products#addProduct" target="_self">POST /products</a></code></li>
        <li><code><a href="https://developers.pipedrive.com/docs/api/v1/Products#updateProduct" target="_self">PUT /products/{id}</a></code></li>
      </ul>
      
      <p>2. A new <code>primary_email</code> field is now available in the success 
        response of the <code><a href="https://developers.pipedrive.com/docs/api/v1/Persons#getPersons" target="_self">GET /persons</a></code> 
        and <code><a href="https://developers.pipedrive.com/docs/api/v1/Persons#getPerson" target="_self">GET /persons/{id}</a></code> endpoints:</p>
      <ul>
         <li><code>primary_email</code> - the primary email address of the person</li>
      </ul>
      
      <p>3. Regarding <code><a href="https://developers.pipedrive.com/changelog/post/permissionsets-api-breaking-change" target="_self">the PermissionSets API breaking change</a></code>
        that went into effect on September 1, 2021, it has come to our 
        attention that the changes were not updated in API Reference 
        although the backend functionality remained as announced. 
        We apologize for the mishap and have now corrected the documentation 
        to reflect reality:</p>
      <ul>
        <li>The data type of the <code>id</code> path parameter was updated from <code>integer</code> to <code>string</code> for the <code><a href="https://developers.pipedrive.com/docs/api/v1/PermissionSets#getPermissionSet" target="_self">GET /permissionSets/{id}</a></code> and <code><a href="https://developers.pipedrive.com/docs/api/v1/PermissionSets#getPermissionSetAssignments" target="_self">GET /permissionSets/{id}/assignments</a></code> endpoints.</li>
        <p></p>
        <li>The <code>id</code> response field was updated from <code>integer</code> to <code>string</code> for the <code><a href="https://developers.pipedrive.com/docs/api/v1/PermissionSets#getPermissionSets" target="_self">GET /permissionSets</a></code> and <code><a href="https://developers.pipedrive.com/docs/api/v1/PermissionSets#getPermissionSet" target="_self">GET /permissionSets/{id}</a></code> endpoints.</li>
     <p></p>
        <li>The <code>permission_set_id</code> response field was updated from <code>integer</code> to <code>string</code> for the <code><a href="https://developers.pipedrive.com/docs/api/v1/PermissionSets#getPermissionSetAssignments" target="_self">GET /permissionSets/{id}/assignments</a></code> endpoint.</li>
        <p></p>
        <li>The <code>id</code> field was removed from the success response of the <code><a href="https://developers.pipedrive.com/docs/api/v1/PermissionSets#getPermissionSetAssignments" target="_self">GET /permissionSets/{id}/assignments</a></code> endpoint.</li>
      
      </ul>
      
    </div>
</div>
`}</HTMLBlock>

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


<div class="chlog-box">
    <div class="from-area">
        <span class="from-label">Effective from:</span><br>
        <span class="from-date">June 30, 2022</span>
    </div>
    <div class="change-area">
      <p>1. 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 2 Products API endpoints:</p>
      <ul>
        <li><code><a href="https://developers.pipedrive.com/docs/api/v1/Products#addProduct" target="_self">POST /products</a></code></li>
        <li><code><a href="https://developers.pipedrive.com/docs/api/v1/Products#updateProduct" target="_self">PUT /products/{id}</a></code></li>
      </ul>
      
      <p>2. A new <code>primary_email</code> field is now available in the success 
        response of the <code><a href="https://developers.pipedrive.com/docs/api/v1/Persons#getPersons" target="_self">GET /persons</a></code> 
        and <code><a href="https://developers.pipedrive.com/docs/api/v1/Persons#getPerson" target="_self">GET /persons/{id}</a></code> endpoints:</p>
      <ul>
         <li><code>primary_email</code> - the primary email address of the person</li>
      </ul>
      
      <p>3. Regarding <code><a href="https://developers.pipedrive.com/changelog/post/permissionsets-api-breaking-change" target="_self">the PermissionSets API breaking change</a></code>
        that went into effect on September 1, 2021, it has come to our 
        attention that the changes were not updated in API Reference 
        although the backend functionality remained as announced. 
        We apologize for the mishap and have now corrected the documentation 
        to reflect reality:</p>
      <ul>
        <li>The data type of the <code>id</code> path parameter was updated from <code>integer</code> to <code>string</code> for the <code><a href="https://developers.pipedrive.com/docs/api/v1/PermissionSets#getPermissionSet" target="_self">GET /permissionSets/{id}</a></code> and <code><a href="https://developers.pipedrive.com/docs/api/v1/PermissionSets#getPermissionSetAssignments" target="_self">GET /permissionSets/{id}/assignments</a></code> endpoints.</li>
        <p></p>
        <li>The <code>id</code> response field was updated from <code>integer</code> to <code>string</code> for the <code><a href="https://developers.pipedrive.com/docs/api/v1/PermissionSets#getPermissionSets" target="_self">GET /permissionSets</a></code> and <code><a href="https://developers.pipedrive.com/docs/api/v1/PermissionSets#getPermissionSet" target="_self">GET /permissionSets/{id}</a></code> endpoints.</li>
     <p></p>
        <li>The <code>permission_set_id</code> response field was updated from <code>integer</code> to <code>string</code> for the <code><a href="https://developers.pipedrive.com/docs/api/v1/PermissionSets#getPermissionSetAssignments" target="_self">GET /permissionSets/{id}/assignments</a></code> endpoint.</li>
        <p></p>
        <li>The <code>id</code> field was removed from the success response of the <code><a href="https://developers.pipedrive.com/docs/api/v1/PermissionSets#getPermissionSetAssignments" target="_self">GET /permissionSets/{id}/assignments</a></code> endpoint.</li>
      
      </ul>
      
    </div>
</div>


June 2022 release notes

<HTMLBlock>{`
<div class="chlog-box">
    <div class="from-area">
        <span class="from-label">Effective from:</span><br>
        <span class="from-date">August 29, 2022</span>
    </div>
    <div class="change-area">
      
      <p>UPDATE: The implementation of this change has been delayed for existing customers prior to August 29, 2022. We apologize for any confusion or inconvenience this has caused. From <b>August 21, 2023</b>, we are starting the rollout of this change. Please refer to the <a href="https://developers.pipedrive.com/changelog/post/update-to-the-breaking-changes-in-filter-conditions-for-filters-api" target="blank">updated announcement in Changelog</a> for further details.</p>
      
      <p>We are applying limits to filter conditions and removing 3 conditions from the Filters API to ensure a reliable experience and quick responses for all users.</p>
      
      <p><b>What is changing?</b></p>
      <p>We will be implementing a limit to the number of conditions a filter can have via the <code><a href="https://developers.pipedrive.com/docs/api/v1/Filters#addFilter" target="_self">POST /filters</a></code> and <code><a href="https://developers.pipedrive.com/docs/api/v1/Filters#updateFilter" target="_self">PUT /filters/{id}</a></code> endpoints.
        The new limit will be <b>16 conditions per filter</b>.</p>
      
      <p>If a filter is being added or updated to include more than 16 conditions, the request will fail and a <code>400</code> error response, similar to this one, will be returned:</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">"Filter is allowed to have at most 16 conditions"</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>
}
</div></code></pre></div></div>
      
      <p>In addition to the limit, we have now deprecated and will soon stop supporting the following filter conditions from the <code>conditions</code> body parameter of 
        the <code><a href="https://developers.pipedrive.com/docs/api/v1/Filters#addFilter" target="_self">POST /filters</a></code> and <code><a href="https://developers.pipedrive.com/docs/api/v1/Filters#updateFilter" target="_self">PUT /filters/{id}</a></code> endpoint:</p>
      <ul>
        <li><code>LIKE '%$'</code> <i>(ends with)</i></li>
        <li><code>NOT LIKE '%$%'</code> <i>(does not contain)</i></li>
        <li><code>NOT LIKE '%$'</code> <i>(does not end with)</i></li>
      </ul>
      
      <p>The new limit and removal of the 3 conditions will go into effect 
        on <b>August 29, 2022</b>. We advise you to review the filters you have 
        created and make sure that they adhere to the changes.</p>
      
			<p><b>Why is it changing?</b></p>
      <p>We've added new limits to the Filters API because complex filters can 
        easily cause system overload. As we are constantly improving our systems, 
        these limits will help to continuously support the excellent performance 
        of our API to apps and users.</p>
      
      <p><b>Who will be affected?</b></p>
      <p>Everyone who is using the specified <code>POST</code> and <code>PUT</code> endpoints to add and/or modify filters or has filters with more than 16 conditions in place.</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>

We are applying limits to filter conditions and removing 3 conditions from the Filters API to ensure a reliable experience and quick responses for all users.


<div class="chlog-box">
    <div class="from-area">
        <span class="from-label">Effective from:</span><br>
        <span class="from-date">August 29, 2022</span>
    </div>
    <div class="change-area">
      
      <p>UPDATE: The implementation of this change has been delayed for existing customers prior to August 29, 2022. We apologize for any confusion or inconvenience this has caused. From <b>August 21, 2023</b>, we are starting the rollout of this change. Please refer to the <a href="https://developers.pipedrive.com/changelog/post/update-to-the-breaking-changes-in-filter-conditions-for-filters-api" target="blank">updated announcement in Changelog</a> for further details.</p>
      
      <p>We are applying limits to filter conditions and removing 3 conditions from the Filters API to ensure a reliable experience and quick responses for all users.</p>
      
      <p><b>What is changing?</b></p>
      <p>We will be implementing a limit to the number of conditions a filter can have via the <code><a href="https://developers.pipedrive.com/docs/api/v1/Filters#addFilter" target="_self">POST /filters</a></code> and <code><a href="https://developers.pipedrive.com/docs/api/v1/Filters#updateFilter" target="_self">PUT /filters/{id}</a></code> endpoints.
        The new limit will be <b>16 conditions per filter</b>.</p>
      
      <p>If a filter is being added or updated to include more than 16 conditions, the request will fail and a <code>400</code> error response, similar to this one, will be returned:</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">"Filter is allowed to have at most 16 conditions"</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>
}
</div></code></pre></div></div>
      
      <p>In addition to the limit, we have now deprecated and will soon stop supporting the following filter conditions from the <code>conditions</code> body parameter of 
        the <code><a href="https://developers.pipedrive.com/docs/api/v1/Filters#addFilter" target="_self">POST /filters</a></code> and <code><a href="https://developers.pipedrive.com/docs/api/v1/Filters#updateFilter" target="_self">PUT /filters/{id}</a></code> endpoint:</p>
      <ul>
        <li><code>LIKE '%$'</code> <i>(ends with)</i></li>
        <li><code>NOT LIKE '%$%'</code> <i>(does not contain)</i></li>
        <li><code>NOT LIKE '%$'</code> <i>(does not end with)</i></li>
      </ul>
      
      <p>The new limit and removal of the 3 conditions will go into effect 
        on <b>August 29, 2022</b>. We advise you to review the filters you have 
        created and make sure that they adhere to the changes.</p>
      
			<p><b>Why is it changing?</b></p>
      <p>We've added new limits to the Filters API because complex filters can 
        easily cause system overload. As we are constantly improving our systems, 
        these limits will help to continuously support the excellent performance 
        of our API to apps and users.</p>
      
      <p><b>Who will be affected?</b></p>
      <p>Everyone who is using the specified <code>POST</code> and <code>PUT</code> endpoints to add and/or modify filters or has filters with more than 16 conditions in place.</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>


Changes in filter conditions for Filters API

<HTMLBlock>{`
<div class="chlog-box">
    <div class="from-area">
        <span class="from-label">Effective from:</span><br>
        <span class="from-date">August 21, 2022</span>
    </div>
    <div class="change-area">
      <p>We have now deprecated and will soon be removing the following 2 GlobalMessages API endpoints:</p>
      <ul>
        <li><code><a href="https://developers.pipedrive.com/docs/api/v1/GlobalMessages#getGlobalMessages" target="_self">GET /globalMessages</a></code></li>
        <li><code><a href="https://developers.pipedrive.com/docs/api/v1/GlobalMessages#deleteGlobalMessage" target="_self">DELETE /globalMessages/{id}</a></code></li>
      </ul>
      
      <p>We strongly advise you to avoid using these 2 deprecated endpoints.</p>
      
      <p><b>Why are we removing it?</b></p>
      <p>These two endpoints are a legacy way of getting and dismissing global messages. Due to a change in business logic, we have deprecated the old GlobalMessages functionality and a new solution has been implemented within the Pipedrive web app, which users have been migrated to.</p>
      
      <p>As our goal is to continuously improve our API and keep it consistent with our web app, we will, therefore, be removing these 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": ["Developer Platform"], "features": ["GlobalMessages"]}


<div class="chlog-box">
    <div class="from-area">
        <span class="from-label">Effective from:</span><br>
        <span class="from-date">August 21, 2022</span>
    </div>
    <div class="change-area">
      <p>We have now deprecated and will soon be removing the following 2 GlobalMessages API endpoints:</p>
      <ul>
        <li><code><a href="https://developers.pipedrive.com/docs/api/v1/GlobalMessages#getGlobalMessages" target="_self">GET /globalMessages</a></code></li>
        <li><code><a href="https://developers.pipedrive.com/docs/api/v1/GlobalMessages#deleteGlobalMessage" target="_self">DELETE /globalMessages/{id}</a></code></li>
      </ul>
      
      <p>We strongly advise you to avoid using these 2 deprecated endpoints.</p>
      
      <p><b>Why are we removing it?</b></p>
      <p>These two endpoints are a legacy way of getting and dismissing global messages. Due to a change in business logic, we have deprecated the old GlobalMessages functionality and a new solution has been implemented within the Pipedrive web app, which users have been migrated to.</p>
      
      <p>As our goal is to continuously improve our API and keep it consistent with our web app, we will, therefore, be removing these 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 GlobalMessages API

<HTMLBlock>{`
<div class="chlog-box">
    <div class="from-area">
        <span class="from-label">Effective from:</span><br>
        <span class="from-date">August 16, 2022</span>
    </div>
    <div class="change-area">
      <p>We are announcing a new rate limit for the Search API to improve our API performance. The new limit will go into effect on August 16, 2022.</p>
      
      <p><b>What is changing?</b></p>
      <p>The Search API will have a new rate limit of <b>10 requests per 2 seconds</b> per <code>api_token</code> and for OAuth apps using <code>access_token</code>. The change affects the following 7 endpoints:</p>
      <ul>
        <li><code><a href="https://developers.pipedrive.com/docs/api/v1/Deals#searchDeals" target="_self">GET /deals/search</a></code></li>
        <li><code><a href="https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem" target="_self">GET /itemSearch</a></code></li>
        <li><code><a href="https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItemByField" target="_self">GET /itemSearch/field</a></code></li>
        <li><code><a href="https://developers.pipedrive.com/docs/api/v1/Leads#searchLeads" target="_self">GET /leads/search</a></code></li>
        <li><code><a href="https://developers.pipedrive.com/docs/api/v1/Organizations#searchOrganization" target="_self">GET /organizations/search</a></code></li>
        <li><code><a href="https://developers.pipedrive.com/docs/api/v1/Persons#searchPersons" target="_self">GET /persons/search</a></code></li>
        <li><code><a href="https://developers.pipedrive.com/docs/api/v1/Products#searchProducts" target="_self">GET /products/search</a></code></li>
      </ul>
      
      <p>All other Pipedrive API endpoints, besides the 7 Search API endpoints, will continue to adhere to general <a href="https://pipedrive.readme.io/docs/core-api-concepts-rate-limiting" target="_self">rate limiting rules</a>.</p>
      
      <p><b>Why is it changing?</b></p>
      <p>We are introducing the granularity of the API rate limiting for Search API to ensure a reliable experience for all of our users.</p>
      <p>The new Search API rate limit allows us to deliver a higher quality service through a more stable API platform with quicker responses. It also serves to protect our systems from data overload by  increasing equality and efficiency in performance distribution.</p>
      
      <p><b>Who will be affected?</b></p>
      <p>Everyone who is using the listed Search API endpoints to access 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>


<div class="chlog-box">
    <div class="from-area">
        <span class="from-label">Effective from:</span><br>
        <span class="from-date">August 16, 2022</span>
    </div>
    <div class="change-area">
      <p>We are announcing a new rate limit for the Search API to improve our API performance. The new limit will go into effect on August 16, 2022.</p>
      
      <p><b>What is changing?</b></p>
      <p>The Search API will have a new rate limit of <b>10 requests per 2 seconds</b> per <code>api_token</code> and for OAuth apps using <code>access_token</code>. The change affects the following 7 endpoints:</p>
      <ul>
        <li><code><a href="https://developers.pipedrive.com/docs/api/v1/Deals#searchDeals" target="_self">GET /deals/search</a></code></li>
        <li><code><a href="https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItem" target="_self">GET /itemSearch</a></code></li>
        <li><code><a href="https://developers.pipedrive.com/docs/api/v1/ItemSearch#searchItemByField" target="_self">GET /itemSearch/field</a></code></li>
        <li><code><a href="https://developers.pipedrive.com/docs/api/v1/Leads#searchLeads" target="_self">GET /leads/search</a></code></li>
        <li><code><a href="https://developers.pipedrive.com/docs/api/v1/Organizations#searchOrganization" target="_self">GET /organizations/search</a></code></li>
        <li><code><a href="https://developers.pipedrive.com/docs/api/v1/Persons#searchPersons" target="_self">GET /persons/search</a></code></li>
        <li><code><a href="https://developers.pipedrive.com/docs/api/v1/Products#searchProducts" target="_self">GET /products/search</a></code></li>
      </ul>
      
      <p>All other Pipedrive API endpoints, besides the 7 Search API endpoints, will continue to adhere to general <a href="https://pipedrive.readme.io/docs/core-api-concepts-rate-limiting" target="_self">rate limiting rules</a>.</p>
      
      <p><b>Why is it changing?</b></p>
      <p>We are introducing the granularity of the API rate limiting for Search API to ensure a reliable experience for all of our users.</p>
      <p>The new Search API rate limit allows us to deliver a higher quality service through a more stable API platform with quicker responses. It also serves to protect our systems from data overload by  increasing equality and efficiency in performance distribution.</p>
      
      <p><b>Who will be affected?</b></p>
      <p>Everyone who is using the listed Search API endpoints to access 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>


Announcing Search API rate limit

<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>


Contents

Changelog

Announced changes

Subscribe to our Changelog

Subscribe to our Changelog

Subscribe to our
Changelog