delete
https://{hostname}/api/consent/v2/datasubject-purposes/
Use this API for large scale deletion of a specific purpose from all data subjects.
Things to Know
- A data subject exclusion list is required to provide the specific data subjects from which the purpose should not be deleted. The Consent DS Exclusion import template within Global Settings in the OneTrust Platform can be used to create the data subject exclusion list and can be imported via Bulk Import in the application or via API.
- Once the data subject exclusion list has been successfully imported, either an
importIDorjobGuidparameter value must be specified in the request body.- Data subject exclusion lists are valid during the next 30 days after submission.
- To override the data subject exclusion list requirement, set the
deletePurposeFromAllDataSubjectsparameter value totrue. By default, this parameter is set tofalse.- By default, related data subject transactions will be removed from the database and will no longer appear in the OneTrust Platform UI after calling this API. However, the transactions can still be retrieved using the Get List of Receipts API. To maintain data subject transactions in the database and OneTrust Platform UI, set the
retainTransactionsparameter totrue.
