GDPR Requests

Raise a GDPR data request

Changed on

Raise a GDPR data request for the authenticated customer. Type must be delete or update.

post/gdpr-requests

Request

Headers

X-STOREFRONT-KEYstring required

Storefront API Key for authentication. Required for all shop/storefront API requests.

X-Localestring
Example:en

Locale code for localized data (e.g. "en", "fr", "ar"). Defaults to channel's default locale.

X-Channelstring
Example:default

Channel code (e.g. "default"). Defaults to the current channel.

X-Currencystring
Example:USD

Currency code (e.g. "USD", "EUR", "INR"). Defaults to channel's base currency.

Request body

type'delete' | 'update' required
messagestring required

Example request

{
  "type": "delete",
  "message": "Please delete all my personal data."
}

Response

Request raised. Starts in pending status.

Changes