SparkPost · Example Payload

Sparkpost Suppression Bulk Example

Example: Bulk insert suppressions for unsubscribed recipients

EmailTransactional EmailMarketing EmailEmail DeliverySMTPWebhooksAnalyticsTemplatesSuppression List

Sparkpost Suppression Bulk Example is an example object payload from SparkPost, with 3 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

descriptionrequestresponse

Example Payload

{
  "description": "Example: Bulk insert suppressions for unsubscribed recipients",
  "request": {
    "method": "PUT",
    "url": "https://api.sparkpost.com/api/v1/suppression-list",
    "headers": {
      "Authorization": "YOUR_API_KEY",
      "Content-Type": "application/json"
    },
    "body": {
      "recipients": [
        {
          "recipient": "unsubscribed@example.com",
          "type": "non_transactional",
          "description": "User requested unsubscribe via email footer"
        },
        {
          "recipient": "bounced@example.com",
          "type": "transactional",
          "description": "Hard bounce — address does not exist"
        },
        {
          "recipient": "complained@example.com",
          "type": "non_transactional",
          "description": "Spam complaint via Yahoo FBL"
        }
      ]
    }
  },
  "response": {
    "status": 200,
    "body": {}
  }
}