---
updatedAt: 2026-05-27T12:49:39.000Z
agentTools:
  projectIndex: https://developer.onetrust.com/onetrust/llms.txt
---

# Withdraw Data Subject's Consent for All Purposes in a Preference Center

Use this API to withdraw a data subject's consent for all Purposes within a Preference Center.

> 🗒 Things to Know
> 
> - The Notification Opt-Out Purpose will be excluded when calling this API.

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "Consent & Preferences - Universal Consent & Preference Management (OAS)",
    "version": "1.0",
    "contact": {
      "name": "OneTrust Support",
      "url": "https://my.onetrust.com/s/contactsupport"
    },
    "license": {
      "name": "Apache 2.0",
      "url": "https://www.apache.org/licenses/LICENSE-2.0"
    },
    "description": "The Universal Consent & Preference Management APIs are used to integrate external systems and streamline the flow of data with Universal Consent & Preference Management in the OneTrust Platform."
  },
  "servers": [
    {
      "url": "https://{hostname}",
      "variables": {
        "hostname": {
          "default": "hostname",
          "description": "The OneTrust hostname such as app.onetrust.com, app-eu.onetrust.com, app-de.onetrust.com, app-uk.onetrust.com, app-apac.onetrust.com, trial.onetrust.com, or uat.onetrust.com."
        }
      }
    }
  ],
  "tags": [
    {
      "name": "Preference Centers",
      "description": "The Preference Centers APIs are used to manage data subjects' preferences in a preference center.",
      "externalDocs": {
        "description": "OpenAPI 3.1.0 - Download Definition",
        "url": "https://developer.onetrust.com/onetrust/openapi/consent-preferences-universal-consent-preference-management-oas.json"
      },
      "x-displayName": "Preference Centers"
    }
  ],
  "paths": {
    "/api/consentmanager/v1/preferencecenters/{prefcenterId}/datasubjects/preferences": {
      "delete": {
        "operationId": "withdrawPreferencesApiUsingDELETE",
        "summary": "Withdraw Data Subject's Consent for All Purposes in a Preference Center",
        "description": "Use this API to withdraw a data subject's consent for all Purposes within a Preference Center.\n\n> 🗒 Things to Know\n> \n> - The Notification Opt-Out Purpose will be excluded when calling this API.",
        "tags": [
          "Preference Centers"
        ],
        "x-onetrust": {
          "spec-label": "https://developer.onetrust.com/onetrust/openapi/consent-preferences-universal-consent-preference-management-oas.json"
        },
        "parameters": [
          {
            "name": "prefcenterId",
            "in": "path",
            "description": "Preference Center UUID.",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid",
              "example": "156129da-7441-498d-a0eb-a89da357d741"
            }
          },
          {
            "name": "identifier",
            "in": "query",
            "description": "Data Subject Identifier (prefer the header parameter).",
            "required": false,
            "schema": {
              "type": "string",
              "example": "user@example.com"
            },
            "deprecated": true
          },
          {
            "name": "identifier",
            "in": "header",
            "description": "Data Subject Identifier (prefer the header parameter).",
            "required": false,
            "schema": {
              "type": "string",
              "example": "user@example.com"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK - Successfully withdrew data subject's consent for all purposes.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_DataSubjectPreferencesResponseDto"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request"
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "Forbidden"
          },
          "404": {
            "description": "Not Found",
            "content": {
              "*/*": {
                "schema": {
                  "type": "string"
                }
              }
            }
          },
          "429": {
            "description": "Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).",
            "headers": {
              "Retry-After": {
                "schema": {
                  "description": "The number of seconds after which requests will be allowed again.",
                  "format": "int32"
                }
              },
              "ot-period": {
                "schema": {
                  "description": "The unit of time for which the rate limit applies",
                  "enum": [
                    "HOUR",
                    "MINUTE"
                  ]
                }
              },
              "ot-ratelimit-event-id": {
                "schema": {
                  "description": "The unique identifier for the rate-limiting event.",
                  "format": "uuid"
                }
              },
              "ot-request-made": {
                "schema": {
                  "description": "The number of requests made within the specified period.",
                  "format": "int32"
                }
              },
              "ot-requests-allowed": {
                "schema": {
                  "description": "The number of requests allowed within the specified period.",
                  "format": "int32"
                }
              }
            }
          },
          "500": {
            "description": "Internal Server Error"
          }
        },
        "security": [
          {
            "ConsentPreferences-UniversalConsentPreferenceManag_OAUTH2": [
              "CONSENT"
            ]
          }
        ]
      }
    }
  },
  "components": {
    "schemas": {
      "ConsentPreferences-UniversalConsentPreferenceManag_DataSubjectPreferencesResponseDto": {
        "type": "object",
        "properties": {
          "Purposes": {
            "description": "List of Purposes with their updated consent status for the Data Subject",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ConsentPreferences-UniversalConsentPreferenceManag_DataSubjectPurposesResponseDto"
            }
          },
          "Language": {
            "description": "The preferred language of the Data Subject in BCP 47 format",
            "type": "string",
            "example": "en-us"
          }
        }
      },
      "ConsentPreferences-UniversalConsentPreferenceManag_DataSubjectPurposesResponseDto": {
        "properties": {
          "messages": {
            "description": "List of status messages related to the Purpose update operation",
            "type": "array",
            "items": {
              "type": "string"
            },
            "example": [
              "added",
              "updated"
            ]
          },
          "Id": {
            "description": "Unique identifier for the Purpose that was updated",
            "type": "string",
            "format": "uuid",
            "example": "f2229953-b4b5-4042-8cb9-b78038cc4c46"
          },
          "Status": {
            "description": "Indicates whether the Purpose update was successful",
            "type": "boolean",
            "example": true
          },
          "ReceiptGuid": {
            "description": "Unique identifier for the receipt of this update operation",
            "type": "string",
            "format": "uuid",
            "example": "64a9b83e-3aae-4e9f-b75e-5fbd01aecd85"
          }
        }
      }
    },
    "securitySchemes": {
      "ConsentPreferences-UniversalConsentPreferenceManag_OAUTH2": {
        "type": "oauth2",
        "flows": {
          "clientCredentials": {
            "tokenUrl": "https://{hostname}/api/access/v1/oauth/token",
            "scopes": {
              "CONSENT": "Consent Scope gives the user access to read/write operations",
              "CONSENT_READ": "Consent Read Scope gives the user read-only access"
            }
          }
        }
      }
    }
  },
  "x-readme": {
    "explorer-enabled": false,
    "proxy-enabled": false,
    "metrics-enabled": false
  },
  "x-onetrust": {
    "spec-label": "OpenAPI 3.1.0"
  }
}
```

# Sibling pages

* [Get Data Subject's Preferences in a Preference Center](https://developer.onetrust.com/onetrust/reference/getdatasubjectpurposesbyidentifierusingget_1.md)
* [Update Data Subject's Preferences in a Preference Center](https://developer.onetrust.com/onetrust/reference/updatepreferencesfordatasubjectapiusingput.md)
* [Get Preference Center Schema](https://developer.onetrust.com/onetrust/reference/getpreferencecenterbyidusingget.md)