TRtriplewhale
Compliance

Create Compliance Data Deletion Request

Create a compliance request to delete/mask customer PII for a shop using one or more identifiers (emails and/or phone numbers).

post/compliance/requests/create-request

Request

  • Base URL
    https://api.triplewhale.com/api/v2
  • URL
    https://api.triplewhale.com/api/v2/compliance/requests/create-request
  • Auth
    API key in header x-api-key

Request body

shopstring required

The unique identifier for the shop (e.g., example.myshopify.com). This is the shop-id value in your Triple Whale app URL (for example ?shop-id=example.myshopify.com). The API key owner must have access to this shop.

emailsstring[]

Customer email addresses to include in the request.

phonesstring[]

Customer phone numbers to include in the request.

Example request

{
  "shop": "example.myshopify.com",
  "emails": [
    "john.smith@gmail.com"
  ],
  "phones": [
    "+1-555-123-4567"
  ]
}

Response

Request created successfully.

successboolean required
messagestring required

Example response

{
  "success": true,
  "message": "Request created successfully"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.