Asynchronous Merge Profile Extension Table Records API
This endpoint is used to add new members to an existing profile extension table, or update data for existing members within the table. For a given profile extension table, an array of record data that contain field names and their corresponding field values are specified. This endpoint is the asynchronous alternative to Merge Profile Extension Recipients.
A maximum of 200 records can be merged in one request.
Note: The Asynchronous API is generally available for all Responsys customers.
Service URL:
/rest/asyncApi/v1.3/lists/{listName}/listExtensions/{petName}/members
Required Path Parameters:
listName - Name of the profile extension table’s parent profile list.
petName - name of the profile extension table.
Request Method:
POST
Request Header:
Authorization=<AUTH_TOKEN>
Content-Type=application/json
Request Body - Required Properties:
recordData – Record data that represents field names and corresponding values for the member.
For more information about forming a request, see the Merge Profile Extension Recipients REST Endpoints page in the Oracle Responsys REST API Guide. View the Request section of the topic.
Request Body - Optional Properties:
insertOnNoMatch – Boolean value that specifies whether a member record should be inserted into the Supplemental Table if it does not already exist.
updateOnMatch – Specifies whether a member record should be updated in the Supplemental Table if it already exists. Allowed values: REPLACE_ALL and NO_UPDATE.
matchColumnName1 and matchColumnName2 – The column name to be used to match the recipient record to the Profile Extension records. Only used during the merge operation. Allowed values: RIID, CUSTOMER_ID, EMAIL_ADDRESS, MOBILE_NUMBER, EMAIL_MD5_HASH, EMAIL_SHA256_HASH.
For more information about forming a request, see the Merge Profile Extension Recipients REST Endpoints page in the Oracle Responsys REST API Guide. View the Request section of the topic.
Sample Request Body:
{
"recordData": {
"fieldNames": [
"EMAIL_ADDRESS_",
"EMPID",
"MOBILE_NUMBER_",
"EMAIL_SHA256_HASH_"
],
"records": [
[
"email.address@oracle.com",
"09",
"0123456789",
"456f90d1f6a99f605043fdc5ec1384e1213a718e8259e7676e8e7ffb7fad0d2d"
],
[
"email.address1@oracle.com",
"09",
"9845098450",
"456f90d1f6a99f605043fdc5ec1384e1213a718e8259e7676e8e7ffb7fad0d2d"
],
[
"email.address2@oracle.com",
"09",
"2598233819",
"456f90d1f6a99f605043fdc5ec1384e1213a718e8259e7676e8e7ffb7fad0d2d"
]
],
"mapTemplateName": ""
},
"insertOnNoMatch": true,
"updateOnMatch": "REPLACE_ALL",
"matchColumnName1": "EMAIL_SHA256_HASH",
"matchColumnName2": ""
}
For more information, see the Merge Profile Extension Recipients REST Endpoints page in the Oracle Responsys REST API Guide. View the Example section of the topic.
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.
Sample Response:
{
"requestId": "eVAyTWJGOjoxNTc2MDkzMTI2",
"apiName": "asyncMergeIntoProfileExtension",
"status": "REQUEST_ACCEPTED",
"links": [
{
"rel": "self",
"href": "/rest/asyncApi/v1.3/lists/My_List/listExtensions/Pet_Name/members",
"method": "POST"
},
{
"rel": "asyncResponse",
"href": "/rest/asyncApi/v1.3/requests/eVAyTWJGOjoxNTc2MDkzMTI2",
"method": "GET"
}
]
}