email-suppressions-v2

Add an email address to the suppression list

The email is stored as a SHA-256 hash. Future sends to this address will be blocked.

post/v2/email/suppressions

Request

  • Base URL: https://api.tracklysms.com/api
  • URL: https://api.tracklysms.com/api/v2/email/suppressions
  • Auth: API key in header X-Api-Key

Request body

emailstring required

Email address to suppress

reasonstring

Suppression reason (manual, bounce, complaint, unsubscribe)

Response

Email suppressed

createdAtstring date-time

When the email was suppressed

emailHashstring

SHA-256 hash of the email

reasonstring

Suppression reason

Changes

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