Sign in

v1

latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB
Transactions

Withdraw Consent on Behalf of a Data Subject

Use this API to withdraw consent on behalf of a data subject for a specific Purpose. The data subject identifier must be included either in the identifier query or header parameter, preferably passed in the header.

put/api/consentmanager/v1/transactions/withdraw/fordatasubject

Query parameters

identifierstring
Example:user@example.com

Data Subject Identifier (prefer the header parameter).

withdrawnBystring required
Example:admin@example.com

User withdrawing consent on behalf of data subject.

Headers

identifierstring
Example:user@example.com

Data Subject Identifier (prefer the header parameter).

Request body

Notesstring

Additional notes to be recorded as part of withdrawal

PurposeIdstring uuid required

Unique identifier of the purpose for which consent is being withdrawn

Originstring

Source or origin of the withdrawal request (e.g., IMPORT, API, SDK, ONETRUST, PREFERENCE_CENTER)

Example request

{
  "Notes": "Withdrawing consent as per data subject request",
  "PurposeId": "f2229953-b4b5-4042-8cb9-b78038cc4c46",
  "Origin": "API"
}

Response

OK - Successfully withdrew consent on behalf of data subject

Statusstring

Message representing the consent withdrawal status

Example response

{
  "Status": "Consent withdrawn successfully"
}