Jump to: navigation, search

GetMergeDetail

Purpose

Returns details about a previous merge operation.

URL

  • GET /OMContacts/GetMergeDetail/

Request

Parameters

Key ValueType Value Description Mandatory Unique Default
MergeId String Existing merge Id Identifies the existing MergeId for which details are required. false true
SourceContactId String Existing merge Id Identifies the existing SourceContactId for which details are required. false true

One and only one of MergeId or SourceContactId is mandatory

Success

Parameters

Key ValueType Value Description Mandatory Unique Default
SourceContactId String Original Id of the source contact, the contact that was deleted by the merge true true
DestinationContactId String Original Id of the destination contact true true
AgentId Integer Id of the agent who performed the merge true true
Reason String The reason that was provided for the merge true true
Description String The description that was provided for the merge true true
MergeDate String Date of the merge, formatted with the pattern: "yyyy-MM-ddTHH:mm:ss.SSSZ" true true
SourceContact KVList Representation of the source contact false true
DestinationContact KVList Representation of the destination contact false true


SourceContact and DestinationContact

Key ValueType Value Description Mandatory Unique Default
ContactId String Id of the contact true true
TenantId Integer Id of the tenant true true
CreatedDate String "yyyy-MM-ddTHH:mm:ss.SSSZ" true true
ModifiedDate String "yyyy-MM-ddTHH:mm:ss.SSSZ" true true
Attributes KVList Attributes of the contact true true


Attributes KVList value

Key ValueType Value Description Mandatory Unique Default
(Attribute name) KVList false true


Attribute name KVList value

Key ValueType Value Description Mandatory Unique Default
(Attribute index) KVList Attribute index 0 is for the primary value false true


Attribute index KVList value

Key ValueType Value Description Mandatory Unique Default
AttrId String Attribute Id true true
AttrValue StringBinary The value type of this parameter depends on the Contact Attribute type declared in Config Server (settings/type). If type is set to:

string(default): value must be a String Max. length: 256characters date: value must be a String formatted with the pattern: "yyyy-MM-ddTHH:mm:ss.SSSZ" binary: value must be a byte array

false true null
MimeType String Applicable for binary content

Max. length: 256 characters

false true
Description String Description to be set for this contact attributes. For example, EmailAddress can be described as "(home)" or "(office)", and so on. false true

Feedback

Comment on this article:

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