PUT {clientId}/Preferences/Merge

Merge preferences from one or more preference keys to a new or an existing preference key. Note: This call is designed to support fuzzy matching. Therefore, the merge operation will combine preferences across all matching elements within a preference key. For example, if a preference key includes CID 111 and Email johndoe@example.com, the merge process will merge preferences across all preference keys that contains the CID, Email or both, and associates it with the survivor preference key. Please request the Merge API Help Documentation for more details.

Request Information

URI Parameters

Name	Description	Type	Additional information
clientId		string	None.

Body Parameters

A collection of preferences to merge.

PreferenceMerge

Name	Description	Type	Additional information
PartialMerge	Indicates whether or not to processed with the merge process if any of the PreferenceKey(s) have no preferences associated.	boolean	None.
PreferenceKeys		Collection of PreferenceKey	None.
SurvivorKey	Target key that will be the result from this merge process.	SurvivorKey	None.

Request Formats

application/json, text/json

Sample:

{
  "PartialMerge": true,
  "PreferenceKeys": [
    {
      "DeactivateKey": true,
      "CID": "sample string 2",
      "ChannelContacts": [
        {
          "ChannelID": "sample string 1",
          "Email": "sample string 2",
          "PFT": "sample string 3",
          "Address1": "sample string 4",
          "Address2": "sample string 5",
          "City": "sample string 6",
          "StateProvince": "sample string 7",
          "CountryCode": "sample string 8",
          "PostalCode": "sample string 9"
        }
      ]
    }
  ],
  "SurvivorKey": {
    "CID": "sample string 1",
    "Prefix": "sample string 2",
    "FirstName": "sample string 3",
    "MiddleName": "sample string 4",
    "LastName": "sample string 5",
    "Suffix": "sample string 6",
    "ChannelContacts": [
      {
        "ChannelID": "sample string 1",
        "Email": "sample string 2",
        "PFT": "sample string 3",
        "Address1": "sample string 4",
        "Address2": "sample string 5",
        "City": "sample string 6",
        "StateProvince": "sample string 7",
        "CountryCode": "sample string 8",
        "PostalCode": "sample string 9"
      }
    ]
  }
}

application/xml, text/xml

Sample:

<PreferenceMerge xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyPreferences.REST.Models">
  <PartialMerge>true</PartialMerge>
  <PreferenceKeys>
    <PreferenceKey>
      <CID>sample string 2</CID>
      <ChannelContacts>
        <ChannelContact>
          <Address1>sample string 4</Address1>
          <Address2>sample string 5</Address2>
          <City>sample string 6</City>
          <CountryCode>sample string 8</CountryCode>
          <Email>sample string 2</Email>
          <PFT>sample string 3</PFT>
          <PostalCode>sample string 9</PostalCode>
          <StateProvince>sample string 7</StateProvince>
          <ChannelID>sample string 1</ChannelID>
        </ChannelContact>
      </ChannelContacts>
      <DeactivateKey>true</DeactivateKey>
    </PreferenceKey>
  </PreferenceKeys>
  <SurvivorKey>
    <CID>sample string 1</CID>
    <ChannelContacts>
      <ChannelContact>
        <Address1>sample string 4</Address1>
        <Address2>sample string 5</Address2>
        <City>sample string 6</City>
        <CountryCode>sample string 8</CountryCode>
        <Email>sample string 2</Email>
        <PFT>sample string 3</PFT>
        <PostalCode>sample string 9</PostalCode>
        <StateProvince>sample string 7</StateProvince>
        <ChannelID>sample string 1</ChannelID>
      </ChannelContact>
    </ChannelContacts>
    <FirstName>sample string 3</FirstName>
    <LastName>sample string 5</LastName>
    <MiddleName>sample string 4</MiddleName>
    <Prefix>sample string 2</Prefix>
    <Suffix>sample string 6</Suffix>
  </SurvivorKey>
</PreferenceMerge>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Response Codes

NotFound (404)
BadRequest (400)
Unauthorized (401)
NoContent (204)

Resource Description

None.