Skip to main content
POST
cURL

Authorizations

API-Key
string
header
required

Account-scoped API key created in Settings. Operations declare the scopes they require. Available scopes:

  • RULES_READ: List and inspect automation rules for this inbox.
  • RULES_WRITE: Create, update, and delete automation rules for this inbox.
  • STATS_READ: Read aggregated inbox statistics for this inbox.
  • SENDERS_UNSUBSCRIBE: Unsubscribe from senders for this inbox.

Body

application/json
senderEmail
string<email>
required
listUnsubscribeHeader
string
Minimum string length: 1

Response

Unsubscribe attempt completed

senderEmail
string<email>
required
status
enum<string> | null
required
Available options:
UNSUBSCRIBED,
null
unsubscribe
object
required