Skip to main content

How to migrate buttons to Pipedrive API v2

TL;DR: It is recommended to migrate your buttons to Pipedrive API v2. One by one, make a copy of your button, switch it to v2, re-map data fields where needed and test with your existing back-end workflow. Button payload may be partially different with v2 so there may be breaking changes.

Pipedrive has introduced new API v2 end-points during 2025, and is recommending moving existing applications to use the new version. As a Pipedrive add-on OneClick makes API calls to read data from Pipedrive in order to be able to operate. Hence, we're introducing the capability to migrate your buttons to the new API version. The new version offers better performance and reliability compared to v1, which is reflected generally as better performance of OneClick.

Migrating your buttons to v2 is a manual process, as the v2 field data schema is partially different from v1. This document explains the steps and best practices for migrating you buttons from v1 to v2.

While there is no hard deadline at the time being for v2 migration, it is generally recommended to start to migrate your buttons as soon as possible. We will be sharing more information on the timeline as we get more detailed information from Pipedrive.

1. Make a copy of your button

To ensure seamless migration to v2, it is recommended to first make a copy of your button, hide it from others and then migrate the copied button to v2. Afterwards you can publish the new migrated button to others and hide/delete the old button.

Make a copy of your button in the button list view by clicking on the copy icon:

image.png

Go and edit your copied button, and head to the Limit Visibility tab: (enable the visibility setting with the toggle in the menu, if not previously enabled)

image.png

Select only yourself (or the users you want to) in the "Show for users" selection to hide the button from others. Remember to save your button for the visibility settings to be effective.

2. Switch to v2

To migrate your button to v2, switch the toggle in the "Button" section in your button settings:

image.png

3. Check your data field mappings

Once the button has been switched to v2, please check if you need to re-map any fields in your button configuration.

3.1 Workflow buttons

If there are any fields that need to be re-mapped, this is indicated with a red error icon in the menu on the Custom Fields tab:

image.png

If no errors are being indicated save your button and continue to the next step

If errors are being indicated, head to the Custom Fields tab and locate the fields that have been marked with the same error icon:

image.png

Select the field on the left side and re-map the field in the Field selection input by searching for the correct field. Repeat until all fields have been corrected. Remember to save your button.

Re-mapping the fields also affects Advanced validation. If you use Advanced validation rules please check your configuration and re-select the fields in the validation rules accordingly after the fields have been re-mapped

If any fields need to be re-mapped, this is indicated with a red error icon on the Dynamic URL tab:

image.png

If no errors are being indicated save your button and continue to the next step

If errors are being indicated, head to the Dynamic URL tab and locate the fields that have been marked with the same error icon:

image.png

Select a field with an error from the dynamic URL blocks and delete the block:

image.png

Add a new block at the same position and select the re-mapped field in case from the field list:

image.png

Repeat until all fields have been corrected. Remember to save your button.

4. Test with your back-end process

Now that your button has been migrated to v2, it should be tested with your existing back-end process.

With workflow buttons this is slightly more complex, as the v2 data field schema is partially different from v1. This means that the payload sent with a v2 button click may be different from v1, potentially affecting you process.

If your received payload differs from the original: While we do not publish specific instructions for each low/no-code platform separately (such as Make.com, Zapier, n8n etc.) it is generally recommended to make a copy of your workflow, point your migrated button to this copied workflow and adjust it according to the new button payload.. This allows you to have the original v1 button/workflow combination running until your new v2 button/workflow has been fully tested and proved to work.

5. Publish the migrated button

Once everything has been tested and proved to work, you can revert the changes made to Limit Visibility in step 1., or alternatively turn the Limit Visibility feature off if not needed otherwise.

At the same time you can either delete the original v1 button, or make it hidden from others if you do not want to delete it completely.