Suppressions

Suppress an email address

Adds a manual suppression so nothing is sent to the address. The address is trimmed and lowercased. When an active entry already covers the address, it is returned with status 200: its scope widens to all if you ask for all, a soft-bounce pause becomes a permanent manual entry, and a permanent entry is never shortened. When there is no active entry, or the previous one has expired, a new entry is stored and returned with status 201. Calling it twice with the same body has the same effect as calling it once.

post/suppressions

Request

  • Base URL: https://shipmail.to/api/v1
  • URL: https://shipmail.to/api/v1/suppressions
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://shipmail.to/api/auth/oauth2/authorize, token URL https://shipmail.to/api/auth/oauth2/token)

Headers

X-Shipmail-Organizationstring

OAuth access tokens only. The organization ID this request acts on. Required when the OAuth connection was approved for several organizations (400 validation_error without it); optional with one. An organization the connection was not approved for returns 403 authorization_error. Ignored for API keys, which belong to one organization.

Request body

emailstring email required

The address to suppress. Trimmed and lowercased before it is stored.

scope'all' | 'marketing'

all blocks every send. marketing blocks newsletter sends only.

Response

An active entry already covered the address. Returns it, widened if requested.

object'suppression' required
email_addressstring email required

The suppressed email address.

reason'hard_bounce' | 'complaint' | 'manual' | 'soft_bounce' required

Why the address was suppressed. soft_bounce: at least 3 temporary bounces (mailbox full or a general temporary failure) in 14 days.

scope'all' | 'marketing' required

Which sends the entry blocks. all blocks every send. marketing blocks newsletter sends only and is set by a complaint about a newsletter.

expires_atstring date-time nullable required

When the entry stops blocking sends, or null when it is permanent. A soft-bounce entry lasts 30 days; a second one for the same address is permanent.

created_atstring date-time required

When the address was suppressed.

Changes

No recorded changes to this operation across all 1 revision of this API.