Pipedrive API Documentation

Pipedrive's API Docs

Welcome to Pipedrive's Developer Documentation. Here you'll find comprehensive guides and documentation to help you start working with Pipedrive's API, as well as the Changelog to see any relevant changes regarding the public API.

Merging two Deals

Have a sudden urge to merge two Deals together, but don't know how to do it? No worries, you've come to the right place to solve your problem. On how to merge deals in the Pipedrive's web app, see here.

Only want to see the finished code? No problem! You can find it below.

How to make sure you're merging the right Deal?

When merging, you'll want to pay attention to which Deal you want to be merged with (conflicting data is kept) and which Deal will be merged (conflicting data is removed). While the terminology may seem similar, knowing which Deal has priority and which Deal will be removed is very important.

The ID of Deal you want to be merged with will give value to the merge_with_id parameter. This Deal will have priority over the other Deal and its data will be kept.

The ID of the Deal that will be merged will be added to the target URL. This Deal will be removed from your Pipedrive account and any conflicting data will be lost.

What if both Deals have data in the same Field?

If both Deals have data in the same Field, the Deal of merge_with_id will be considered more important as its field data will remain unchanged, but the other Deal's field data will be lost. If the Deal of merge_with_id has empty fields, but the other Deal has content in them, it will be added to the Deal of merge_with_id.

Regardless of field conflicts, all related data (activities, emails, filters, notes, products, followers, participants) will be transferred and stored.

Continue with the step by step tutorial:

Step 1: Get your API token and company domain

Follow our tutorials on how to find the API token and how to get the company domain. Then create a file mergingTwoDeals.php and first give value to the $api_token and $company_domain variables:

<?php
// Content of mergingTwoDeals.php
    
// Pipedrive API sample token
$api_token = '659c9fddb16335e48cc67114694b52074e812e03';
    
// Pipedrive company domain
$company_domain = 'theunicorntail';

Step 2: Prepare the data

When merging two Deals, there's one required parameter you have to give value to in the request body:

  • merge_with_id - the ID of the Deal, which will remain in your Pipedrive account and is merged with the other Deal (conflicting data is kept)

Here are the ways you can find the deal_id:
a) click on the Deal in the pipeline and find the ID at the end of the URL
b) from the Deal List View ID column
c) fetch all Deals using the API via GET /deals (no need to use any parameters)

To send the required parameter with your chosen value for the merging, you need to create an array with this parameter.

// ID of the deal which will remain in your Pipedrive account and is merged with the other deal
$deal = array(
  'merge_with_id' => 'ID of the deal, which will remain in your PD account and is merged with the other deal',
);

Step 3: Define target URL

To make a request, you'll need the correct URL meant for merging Deals. All available endpoints and their URLs are described in our API Reference. You must provide the API token as part of the query string for all requests at the end of the URL, an example would look like this https://companydomain.pipedrive.com/api/v1/deals/190/merge?api_token=659c9fddb16335e48cc67114694b52074e812e03

In the URL you're using for merging two Deals, you need to specify which Deal is going to be merged and eventually not be visible. Don't forget to replace the example URL's company name for yours. You also need to insert the ID of the Deal that will be merged instead of the placeholder of {id}.

// Specify the Deal you want to be merged by inserting it's ID instead of {id}
$url = 'https://' . $company_domain . '.pipedrive.com/api/v1/deals/{id}/merge?api_token=' . $api_token;

Step 4: Make a PUT request

This part of the code is more complex and you don’t need to understand it right away, all you need to know is that it contains everything to make a PUT request with your data against our API. To make the request, simply copy and paste this:

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "PUT");
curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($deal));
  
echo 'Sending request...' . PHP_EOL;
  
$output = curl_exec($ch);
curl_close($ch);

Step 5: Check the result

$output variable holds the full response you get back from the server. As a reminder, all responses from us are in JSON format, the first thing you'll want to do is to convert it into a proper PHP array.

// Create an array from the data that is sent back from the API
// As the original content from server is in JSON format, you need to convert it to PHP array
$result = json_decode($output, true);

After that, you should check if the request was successful. One way to do it is to check the success property of the response. If it's true, then it means the Deals were merged successfully.

// Check if the merging was successful.
// If it did, print out the title of the Deal the two Deals are now merged into
if ($result['success'] === true) {
  echo 'Deals are now merged into a Deal called '
    . $result['data']['title'] . ' (Deal ID: ' . $result['data']['id'] . ')' . PHP_EOL;
}

Full working example

Copy the full working example into mergingTwoDeals.php:

<?php
// Content of mergingTwoDeals.php
    
// Pipedrive API sample token
$api_token = '659c9fddb16335e48cc67114694b52074e812e03';
    
// Pipedrive company domain
$company_domain = 'theunicorntail';
 
// ID of the Deal which will remain in your Pipedrive account and is merged with the other deal
$deal = array(
  'merge_with_id' => 'ID of the Deal, which will remain in your PD account and is merged with the other deal',
);
 
// Specify the Deal you want to be merged by inserting it's ID instead of {id}
$url = 'https://' . $company_domain . '.pipedrive.com/api/v1/deals/{id}/merge?api_token=' . $api_token;
 
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "PUT");
curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($deal));
  
echo 'Sending request...' . PHP_EOL;
  
$output = curl_exec($ch);
curl_close($ch);
 
// Create an array from the data that is sent back from the API
// As the original content from server is in JSON format, you need to convert it to PHP array
$result = json_decode($output, true);
 
// Check if the merging was successful
// If it did, then print out the title of the Deal the two Deals are now merged into
if ($result['success'] === true) {
  echo 'Deals are now merged into a Deal called '
    . $result['data']['title'] . ' (Deal ID: ' . $result['data']['id'] . ')' . PHP_EOL;
}

Execute the code

Now run the command php mergingTwoDeals.php in terminal and you should see the following output:

$ php mergingTwoDeals.php
Sending request...
Deals are now merged into a Deal called {Deal title} (Deal ID: {deal_id})

Updated 4 months ago

Merging two Deals


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.