put https://customer.my.onetrust.com/api/consentmanager/v1/purposes//retire
Use this API to set the retirement date for a specific Purpose.
Things to Know
- If the
date
query parameter is left empty, the date will be set to one day in the future by default.- Data subjects who gave consent to the specified Purpose will be automatically updated after Purpose expiration. A summary of details about this transaction will appear on the Purposes and Receipts tabs of the Data Subject details screen in the OneTrust application for each profile associated to the Purpose. For more information, see Managing Data Subjects and Viewing Consent Receipts & Transactions.
- This API returns Purpose descriptions inside
<p>
and</p>
HTML tags. These can be sanitized depending on your formatting needs.