Merge members into a profile list (HA Merge List Members)

Use this interface to merge members into a profile list. Your client application can add new members to an existing profile list, and it can also update existing members of the profile list.

Service URL:

/rest/haApi/v1.3/lists/{listName}/members

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:

listName - Name of the Profile List to which Responsys will merged the recipients in the request body.

Request Method:

POST

Request Header:

Authorization=<AUTH_TOKEN>

Content-Type=application/json

Request Body Properties:

Same as the standard Merge List Recipients 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:

NOTE: In the following example, the fourth record (record 3, because the array sequence begins with zero) contains an invalid value for the RIID_, so that we can demonstrate the error in the sample response. 

{
  "recordData" : {
    "fieldNames" : ["riid_", "mobile_number_", "email_address_"],
    "records" : [
      ["4094326", "9845349498","ab.cd@example.com"],
      ["4094327", "9844444444","unknown@example.com"],
      ["4094328", "9844444666","abc@example.com"],
      ["ssdcf", "9844444444","xyz@example.com"]
    ],
    "mapTemplateName" : null
  },
  "mergeRule" : {
    "htmlValue" : "H",
    "optinValue" : "I",
    "textValue" : "T",
    "insertOnNoMatch" : true,
    "updateOnMatch" : "REPLACE_ALL",
    "matchColumnName1" : "RIID_",
    "matchColumnName2" : null,
    "matchOperator" : "NONE",
    "optoutValue" : "O",
    "rejectRecordIfChannelEmpty" : null,
    "defaultPermissionStatus" : "OPTIN"
  }
}

Response Body Properties

Same as the standard Merge List Recipients response, except that the HA Merge List Members API only returns the “self” link.

Sample Response:

NOTE: For the first three records (0, 1, and 2 of the array), the merge occurred successfully. The fourth record (record 3 of the array) was not merged, because “ssdcf” is not a valid value for the RIID_ field. 

{
  "recordData": {
    "fieldNames": ["RIID_"],
    "records": [
       ["4094326"],
       ["4094327"],
       ["4094328"],
       ["MERGEFAILED: Record 3 = INVALID_PARAMETER: The value ssdcf is not
        valid for an integer field\n\n\r\n"]
    ],
    "mapTemplateName": null
  },
  "mergeRule": {
    "textValue": "T",
    "insertOnNoMatch": true,
    "updateOnMatch": "REPLACE_ALL",
    "matchOperator": "NONE",
    "matchColumnName3": null,
    "matchColumnName1": "RIID_",
    "matchColumnName2": null,
    "optinValue": "I",
    "optoutValue": "O",
    "rejectRecordIfChannelEmpty": null,
    "htmlValue": "H",
    "defaultPermissionStatus": "OPTIN"
  },
  "links": [
    {
      "rel": "self",
      "href": "/rest/api/v1.3/lists/DemoNewsLetterList/members",
      "method": "POST"
    }
  ]
}

Learn more

Merge members into a profile list (HA Async Merge List Members)

Handling errors and exceptions