Delete List Recipients based on RIID.
/rest/api/v1.3/lists/{listName}/members/{riid}
Request
-
listName: string
List Name
-
riid: string
List Name
Response
- application/json
Default Response
object
Profile List Recipients
-
mergeRule:
object mergeRule
Merge rule used to merge recipient records in a Profile List. Only used during the merge operation.
-
recordData:
object recordData
Record data that represents Field Names and corresponding values for the recipient.
object
-
defaultPermissionStatus(optional):
string
Allowed Values:
[ "OPTIN", "OPTOUT" ]
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 explicitly specified, then it is set to OPTOUT. -
htmlValue(optional):
string
Value of incoming preferred email format data. For example, 'H' may represent a preference for HTML formatted email.
-
insertOnNoMatch(optional):
boolean
Indicates what should be done for records where a match is not found (true = insert / false = no insert).
-
matchColumnName1(optional):
string
Allowed Values:
[ "RIID_", "CUSTOMER_ID_", "EMAIL_ADDRESS_", "MOBILE_NUMBER_", "EMAIL_MD5_HASH_", "EMAIL_SHA256_HASH_" ]
First match column for determining whether an insert or update should occur. -
matchColumnName2(optional):
string
Allowed Values:
[ "RIID_", "CUSTOMER_ID_", "EMAIL_ADDRESS_", "MOBILE_NUMBER_", "EMAIL_MD5_HASH_", "EMAIL_SHA256_HASH_" ]
Second match column for determining whether an insert or update should occur. (optional). -
matchOperator(optional):
string
Allowed Values:
[ "NONE", "AND" ]
Operator to join match column names -
optinValue(optional):
string
Value of incoming opt-in status data that represents an opt-in status. For example, 'I' may represent an opt-in status.
-
optoutValue(optional):
string
Value of incoming opt-out status data that represents an optout status. For example, '0' may represent an opt-out status.
-
rejectRecordIfChannelEmpty(optional):
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 'E' (Email), 'M' (Mobile), 'P' (Postal Code). For example 'E,M' would indicate that a record that has a null for Email or Mobile Number value should be rejected. This parameter can also be set to null or to an empty string, which will cause the validation to not be performed for any channel, except if the matchColumnName1 parameter is set to EMAIL_ADDRESS_ or MOBILE_NUMBER_. When matchColumnName1 is set to EMAIL_ADDRESS_ or MOBILE_NUMBER_, then the null or empty string setting is effectively ignored for that channel.
-
textValue(optional):
string
Value of incoming preferred email format data. For example, 'T' may represent a preference for Text formatted email.
-
updateOnMatch(optional):
string
Allowed Values:
[ "REPLACE_ALL", "NO_UPDATE" ]
Controls how the existing record should be updated.
object
-
fieldNames:
array fieldNames
Field Names in the Profile List
-
mapTemplateName(optional):
string
The Map Template in CX Audience that can be used to map Field Names of the Profile List to Column Names.
-
records:
array records
Array of values corresponding to the fieldNames. Each element in the array represents a single recipient.
array
-
Array of:
array items
Field Values for the recipient in the Profile List
Examples
This API is used to delete a profile list member by specifying the RIID for that member.
FIELDS | DESCRIPTION |
---|---|
Authorization | <AUTH_TOKEN> |
Sample Request URL:
/rest/api/v1.3/lists/<listName>/members/<riid>
Sample Response:Success
Note: The response will always contain only "RIID_" in the "fieldNames" attribute and the corresponding "RIID_" values for the records in the "records" attribute in case the deletion of that record is successful. In case delete failed for a record for some reason, the "RIID_" of the record is not present in the response. Instead, an error message starting with "DELETEFAILED:" is returned. Client developers can look for the string "DELETEFAILED:" in the response for a particular row to determine whether that recipient was deleted successfully or not. Also note that other attributes in the response (mapTemplateName, mergeRule will have default values (null/false)).
{ "recordData": { "fieldNames": ["RIID_"], "records": [["1561"]], "mapTemplateName": null }, "mergeRule": { "textValue": null, "matchColumnName3": null, "matchColumnName1": null, "matchColumnName2": null, "rejectRecordIfChannelEmpty": null, "defaultPermissionStatus": null, "updateOnMatch": null, "matchOperator": null, "optinValue": null, "optoutValue": null, "htmlValue": null, "insertOnNoMatch": false }, "links": [ { "rel": "self", "href": "/rest/api/v1.3/lists/DemoProfileList/members/1561", "method": "DELETE" }, { "rel": "mergeListRecipients", "href": "/rest/api/v1.3/lists/DemoProfileList/members", "method": "POST" }, { "rel": "retrieveListRecipientsRIID", "href": /rest/api/v1.3/lists/DemoProfileList/members/<riid>, "method": "GET" } ] }
Sample Response:recipient is not found
{ "type": "", "title": "No recipient found", "errorCode": "NO_RECIPIENT_FOUND", "detail": "Record not Found in the List.", "errorDetails": [] }
Sample Response:Failure
{ "recordData": { "fieldNames": ["RIID_"], "records": [["DELETEFAILED: ERROR: The value abdce is not valid for an integer field"]], "mapTemplateName": null }, "mergeRule": { "textValue": null, "matchColumnName3": null, "matchColumnName1": null, "matchColumnName2": null, "rejectRecordIfChannelEmpty": null, "defaultPermissionStatus": null, "updateOnMatch": null, "matchOperator": null, "optinValue": null, "optoutValue": null, "htmlValue": null, "insertOnNoMatch": false }, "links": [ { "rel": "self", "href": "/rest/api/v1.3/lists/DemoProfileList/members/abcde", "method": "DELETE" }, { "rel": "mergeListRecipients", "href": "/rest/api/v1.3/lists/DemoProfileList/members", "method": "POST" }, { "rel": "retrieveListRecipientsRIID", "href": /rest/api/v1.3/lists/DemoProfileList/members/<riid>, "method": "GET" } ] }