Delete Profile Extension Recipient using an RIID
delete
/rest/api/v1.3/lists/{listName}/listExtensions/{petName}/members/{riid}
Delete Profile Extension Table (PET) recipient record using the RIID of the parent Profile List record
Request
Path Parameters
-
listName: string
List name
-
petName: string
Profile Extension Table (PET) name
-
riid: string
RIID of the parent Profile List record, which is used to locate the corresponding PET record
Response
Supported Media Types
- application/json
Default Response
Root Schema : Profile Extension Recipients
Type:
object
Title:
Show Source
Profile Extension Recipients
-
insertOnNoMatch:
boolean
Specifies whether a recipient record should be inserted into the Profile Extension if it does not already exist. Only used during the merge operation.
-
matchColumn:
Allowed Values:
[ "RIID", "CUSTOMER_ID", "EMAIL_ADDRESS", "MOBILE_NUMBER", "EMAIL_MD5_HASH", "EMAIL_SHA256_HASH" ]
The column name to be used to match the recipient record to the Profile Extension records. Only used during the merge operation. -
recordData:
object recordData
Record data that represents field names and corresponding values for the recipient.
-
updateOnMatch:
Allowed Values:
[ "REPLACE_ALL", "NO_UPDATE" ]
Specifies whether a recipient record should be updated in the Profile Extension if it already exists. Only used during the merge operation.
Nested Schema : recordData
Type:
object
Record data that represents field names and corresponding values for the recipient.
Show Source
-
fieldNames:
array fieldNames
Field names of the Profile List. Must contain contain at least one of the merge key fields from the Profile List.
-
mapTemplateName(optional):
string
The map template in Responsys 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.
Nested Schema : fieldNames
Type:
array
Field names of the Profile List. Must contain contain at least one of the merge key fields from the Profile List.
Show Source
Nested Schema : records
Type:
array
Array of values corresponding to the fieldNames. Each element in the array represents a single recipient.
Show Source
-
Array of:
array items
Field values for the recipient in the Profile List
Examples
A successful request requires the following headers:
FIELDS | DESCRIPTION |
---|---|
Authorization | <AUTH_TOKEN> |
Sample Request:
NOTE: The service URL requires the names of both the Profile List and the Profile Extension Table.
/rest/api/v1.3/lists/<listName>/listExtensions/<petName>/members/<riid>
Example Response: Success
NOTES:
- The response will always contain only
RIID_
in thefieldNames
attribute and the correspondingRIID_
values for the records in therecords
attribute in case the deletion of that record is successful. - In case delete failed for a record, 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. Furthermore, other attributes in the response likemapTemplateName
,insertOnNoMatch
,updateOnMatch
, andmatchColumn
will have default values (null/false).
{ "recordData": { "fieldNames": ["RIID_"], "records": [["1761409"]], "mapTemplateName": null }, "insertOnNoMatch": false, "updateOnMatch": null, "matchColumn": null, "links": [ { "rel": "self", "href": "/rest/api/v1.3/lists/DemoNewsLetterList/listExtensions/DemoNewsLetterPet/members/1761409", "method": "DELETE" }, { "rel": "mergeProfileExtensionRecipients", "href": "/rest/api/v1.3/lists/DemoNewsLetterList/listExtensions/DemoNewsLetterPet/members", "method": "POST" }, { "rel": "retrieveProfileExtensionRecipientsRIID", "href": "/rest/api/v1.3/lists/DemoNewsLetterList/listExtensions/DemoNewsLetterPet/members/<riid>", "method": "GET" } ] }
Sample Response: Failure
{ "recordData": { "fieldNames": ["RIID_"], "records": [["DELETEFAILED: NO records found for id\n"]], "mapTemplateName": null }, "insertOnNoMatch": false, "updateOnMatch": null, "matchColumn": null, "links": [ { "rel": "self", "href": "/rest/api/v1.3/lists/DemoNewsLetterList/listExtensions/DemoNewsLetterPet/members/1761409", "method": "DELETE" }, { "rel": "mergeProfileExtensionRecipients", "href": "/rest/api/v1.3/lists/DemoNewsLetterList/listExtensions/DemoNewsLetterPet/members", "method": "POST" }, { "rel": "retrieveProfileExtensionRecipientsRIID", "href": "/rest/api/v1.3/lists/DemoNewsLetterList/listExtensions/DemoNewsLetterPet/members/<riid>, "method": "GET" } ] }