Merge Leads

Lets you merge two leads. To use this API –

  • Pass the “MasterId” of the parent lead in the API URL. This lead will retain its field values, activities and notes. You can pass the “LeadId” of any existing lead here.
  • Pass the “ChildId” of the child lead in the API URL. This lead will be absorbed into the parent lead and won’t retain its own field values. You can pass the “LeadId” of an existing lead or the “MXCProspectId” of a website visitor.

If you want to choose each value to retain while merging two leads, use the Lead Merge feature on the UI.

API URL

POST
https://{host}/v2/LeadManagement.svc/Lead.Merge?accessKey=AccessKey&secretKey=SecretKey&masterId=MasterId&childId=ChildId
Copy URL

URL Parameters

Parameter Description
MasterId The Id of Lead that will retain its field values, activities and notes.
ChildId The Id of the Lead that won't retain its field values, activities and notes.

Response

200 OK

Content-Type: application/json

{
    "Status": "Success"
}

HTTP Response Code

Code Description
200 OK

This is the status code for successful API call.

401 Unauthorized

The API call was made with invalid access credentials. Check your AccessKey and SecretKey.

400 Bad Request

The message body on the request is not as per API specification. Make sure that content type is set to “application/json” and the JSON body has correct attribute names and structure.

404 Not Found

The API could not be found. Please check the API signature.

429 Too Many Requests

API calls exceeded the limit of 25 in 5 second(s)

500 Internal Server Error

The API called failed. There could be many reasons for it. Check the exception message to get more details.