Delete profile list recipients based on RIID

Use this interface to delete a profile list member by specifying the RIID for that member.

Service URL:

/rest/api/v1.3/lists/{listName}/members/{riid}

Request Method:

DELETE

Request Header:

Authorization=<AUTH_TOKEN>

Request Body:

None

Sample Response in case of success:

REQUEST NOTES:

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.
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 in case recipient is not found:

{
  "type": "",
  "title": "No recipient found",
  "errorCode": "NO_RECIPIENT_FOUND",
  "detail": "Record not Found in the List.",
  "errorDetails": []
}

Sample Response in case of 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"
      }
   ]
}