Delete Requests

put

https://{hostname}/api/datasubject/v2/requestqueues/bulkdelete/{language}

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.

Path Params

language

string

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.

Body Params

RequestIDs

array of strings

length between 0 and 2000

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

RequestIDs

CreatedDateRange

object

A date range for outlining start date and end date. All requests with a Created Date within this range will be deleted.

EndDateRange

object

A date range for outlining start date and end date. All requests with an End Date within this range will be deleted.

ModifiedDateRange

object

A date range for outlining start date and end date. All requests with a Modified Date within this range will be deleted.

Status

string

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

Organization

string

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

Country

string

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

WorkflowID

string

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

WebformID

string

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

RequestType

string

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

SubjectType

string

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

Responses

400

Bad Request

401

Unauthorized

403

Forbidden

500

Internal Server Error

200OK

429Too Many Requests. For more information, see API Rate Limits.