Sign in

v1

latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB
Request Queues

Delete Requests

Use this API to delete requests in bulk. The associated subtasks, attachments, and Results Summaries will also be deleted. Request deletion is a permanent action that should be exercised with caution.

put/api/datasubject/v2/requestqueues/bulkdelete/{language}

Path parameters

languagestring required

A language code that identifies the language in which the request data should be returned, assuming translations are available for that language. Examples: en-us for English, de for German, fr for French, etc.

Request body

RequestIDsstring[]

An array of 10-character Unique IDs of the Request(s) to be deleted.

Statusstring

Filter requests by the Stage name. Only requests in this stage will be deleted.

Organizationstring

Filter requests by Organization. Only requests in this organization will be deleted.

Countrystring

Filter requests by Country code. Only requests with this Country selected will be deleted.

WorkflowIDstring

Filter requests by Workflow ID. Only requests using this workflow will be deleted.

WebformIDstring

Filter requests by Web Form ID. Only requests using this web form will be deleted.

RequestTypestring

Filter requests by Request Type. Only requests with the Request Type will be deleted.

SubjectTypestring

Filter requests by Subject Type. Only requests with the Subject Type will be deleted.

Example request

{
  "RequestIDs": [
    "8KDL2A4JAM",
    "S62QF8K5PJ"
  ],
  "CreatedDateRange": {
    "StartDate": "2019-05-31T12:43:24.173Z",
    "EndDate": "2019-05-31T12:44:24.173Z"
  },
  "EndDateRange": {
    "StartDate": "2019-05-31T12:43:24.173Z",
    "EndDate": "2019-05-31T12:44:24.173Z"
  },
  "ModifiedDateRange": {
    "StartDate": "2019-05-31T12:43:24.173Z",
    "EndDate": "2019-05-31T12:44:24.173Z"
  },
  "Status": "EXPIRED",
  "Organization": "BRAND A",
  "Country": "US",
  "WorkflowID": "4f068b73-4edc-4920-a00c-9f39cd01c5f6",
  "WebformID": "0388dd81-0c41-4181-a47c-1e2777727b73",
  "RequestType": "Opt Out",
  "SubjectType": "Employee"
}

Response

OK

requestsDeletedinteger

Number of requests which are deleted in the API call (up to a maximum of 50 requests).

requestsPendinginteger

Number of requests which match the filter criteria which have not been deleted in this call.API should be called again to delete additional requests.