Sign in

v1

latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB
Data Subjects V2

Delete Purpose from Data Subjects

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 importID or jobGuid parameter 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 deletePurposeFromAllDataSubjects parameter value to true. By default, this parameter is set to false.
  • 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 retainTransactions parameter to true.
delete/api/consent/v2/datasubject-purposes/{purposeGuid}

Path parameters

purposeGuidstring uuid required
Example:fb1e4567-e89b-12d3-a456-426614174015

UUID of the Purpose to be deleted

Request body

jobGuidstring uuid

The UUID of the data exclusion job.

importIdstring

The import ID of the data exclusion job.

retainTransactionsboolean

This flag indicates whether transactions will be retained while deleting purposes from data subjects. When set to false, transactions are removed from the database and no longer appear in the OneTrust Platform UI. However, these transactions are not permanently deleted and can still be retrieved using the Get List of Receipts API.

deletePurposeFromAllDataSubjectsboolean

This flag indicates whether the purpose should be deleted from all data subjects.

Example request

{
  "jobGuid": "fa0e8400-e29b-41d4-a716-446655441200",
  "importId": "101"
}

Response

Purpose deletion from Data Subjects request processed successfully.

string required

Example response

"DataSubject Profile Delete Request has been accepted"