SparkPost · Schema
SparkPost Suppression Entry
Schema for a SparkPost suppression list entry
EmailTransactional EmailMarketing EmailEmail DeliverySMTPWebhooksAnalyticsTemplatesSuppression List
Properties
| Name | Type | Description |
|---|---|---|
| recipient | string | Email address of the suppressed recipient |
| type | string | Type of suppression — transactional applies to transactional messages, non_transactional to marketing |
| description | string | Human-readable reason for the suppression |
| list_id | string | RFC 2919 compliant mailing list identifier |
| source | string | Origin of the suppression (returned in responses) |
| created | string | Timestamp when suppression was created |
| updated | string | Timestamp when suppression was last updated |
JSON Schema
{
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "https://api.sparkpost.com/schemas/suppression-entry",
"title": "SparkPost Suppression Entry",
"description": "Schema for a SparkPost suppression list entry",
"type": "object",
"required": ["recipient", "type"],
"properties": {
"recipient": {
"type": "string",
"format": "email",
"description": "Email address of the suppressed recipient"
},
"type": {
"type": "string",
"enum": ["transactional", "non_transactional"],
"description": "Type of suppression — transactional applies to transactional messages, non_transactional to marketing"
},
"description": {
"type": "string",
"description": "Human-readable reason for the suppression"
},
"list_id": {
"type": "string",
"description": "RFC 2919 compliant mailing list identifier"
},
"source": {
"type": "string",
"readOnly": true,
"description": "Origin of the suppression (returned in responses)"
},
"created": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "Timestamp when suppression was created"
},
"updated": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "Timestamp when suppression was last updated"
}
}
}