There's a new version of the HubSpot API

As of November 30, 2022, HubSpot API keys are no longer a supported authentication method for accessing HubSpot APIs. Instead, you should use a private app access token or OAuth to authenticate API calls. Learn more about this change and how to migrate an API key integration to use a private app instead.

Merge Contacts

Last updated May 12, 2023

POST /contacts/v1/contact/merge-vids/:contact_id/

Method Details

HTTP Methods:

POST

Content Type:

application/json

Response Format:

json

Requires Authentication?

Yes

Rate Limited?

Yes

Headers

User-Agent

Products:

Marketing & CRM

Required Scope:

crm.objects.contacts.write

Merge two contact records. The contact ID in the URL will be treated as the primary contact, and the contact ID in the request body will be treated as the secondary contact.  For more details about what happens when you merge two contact records, please see this knowledge article.

Note: Merging contacts cannot be undone. The data from the secondary contact will be merged into the primary contact, and while you can see the combined history of the two records in the resulting single contact, there is not a way to separate the contacts after the merge.

Required Parameters How to use Description
OAuth access token or private app access token Authorization: Bearer {token} header Used to authenticate the request. Please see this page for more details about authentication.
 Contact ID Used in the request URL Unique identifier for a particular contact. In HubSpot's contact system, contact ID's are called "vid". 
 vidToMerge Used in the request body Unique identifier for a particular contact.