Asynchronous Delete Multiple Profile Extension Recipients API
This endpoint is used to delete members of an existing profile extension 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 Delete Multiple 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?action=delete
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:
-
ids– Record data that represents field names and corresponding values for the member. queryAttribute- Query Attribute based on which records will be deleted. Can have the values:
For more information about forming a request, see the Delete multiple Profile Extension Recipients in the Oracle Responsys REST API Guide. View the Request section of the topic.
Sample Request Body:
{
"queryAttribute": "e",
"ids": [
"john.doe@oracle.com",
"adam.silver@oracle.com",
"john.appleseed@oracle.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 Asynchronous API for details about the error responses.
Sample Response:
{
"requestId": "c3RuMGhlOjoxNjQzNzA4NjYz",
"apiName": "asyncDeleteMultipleProfileExtensionRecipients",
"status": "REQUEST_ACCEPTED",
"links": [
{
"rel": "self",
"href": "/rest/asyncApi/v1.3/lists/Summer_Event_Attendees/listExtensions/PET_records_Summer_Event/members?action=delete",
"method": "POST"
},
{
"rel": "asyncResponse",
"href": "/rest/asyncApi/v1.3/requests/c3RuMGhlOjoxNjQzNzA4NjYz",
"method": "GET"
}
]
}
Sample successful response from Polling API:
{
"response": {
"recordData": {
"records": [
[
"john.doe@oracle.com"
],
[
"adam.silver@oracle.com"
],
[
"john.appleseed@oracle.com"
]
],
"mapTemplateName": null,
"fieldNames": [
"EMAIL_ADDRESS_"
]
}
},
"requestId": "c3RuMGhlOjoxNjQzNzA4NjYz",
"apiName": "asyncDeleteMultipleProfileExtensionRecipients",
"timeZone": "Pacific Standard Time",
"requestTime": "2022-02-01T01:44:23.032",
"requestProcessedTime": "2022-02-01T01:44:23.354",
"status": "SUCCESS"
}