v1

latestOpenAPI 3.1.02026-07-246014.7 KB

Redact

Note: When passed an email, phone number, Shopify customer ID, or Postscript subscriber ID, this endpoint will also unsubscribe the subscriber if they have an active subscription

patch/api/v2/compliance/redact

Headers

X-Postscript-Shop-Tokenstring

Shop API Token. Required for partners. This header should be used only by partners. Shops should include their API token in the Authorization header.

Request body

postscript_subscriber_idstring

ID of the subscriber you'd like to redact.

shopify_customer_idstring

A shopify customer id of the subscriber you'd like to redact.

emailstring

An email of the subscriber you'd like to redact.

phone_numberstring

A phone number of the subscriber you'd like to redact.

Response

202

messagestring

Example response

{
  "message": "OK"
}