Merges two contacts into one.

• Parameters (there are two ways to identify the contacts to be merged):

  • By Contact IDs:
    • from_contact_id - the ID of the contact to be merged into the main contact.
    • to_contact_id - the ID of the contact in which the merge will be performed.
    • update_name - whether to update the name of the TO contact with the name of the FROM contact. Default is false.
  • By Contact Phones:
    • from_contact_phone - the phone of the contact to be merged into the main contact.
    • to_contact_phone - the phone of the contact in which the merge will be performed.
    • update_name - whether to update the name of the TO contact with the name of the FROM contact. Default is false.

• Once merged, the from_contact will have:

  • its email and phone fields set to null
  • its state value set to merged
  • will no longer be accessible/visible/usabl (as its information will now belong to the to_contact).

• The to_contact will have:

  • its email and phone fields set to the values of the from_contact if they are not null. Otherwise, it will keep its current values.
  • if update_name parameter is set to true, its name, first_name, last_name fields will inherit the from_contact's values.

• Many records in related tables are inherited, merged, overwritten, deleted or updated based during the merge process.

  • Conversations, Messages, Message Attachments, Contact Events, Conversation Events:

    • email conversations are inherited by the to_contact.
    • phone conversations:
      • are inherited by the to_contact for channels it doesn't already have conversations with.
      • have their messages and attachments transferred to the corresponding existing conversation for every channel it already has conversation on.
    • whatsapp conversations follow the same rules as phone conversations.
    • All Scheduled Message Jobs for the inherited messages are deleted.
    • All Contact Events are inherited by the to_contact.
    • All Conversation Events are inherited by the to_contact (and shown in the respective conversation).

  • Communication Preference:

    • if from_contact doesn't have preferences, to_contact's preferences remain unchanged.
    • if from_contact has preferences, to_contact loses its current ones and inherits from_contact's.

  • Conversation Agent Session:

    • All currently existing agent sessions to_contact has remain unchanged.
    • All new ones are inherited by to_contact's respective conversations.

  • Contact Integration:

    • All are inherited by to_contact.

  • Contact Tag:

    • Any currently existing tags tocontact has remain unchanged.
    • All new tags are inherited by to_contact.

  • Note:

    • Any currently existing notes to_contact has remain unchanged.
    • All new notes are inherited by to_contact.

  • Any existing data related to Sequence Runs, Steps, Campaigns that from_contact has is updated to point to the to_contact respectively (as it's the inheritor of from_contact).

  • No other information(data) is moved/merged/inherited by the to_contact.