Asynchronous Delete Multiple Profile List Recipients API

This asynchronous API enables you to delete multiple profile list recipients in a single request. Use the Polling API endpoint to retrieve data about your request.

Service URL:

/rest/asyncApi/v1.3/lists/{listName}/members?action=delete

Required Path Parameters:

• listName - Name of the list.

Query Parameters:

• action - Name of the action to perform. Must be set to delete.

Request Method:

POST

Sample Request Body:

{
  "queryAttribute": "e",
  "ids": [
    "recipient1@example.com",
    "jnellore-83@interactexpress.com"
  ]
}

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 Polling API for details about the error responses.

Sample Successful Response:

{
  "requestId": "NU8xM284OjoxNTgyNTI3NzQ5",
  "apiName": "asyncDeleteMultipleListRecipients",
  "status": "REQUEST_ACCEPTED",
  "links": [
    {
      "rel": "self",
      "href": "/rest/asyncApi/v1.3/lists/16K_REC/members?action=delete",
      "method": "POST"
    },
    {
      "rel": "asyncResponse",
      "href": "/rest/asyncApi/v1.3/requests/NU8xM284OjoxNTgyNTI3NzQ5",
      "method": "GET"
    }
  ]
}

Sample Successful Response from the Polling API:

{
  "response": {
    "recordData": {
      "records": [
        [
          "DELETEFAILED: Record not Found in the List."
        ],
        [
          "jnellore-83@interactexpress.com"
        ]
      ],
      "mapTemplateName": null,
      "fieldNames": [
        "EMAIL_ADDRESS_"
      ]
    }
  },
  "requestId": "a2RmZDlyOjoxNTgyNTI4MTIx",
  "apiName": "asyncDeleteMultipleListRecipients",
  "timeZone": "India Standard Time",
  "requestTime": "2020-02-24T12:38:41.153",
  "requestProcessedTime": "2020-02-24T12:38:41.858",
  "status": "SUCCESS"
}

Sample Error Messages

Invalid query attribute. The following example shows a sample error response when a request parameter contains invalid characters. The query attribute must be either r, e, c, or m. Error resembles:

{
  "type": "",
  "title": "Invalid request parameters",
  "errorCode": "INVALID_PARAMETER",
  "detail": "Query Attribute Must be either r, e, c, or m",
  "errorDetails": [  
  ]
}		

Invalid list. Requests fail when there is an invalid list in the request body. Error resembles:

{
  "response": {
    "errorCode": "LIST_NOT_FOUND",
    "detail": "16K_REC11 List Not Found",
    "type": "",
    "title": "List not found",
    "errorDetails": "[]"
  },
  "requestId": "QWZ3ajV6OjoxNTgyNTI5NTk0",
  "apiName": "asyncDeleteMultipleListRecipients",
  "timeZone": "India Standard Time",
  "requestTime": "2020-02-24T13:03:14.899",
  "requestProcessedTime": "2020-02-24T13:03:15.070",
  "status": "ERROR"
}

Limit Exceeded. The maximum number of records allowed per API call is 200. If more than 200 items are specified in one request, the following error appears:

{
  "type": "",
  "title": "Record limit exceeded",
  "errorCode": "RECORD_LIMIT_EXCEEDED",
  "detail": "Record limit exceeded, maximum of 200 records are allowed per each api call",
  "errorDetails": [    
  ]
}					

Learn more

Asynchronous APIs