Data Privacy

Run in Postman
Import the SparkPost API as a Postman collection

Request deletion of recipient data or opt-out of third party data usage of a recipient's personal information. Requests will be completed within 30 days.

Data Privacy Request

Request Body

recipients array required

Array of email addresses (max 1000)

include_subaccounts boolean

Set to true to apply request to master account and all subaccounts. Only applies if X-MSYS-SUBACCOUNT header is not set.

Request

POST /api/v1/data-privacy/rtbf-request
{
  "recipients": [
    "email@example.com",
    "email2@example.com"
  ],
  "include_subaccounts": false
}

Response

{
  "results": {
    "message": "Request saved."
  }
}
{
  "errors": [
    {
      "message": "Exceeded maximum number of recipients (1000)"
    }
  ]
}
{
  "errors": [
    {
      "message": "invalid email address",
      "recipient": "not_an_email"
    }
  ]
}

Add request to be forgotten

POST/api/v1/data-privacy/rtbf-request

Request

POST /api/v1/data-privacy/opt-out-request
{
  "recipients": [
    "email@example.com",
    "email2@example.com"
  ],
  "include_subaccounts": false
}

Response

{
  "results": {
    "message": "Request saved."
  }
}
{
  "errors": [
    {
      "message": "Exceeded maximum number of recipients (1000)"
    }
  ]
}
{
  "errors": [
    {
      "message": "invalid email address",
      "recipient": "not_an_email"
    }
  ]
}

Add opt out request

POST/api/v1/data-privacy/opt-out-request