API Docs / Schemas / MergeContactRequest

MergeContactRequest

Request to merge a duplicate contact into this (surviving) contact.
The duplicate's client links are moved to the surviving contact and the duplicate is deleted.

Properties

Name Type Description
duplicateCode*string

The code of the duplicate contact to merge into the surviving contact.
The duplicate contact is permanently deleted once the merge completes.

The code of the duplicate contact to merge into the surviving contact.
The duplicate contact is permanently deleted once the merge completes.

fieldsFromDuplicatearray of enum

Contact fields whose value should be taken from the duplicate contact.
Only the Contact-group members (ContactTitle, ContactFirstName, ContactEmail, ...)
plus Utr and NiNumber are valid here — Utr and NiNumber mean the contact's own values.
Fields not listed keep the surviving contact's value; fields that are empty on the
survivor are filled from the duplicate automatically.

Name Code Type Status Email Telephone InternalReference CanContactPost CanContactTelephone CanContactEmail CanContactSms PclSent Manager Partner Associate CompanyNumber CompaniesHouseAuthenticationCode VatNumber VatRegistered VatRegDate VatScheme VatReportingPeriod Utr SelfAssessmentUtr CompanyUtr NiNumber PayeRef AccountsOfficeRef TradingAs NatureOfBusiness IncorporationDate RegisteredAddress PostalAddress InvoiceAddress RegisteredAddressLine1 RegisteredAddressLine2 RegisteredAddressLine3 RegisteredAddressCity RegisteredAddressPostCode RegisteredAddressCountry PostalAddressLine1 PostalAddressLine2 PostalAddressLine3 PostalAddressCity PostalAddressPostCode PostalAddressCountry InvoiceAddressLine1 InvoiceAddressLine2 InvoiceAddressLine3 InvoiceAddressCity InvoiceAddressPostCode InvoiceAddressCountry ContactName ContactTitle ContactFirstName ContactMiddleName ContactLastName ContactEmail ContactPhone ContactMobile ContactDateOfBirth PersonalCode ContactRelationships Team Website ContactNationality ContactMaritalStatus ContactAddress VatPeriodEnd Notes ImportantNotes SicCodes DateOfTrading TradingAsSoleTrader LinkedInUrl FacebookUrl TwitterUrl InstagramUrl AuthSelfAssessment AuthCorporationTax AuthPayeForEmployers AuthIndividualPayAsYouEarn AuthVat AuthConstructionIndustryScheme AuthTaxCredits AuthHighIncomeChildBenefitCharge AuthMakingTaxDigitalIncomeTax AuthMakingTaxDigitalVat AuthTrusts AmlClientId Notes2 Notes3 Notes4 Notes5 VatFlatRateScheme AmlContactId RelatedClientName ContactIsPrimary ContactJobTitle RegisteredAddressCounty PostalAddressCounty InvoiceAddressCounty ContactPreferredName

Contact fields whose value should be taken from the duplicate contact.
Only the Contact-group members (ContactTitle, ContactFirstName, ContactEmail, ...)
plus Utr and NiNumber are valid here — Utr and NiNumber mean the contact's own values.
Fields not listed keep the surviving contact's value; fields that are empty on the
survivor are filled from the duplicate automatically.

Name Code Type Status Email Telephone InternalReference CanContactPost CanContactTelephone CanContactEmail CanContactSms PclSent Manager Partner Associate CompanyNumber CompaniesHouseAuthenticationCode VatNumber VatRegistered VatRegDate VatScheme VatReportingPeriod Utr SelfAssessmentUtr CompanyUtr NiNumber PayeRef AccountsOfficeRef TradingAs NatureOfBusiness IncorporationDate RegisteredAddress PostalAddress InvoiceAddress RegisteredAddressLine1 RegisteredAddressLine2 RegisteredAddressLine3 RegisteredAddressCity RegisteredAddressPostCode RegisteredAddressCountry PostalAddressLine1 PostalAddressLine2 PostalAddressLine3 PostalAddressCity PostalAddressPostCode PostalAddressCountry InvoiceAddressLine1 InvoiceAddressLine2 InvoiceAddressLine3 InvoiceAddressCity InvoiceAddressPostCode InvoiceAddressCountry ContactName ContactTitle ContactFirstName ContactMiddleName ContactLastName ContactEmail ContactPhone ContactMobile ContactDateOfBirth PersonalCode ContactRelationships Team Website ContactNationality ContactMaritalStatus ContactAddress VatPeriodEnd Notes ImportantNotes SicCodes DateOfTrading TradingAsSoleTrader LinkedInUrl FacebookUrl TwitterUrl InstagramUrl AuthSelfAssessment AuthCorporationTax AuthPayeForEmployers AuthIndividualPayAsYouEarn AuthVat AuthConstructionIndustryScheme AuthTaxCredits AuthHighIncomeChildBenefitCharge AuthMakingTaxDigitalIncomeTax AuthMakingTaxDigitalVat AuthTrusts AmlClientId Notes2 Notes3 Notes4 Notes5 VatFlatRateScheme AmlContactId RelatedClientName ContactIsPrimary ContactJobTitle RegisteredAddressCounty PostalAddressCounty InvoiceAddressCounty ContactPreferredName

JSON Example

{
  "duplicateCode": "string",
  "fieldsFromDuplicate": [
    "Name"
  ]
}

Used By Operations