Jump to: navigation, search

MergeContacts

Purpose

This method is intended for merging of two existing contacts.

This service implements the following actions:

  • The contact attributes of previous contact are merged into contact attributes of new contact. All primary attributes of new contact are kept primary while primary attributes of old contact are changed to not primary.
  • All the interactions are assigned to the destination contact.
  • The source contact is deleted.
  • A record is inserted in the table MergedContact, with Id = sourceContactId and MergeId = destinationContactId.

URL

  • PUT /OMContacts/MergeContacts/


Request

Parameters

Key ValueType Value Description Mandatory Unique Default
AgentId Integer Existing agent Id Id of the agent requesting the merge false true 0 for no Agent ID
SourceContactId String Existing contact Id Id of the contact that is to be deleted as the result of the merge operation true true
DestinationContactId String Existing contact Id Id of the contact that remains as the result of the merge operation true true
ForceMerge Boolean Force the merge in case of extension conflicts. Do not fail and use the source value for the merged contact. false true false
Reason String false true
Description String false true
TenantId Integer true true
SubscriberId String The subscriber (that is, line of business) within the tenant to which the contact belongs false true

Success

Parameters

Key ValueType Value Description Mandatory Unique Default
MergeId String Id of this successful merge operation. true true


Error

FaultCode FaultString Description
510 (Id) not found in database (SourceContactId) was not found in database
510 (Id) not found in database (DestinationContactId) was not found in database
201 Missing parameter 'SubscriberId' SubscriberId was not provided but is a required parameter
921 SubscriberId is invalid or not active The provided SubscriberId is not valid

Feedback

Comment on this article:

blog comments powered by Disqus
This page was last modified on May 18, 2018, at 07:05.