Definitions of Rule Parameters for Merging Members into a Profile List

Name	Type	Description
`insertOnNoMatch`	boolean	Indicates what should be done for records where a match is not found (`true` = insert / `false` = no insert).
`updateOnMatch`	string (enum)	Controls how the existing record should be updated. Valid values: `NO_UPDATE` `REPLACE_ALL`
`matchColumnName1`	string (enum)	First match column for determining whether an insert or update should occur. Valid values: `RIID_` `CUSTOMER_ID_` `EMAIL_ADDRESS_` `MOBILE_NUMBER_` `EMAIL_MD5_HASH_` `EMAIL_SHA256_HASH_`
`matchColumnName2`	string (enum)	Second match column for determining whether an insert or update should occur (optional). Valid values: `null` `RIID_` `CUSTOMER_ID_` `EMAIL_ADDRESS_` `MOBILE_NUMBER_` `EMAIL_MD5_HASH_` `EMAIL_SHA256_HASH_`
`matchColumnName3`	string	DO NOT USE. This attribute is no longer supported, but you may still see it in the response body of some APIs. For backward compatibility, it may be present in the request body but it must be set to null.
`matchOperator`	string (enum)	Controls how the Boolean expression involving the match columns is constructed to determine a match between the incoming records and existing records. Valid values: NONE AND
`optinValue`	string (enum)	Value of incoming opt-in status data that represents an opt-in status. For example, “`1`” may represent an opt-in status.
`optoutValue`	string	Value of incoming opt-out status data that represents an opt-out status. For example, “`0`” may represent an opt-out status.
`defaultPermissionStatus`	string (enum)	This value must be specified as either `OPTIN` or `OPTOUT` and would be applied to all of the records contained in the API call. If this value is not specified explicitly, then it is set to `OPTOUT`. Valid values: `OPTIN` `OPTOUT`
`htmlValue`	string	Value of incoming preferred email format data. For example, “`H`” may represent a preference for HTML formatted email.
`textValue`	string	Value of incoming preferred email format data. For example, “`T`” may represent a preference for Text formatted email.
`rejectRecordIfChannelEmpty`	string	String containing comma-separated channel codes that if specified will result in record rejection when the channel address field is null. Channel codes are as follows: `E` - Email `M` - Mobile `P` – Postal address For example “E,M” would indicate that a record that has a null for Email or for Mobile Number value should be rejected. This parameter can also be set to `null` or to an empty string. By specifying `null` or an empty string, this validation will not be performed for any channel, unless overridden by the matchColumnName1 setting. When matchColumnName1 is set to EMAIL_ADDRESS_ or MOBILE_NUMBER_, then the null or empty string setting is effectively ignored for that channel. For example, if a merge rule has matchColumnName1 set to EMAIL_ADDRESS_, the system will reject a record without an email address, even if the rejectRecordIfChannelEmpty is set to null.

insertOnNoMatch

boolean

Indicates what should be done for records where a match is not found (true = insert / false = no insert).

updateOnMatch

string (enum)

Controls how the existing record should be updated.

Valid values:

NO_UPDATE
REPLACE_ALL

matchColumnName1

string (enum)

First match column for determining whether an insert or update should occur.

Valid values:

RIID_
CUSTOMER_ID_
EMAIL_ADDRESS_
MOBILE_NUMBER_
EMAIL_MD5_HASH_
EMAIL_SHA256_HASH_

matchColumnName2

string (enum)

Second match column for determining whether an insert or update should occur (optional).

Valid values:

null
RIID_
CUSTOMER_ID_
EMAIL_ADDRESS_
MOBILE_NUMBER_
EMAIL_MD5_HASH_
EMAIL_SHA256_HASH_

matchColumnName3

string

DO NOT USE.

This attribute is no longer supported, but you may still see it in the response body of some APIs. For backward compatibility, it may be present in the request body but it must be set to null.

matchOperator

string (enum)

Controls how the Boolean expression involving the match columns is constructed to determine a match between the incoming records and existing records.

Valid values:

NONE
AND

optinValue

string (enum)

Value of incoming opt-in status data that represents an opt-in status. For example, “1” may represent an opt-in status.

optoutValue

string

Value of incoming opt-out status data that represents an opt-out status. For example, “0” may represent an opt-out status.

defaultPermissionStatus

string (enum)

This value must be specified as either OPTIN or OPTOUT and would be applied to all of the records contained in the API call. If this value is not specified explicitly, then it is set to OPTOUT.

Valid values:

OPTIN
OPTOUT

htmlValue

string

Value of incoming preferred email format data. For example, “H” may represent a preference for HTML formatted email.

textValue

string

Value of incoming preferred email format data. For example, “T” may represent a preference for Text formatted email.

rejectRecordIfChannelEmpty

string

String containing comma-separated channel codes that if specified will result in record rejection when the channel address field is null. Channel codes are as follows:

E - Email

M - Mobile

P – Postal address

For example “E,M” would indicate that a record that has a null for Email or for Mobile Number value should be rejected.

This parameter can also be set to null or to an empty string. By specifying null or an empty string, this validation will not be performed for any channel, unless overridden by the matchColumnName1 setting. When matchColumnName1 is set to EMAIL_ADDRESS_ or MOBILE_NUMBER_, then the null or empty string setting is effectively ignored for that channel. For example, if a merge rule has matchColumnName1 set to EMAIL_ADDRESS_, the system will reject a record without an email address, even if the rejectRecordIfChannelEmpty is set to null.