Get Info on Merged Child Leads
This API lets you retrieve the data of child leads that have been merged through Lead Merge actions.
Note: All unique fields of the child leads will be retrieved as null, except for EmailAddress & Phone (if unique).
API URL
Request
Content-Type: application/json{ "Parameter": { "MergeAuditId": "fa3a64ea-cd4c-11e9-9905-069b743e848f" } }
Request Parameters
Parameter | Description |
---|---|
MergeAuditId | This is the Id of the lead merge event. You can get this Id by calling the Activity Retrieve APIs and passing the “ActivityEvent” parameter as 3003. |
Response
[ { "mx_Portal_IsPortalUser": null, "mx_Doctors": null, "mx_Identification_Documents": null, "mx_Identification": null, "mx_Renewal_Date": null, "mx_Is_Permanent_Address_Same_as_Current_Address": null, "mx_Do_You_Have_a_Co_Applicant": null, "mx_Permanent_Address_2": null, "mx_Permanent_Address_1": null, "mx_Co_Applicant_Email": null, "mx_Co_Applicant_Last_Name": null, "mx_Co_Applicant_First_Name": null, "JobTitle": null, "RelatedCompanyId": null, "IsPrimaryContact": null, "DoNotTrack": null, "CurrentOptInStatus": null, "OptInDate": null, "OptInDetails": null, "LastOptInEmailSentDate": null, "mx_12th_Grade_Results": null, "mx_Age": null, "mx_Custom_Score": null, "mx_Secondary_Email": null, "mx_Secondary_Email_Address": null, "mx_Athlete_Age": null, "mx_Gym": null, "mx_Weight_Division": null, "ProspectID": "153b372d-7b96-11e9-ae3d-020714094d7e", "ProspectAutoId": "1111", "FirstName": "John", "LastName": "Smith", "EmailAddress": "john.smith@corporation.com", "Source": "Organic Search", "Notes": "Sample Record for reference. Please delete.", "Phone": "+1 678 608 3550", "Mobile": null, "Website": null, "TimeZone": null, "Company": "Example Company", "DoNotCall": "0", "DoNotEmail": "1", "ProspectStage": "Prospect", "Score": "0", "OwnerId": "3b1041fb-8374-11e7-8758-0a106ee76b21", "CreatedOn": "2019-05-21 07:01:30.000", "ModifiedOn": "2019-09-19 08:11:27.000", "LeadConversionDate": "2019-05-21 07:01:30.000", "mx_Street1": null, "mx_Street2": null, "mx_City": "San Francisco", "mx_State": "CA", "mx_Country": "USA", "mx_Zip": "94100", "SourceCampaign": null, "SourceMedium": null, "SourceContent": null, "EngagementScore": "0", "Origin": "Lead Import", "Revenue": null, "MailingPreferences": null, "QualityScore01": null, "TwitterId": null, "FacebookId": null, "LinkedInId": null, "SkypeId": null, "GTalkId": null, "GooglePlusId": null, "PhotoUrl": null, "ConversionReferrerURL": null, "SourceReferrerURL": null, "SourceIPAddress": null, "Latitude": null, "Longitude": null, "CanUpdate": "true" } ]
HTTP Response Codes
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. |