Merge members into a profile list & trigger email messages to them (HA Merge Trigger Email)

Use this interface to merge members into a profile list and subsequently send them an email message. This endpoint can be used for triggering both transactional and promotional emails. However, promotional emails will fail on the secondary account during failover. Both merging members and the email trigger will fail.

Service URL:

/rest/haApi/v1.3/campaigns/{campaignName}/email

NOTE: For this request, ensure that your path uses haApi instead of api. The haApi part of the path is case sensitive.

Required Path Parameters:

campaignName - Name of the Email campaign to be sent to the recipients.

Request Method:

POST

Request Header:

Authorization=<AUTH_TOKEN>

Content-Type=application/json

Request Body Properties:

Same as the standard Merge Trigger Email request.

NOTE: Using this API requires adhering to several constraints and guidelines, which are described in the standard Responsys REST API reference guide.

Sample Request Body:

{
"mergeTriggerRecordData": {
   "mergeTriggerRecords": [
      {
          "fieldValues": ["1", "foo.bar@oracle.com", "c1a_value"],
          "optionalData": [
             { "name": "CUSTOM2", "value": "c2a_value" } 
          ]
      },  
      {
          "fieldValues": ["2", "my.name@oracle.com ", "c1b_value"],
          "optionalData": [
             { "name": "CUSTOM2", "value": "c2b_value" }
          ]
      }
   ],
   "fieldNames": [
      "CUSTOMER_ID_",
      "EMAIL_ADDRESS_",
      "CUSTOM1"
   ]
},
"mergeRule": { 
   "htmlValue": "H", 
   "matchColumnName1": "EMAIL_ADDRESS_", 
   "matchColumnName2": null, 
   "optoutValue": "O",
   "optinValue": "I", 
   "insertOnNoMatch": true, 
   "defaultPermissionStatus": "OPTIN", 
   "rejectRecordIfChannelEmpty": "E", 
   "updateOnMatch": "REPLACE_ALL", 
   "textValue": "T", 
   "matchOperator": "NONE" 
   } 
}

Response Body Properties

Same as the standard Merge Trigger Email response.

Sample Response:

[
   {
      "errorMessage" : null,
      "success" : true,
      "recipientId" : 72067
   }, 
   {
      "errorMessage" : null,
      "success" : true,
      "recipientId" : 72087
   }
]

Learn more

Merge members into a profile list & trigger email messages to them (HA Async Merge Trigger Email)

Handling errors and exceptions