Documentation
    {{docApp.userSession.userId}}
    {{docApp.userSession.userName}}
    {{docApp.userSession.email}}
    Issuer : {{docApp.userSession.issuerInstance}}
    Expires : {{new Date(docApp.userSession.validUntil).toLocaleDateString()}}

{{docApp.title}}

{{docApp.description}}

How can we help?

{{docApp.searchError}}
{{product.name}}

Searching in {{docApp.searchFilterBySpecificBookTitle}}

{{docApp.searchResultFilteredItems.length}} results for: {{docApp.currentResultsSearchText}} in {{docApp.searchFilterBySpecificBookTitle}}
Search results have been limited. There are a total of {{docApp.searchResponse.totalResultsAvailable}} matches.

You have an odd number of " characters in your search terms - each one needs closing with a matching " character!

{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

{{group.title || group.id}}

{{group.description}}

  1. {{book.title}}

{{group.title}}

{{book.title}}
More...

Deals / Deal Merge

  • Article
  • 5 minutes to read

Operation Information

Merges a pair of Pipedrive Deals.

This is a Premium Integration.

Authentication

This operation requires authentication, the details of which can be securely stored on your instance in a KeySafe Key of type API Key.

To create a key of this type:

  • In the Configuration area of your Hornbill instance, navigate to Platform Configuration > Security > KeySafe;
  • Click on the + Create New Key button;
  • On the resulting Create New Key form, choose API Key in the Type pick list;
  • Give the API Key KeySafe key a Title (this is the name / identifier for the API Key account as you will see it when using the cloud automation node in your workflows);
  • Optionally populate the Description field;
  • Populate the following fields accordingly, then click the Create Key button to create your new key:
Name Type Description
ApiKey string Authentication Key
API Endpoint string Optional API Endpoint

Tip

The API Endpoint field is not required to be populated for this integration - just an API Key for your Pipedrive account.

Revoking Access

If at any point you wish to revoke access to any of the above accounts from your Hornbill instance, just delete the relevant KeySafe key(s) from the KeySafe list.

Warning

This will revoke the rights of any existing Cloud Automation Node in your Hornbill Workflows that are using the revoked API Key account, so you will need to manage these workflows accordingly.

Input Parameters

Display Name ID Type Description Required Supported Values
Deal ID id number ID of the deal Yes None provided
Deal to merge ID mergeId number ID of the deal you want to merge with Yes None provided

Output Parameters

Display Name ID Type Description
Deal ID id number The ID of the Deal
Creator User ID creator_user_id number User ID for the creator of the deal
User ID user_id number User ID for the owner of the deal
Person ID person_id number User ID for the person associated to the deal
Organization ID org_id number The ID of the Organization
Stage ID stage_id number The ID of the Stage
Deal Title title string Deal Title
Deal Value value number Deal Value
Currency currency string 3 character code for the currency
Add Time add_time string The time the Deal was added
Update Time update_time string The last updated time of the Deal
Stage Change Time stage_change_time string The expected stage time of the Change
Deal Active? active boolean True / False is the deal active
Deal Deleted? deleted boolean True / False is the deal deleted
Deal Status status string The Status of the Deal
Next Activity Date next_activity_date string The date of the next activity for the Deal
Next Activity Time next_activity_time string The time of the next activity for the Deal
Next Activity ID next_activity_id number The next activity ID of the Deal
Last Activity ID last_activity_id number The last activity ID of the Deal
Last Activity Date last_activity_date string The last activity date of the Deal
Lost Reason lost_reason string The reason that the deal was lost
Visible To visible_to string The number of users the deal is visible to
Close Time close_time string The closing time of the Deal
Pipeline ID pipeline_id number The Pipeline ID of the Deal
Won Time won_time string The time the Deal was won.
First Won Time first_won_time string The time the Deal was first won.
Lost Time lost_time string The time the Deal was lost.
Products Count products_count number The products count of the Deal
Files Count files_count number The files count of the Deal
Notes Count notes_count number The notes count of the Deal
Followers Count followers_count number The number of users following the Deal
Email Messages Count email_messages_count number The number of email messages of the Deal
Activities Count activities_count number The number of activities associated to the deal.
Done Activities Count done_activities_count number The number of done activities associated to the deal.
Undone Activities Count undone_activities_count number The number of undone activities associated to the deal.
Reference Activities Count reference_activities_count string The number of reference activities of the Deal
Participants Count participants_count number The number of participants in the Deal
Expected Close Date expected_close_date string The expected closing date of the Deal
Last Incoming Mail Time last_incoming_mail_time string The last incoming mail time of the Deal
Last Outgoing Mail Time last_outgoing_mail_time string The last outgoing mail time of the Deal
Stage Order NR stage_order_nr number The stage order number of the Deal
Person Name person_name string The person name associated to the Deal
Organization Name org_name string The Organization name associated to the Deal
Next Activity Subject next_activity_subject string The next activity subject of the Deal
Next Activity Type next_activity_type string The next activity type of the Deal
Next Activity Duration next_activity_duration string The next activity duration of the Deal
Next Activity Note next_activity_note string The next activity Note of the Deal
Formatted Value formatted_value string The formatted value
Rotten Time rotten_time string The rotten time of the Deal
Weighted Value weighted_value number Weighted Value (number)
Formatted Weighted Value formatted_weighted_value string Formatted weighted value (string)
Owner Name owner_name string Name of the Owner
CC Email cc_email string The emails CC’d in to the Deal
Organization Hidden org_hidden boolean Is the Organization associated with the Deal hidden
Person Hidden person_hidden boolean Is the Person associated with the Deal hidden
Merge What ID merge_what_id number Merge ID
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document