Merge members into a profile list (HA Async Merge List Members)
Provides an asynchronous 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/haAsyncApi/v1.3/lists/{listName}/members
NOTE: For this request, ensure that your path uses haAsyncApi instead of haApi. The haAsyncApi part of the path is case sensitive.
Required Path Parameters:
listName - Name of the list.
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:
{
"recordData" : {
"fieldNames" : ["riid_", "mobile_number_", "email_address_"],
"records" : [
["4094326", "9845349498","ab.cd@example.com"],
["4094327", "9844444444","unknown@example.com"],
["4094328", "9844444666","abc@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"
}
}
Sample Response:
NOTES:
- A successful response for the asynchronous API returns an HTTPS status code of 202 Accepted.
- A successful response returns a requestId, to be used in the Polling API endpoint to retrieve the status of your request.
- See Common error responses for the Asynchronous API for details about the error responses.
{
"requestId": "TVVjVTY2OjoxNTc2MDk0NjQ5",
"apiName": "HaAsyncMergeListMembers",
"status": "REQUEST_ACCEPTED",
"links": [
{
"rel": "self",
"href": "/rest/haAsyncApi/v1.3/lists/listName/members",
"method": "POST"
},
{
"rel": "asyncResponse",
"href": "/rest/haAsyncApi/v1.3/requests/TVVjVTY2OjoxNTc2MDk0NjQ5",
"method": "GET"
}
]
}