LogoLogo
HomeSupport centerAPP
  • Overview
    • Quick Start
    • About the API
    • Authentication
  • API Reference
    • REST API
    • GraphQL API
  • Core API Concepts
    • Understanding the CRM Concept
    • Fields
    • API parameters
    • Dates
    • Pagination
    • Bulk Create, Update, Delete
    • Webhooks(Real-time updates)
  • Tutorials & Articles
    • Create Account
    • Create Contact
    • Create Opportunity
    • Create Product, Product Line Item
    • Create Custom Entity Record
    • Upload Document
    • Merging Accounts/Contacts
Powered by GitBook
On this page
  1. Tutorials & Articles

Merging Accounts/Contacts

PreviousUpload Document

Last updated 3 years ago

This tutorial should help you merge Accounts or Contact. Before moving forward, make sure your works and you understand the of the Pipeliner API, and make sure you know how to use

When you have two similar Accounts or Contacts you can use merge functionality to move all data from a duplicate to the master record. The Duplicate will be deleted at the same time

Merging Accounts

Merging Contacts

Example of Account Merging

/POST /entities/Accounts/merge
{
    "master": {
        "id": "4590b5a8-134a-404e-96f5-b40256bebc39"
    },
    "secondary_ids": [
        "109e5d1c-6d10-449b-b244-28438a428926"
    ]
}

master- This record will inherit data from a duplicate defined in secondary_ids

secondary_ids - An Array of Duplicates, use Account IDs to specify the Accounts. All duplicates are automatically deleted

The merging functionality through API works in the same way as

in the Application.
Authentication
Key Concepts
API parameters
  • POST/entities/Accounts/merge
  • POST/entities/Contacts/merge
post

Merger multiple Accounts into master record.

Body
secondary_idsstring · uuid[]Optional

An id of secondary account.

Responses
200
Merged entity
application/json
500
unexpected error
application / json
post
POST /api/v100/rest/spaces/<space_id>/entities/Accounts/merge HTTP/1.1
Host: us-east.pipelinersales.com
Content-Type: application/json
Accept: */*
Content-Length: 1262

{
  "master": {
    "created": "2019-01-01T00:00:00",
    "picture": {
      "id": "https://example.com"
    },
    "account_class": 1,
    "account_type_id": "01234567-abcd-dcba-ffff-000000000000",
    "address": "string",
    "city": "string",
    "comments": "string",
    "country": "string",
    "customer_type_id": "01234567-abcd-dcba-ffff-000000000000",
    "email1": "string",
    "email2": "string",
    "email3": "string",
    "email4": "string",
    "email5": "string",
    "home_page": "string",
    "industry_id": "01234567-abcd-dcba-ffff-000000000000",
    "name": "string",
    "owner_id": "01234567-abcd-dcba-ffff-000000000000",
    "parent_account_id": "01234567-abcd-dcba-ffff-000000000000",
    "parent_account_relation_type_id": "01234567-abcd-dcba-ffff-000000000000",
    "phone1": "string",
    "phone2": "string",
    "phone3": "string",
    "phone4": "string",
    "phone5": "string",
    "picture_id": "01234567-abcd-dcba-ffff-000000000000",
    "quick_parent_account_name": "string",
    "share_mode": 0,
    "state_province": "string",
    "unit_id": "01234567-abcd-dcba-ffff-000000000000",
    "zip_code": "string",
    "revision": 1,
    "social_media": {
      "id": "https://example.com"
    },
    "sharing_units": [
      {
        "id": "https://example.com"
      }
    ],
    "sharing_clients": [
      {
        "id": "https://example.com"
      }
    ],
    "documents": [
      {
        "id": "https://example.com"
      }
    ],
    "is_unsubscribed": false,
    "id": "123e4567-e89b-12d3-a456-426614174000"
  },
  "secondary_ids": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}
{
  "success": true,
  "data": {
    "is_delete_protected": false,
    "id": "01234567-abcd-dcba-ffff-000000000000",
    "is_deleted": false,
    "modified": "2019-01-01T00:00:00",
    "created": "2019-01-01T00:00:00",
    "account_type": "https://example.com",
    "customer_type": "https://example.com",
    "industry": "https://example.com",
    "owner": "https://example.com",
    "parent_account": "https://example.com",
    "parent_account_relation_type": "https://example.com",
    "picture": "https://example.com",
    "unit": "https://example.com",
    "account_class": 1,
    "account_type_id": "01234567-abcd-dcba-ffff-000000000000",
    "address": "string",
    "city": "string",
    "comments": "string",
    "country": "string",
    "customer_type_id": "01234567-abcd-dcba-ffff-000000000000",
    "email1": "string",
    "email2": "string",
    "email3": "string",
    "email4": "string",
    "email5": "string",
    "health_category": "01234567-abcd-dcba-ffff-000000000000",
    "health_status": 1,
    "home_page": "string",
    "industry_id": "01234567-abcd-dcba-ffff-000000000000",
    "name": "string",
    "owner_id": "01234567-abcd-dcba-ffff-000000000000",
    "parent_account_id": "01234567-abcd-dcba-ffff-000000000000",
    "parent_account_relation_type_id": "01234567-abcd-dcba-ffff-000000000000",
    "phone1": "string",
    "phone2": "string",
    "phone3": "string",
    "phone4": "string",
    "phone5": "string",
    "picture_id": "01234567-abcd-dcba-ffff-000000000000",
    "quick_parent_account_name": "string",
    "share_mode": 0,
    "state_province": "string",
    "unit_id": "01234567-abcd-dcba-ffff-000000000000",
    "zip_code": "string",
    "revision": 1,
    "formatted_name": "string",
    "social_media": "https://example.com",
    "sharing_units": [
      "https://example.com"
    ],
    "sharing_clients": [
      "https://example.com"
    ],
    "documents": [
      "https://example.com"
    ],
    "is_favorite": false,
    "is_unsubscribed": false,
    "health": {}
  }
}
post

Merger multiple Contacts into master record.

Body
secondary_idsstring · uuid[]Optional

An id of secondary contact.

Responses
200
Merged entity
application/json
500
unexpected error
application / json
post
POST /api/v100/rest/spaces/<space_id>/entities/Contacts/merge HTTP/1.1
Host: us-east.pipelinersales.com
Content-Type: application/json
Accept: */*
Content-Length: 1232

{
  "master": {
    "created": "2019-01-01T00:00:00",
    "picture": {
      "id": "https://example.com"
    },
    "address": "string",
    "city": "string",
    "comments": "string",
    "contact_type_id": "01234567-abcd-dcba-ffff-000000000000",
    "country": "string",
    "email1": "string",
    "email2": "string",
    "email3": "string",
    "email4": "string",
    "email5": "string",
    "first_name": "string",
    "gender": 0,
    "last_name": "string",
    "middle_name": "string",
    "owner_id": "01234567-abcd-dcba-ffff-000000000000",
    "phone1": "string",
    "phone2": "string",
    "phone3": "string",
    "phone4": "string",
    "phone5": "string",
    "picture_id": "01234567-abcd-dcba-ffff-000000000000",
    "position": "string",
    "quick_account_name": "string",
    "share_mode": 0,
    "state_province": "string",
    "title": "string",
    "unit_id": "01234567-abcd-dcba-ffff-000000000000",
    "zip_code": "string",
    "revision": 1,
    "social_media": {
      "id": "https://example.com"
    },
    "account_relations": [
      {
        "id": "https://example.com"
      }
    ],
    "sharing_units": [
      {
        "id": "https://example.com"
      }
    ],
    "sharing_clients": [
      {
        "id": "https://example.com"
      }
    ],
    "documents": [
      {
        "id": "https://example.com"
      }
    ],
    "exchange_entity_id": "string",
    "gapi_entity_id": "string",
    "o365_entity_id": "string",
    "account_position": "string",
    "is_unsubscribed": false,
    "id": "123e4567-e89b-12d3-a456-426614174000"
  },
  "secondary_ids": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}
{
  "success": true,
  "data": {
    "is_delete_protected": false,
    "id": "01234567-abcd-dcba-ffff-000000000000",
    "is_deleted": false,
    "modified": "2019-01-01T00:00:00",
    "created": "2019-01-01T00:00:00",
    "contact_type": "https://example.com",
    "owner": "https://example.com",
    "picture": "https://example.com",
    "unit": "https://example.com",
    "address": "string",
    "city": "string",
    "comments": "string",
    "contact_type_id": "01234567-abcd-dcba-ffff-000000000000",
    "country": "string",
    "email1": "string",
    "email2": "string",
    "email3": "string",
    "email4": "string",
    "email5": "string",
    "first_name": "string",
    "gender": 0,
    "last_name": "string",
    "middle_name": "string",
    "owner_id": "01234567-abcd-dcba-ffff-000000000000",
    "phone1": "string",
    "phone2": "string",
    "phone3": "string",
    "phone4": "string",
    "phone5": "string",
    "picture_id": "01234567-abcd-dcba-ffff-000000000000",
    "position": "string",
    "quick_account_name": "string",
    "share_mode": 0,
    "state_province": "string",
    "title": "string",
    "unit_id": "01234567-abcd-dcba-ffff-000000000000",
    "zip_code": "string",
    "revision": 1,
    "formatted_name": "string",
    "social_media": "https://example.com",
    "primary_account": "https://example.com",
    "account_relations": [
      "https://example.com"
    ],
    "sharing_units": [
      "https://example.com"
    ],
    "sharing_clients": [
      "https://example.com"
    ],
    "documents": [
      "https://example.com"
    ],
    "is_favorite": false,
    "primary_account_account_roles": [
      "https://example.com"
    ],
    "primary_account_position": "string",
    "account_position": "string",
    "is_unsubscribed": false
  }
}