Create a email suppression

Request body

• reasonstringrequiredunsubscribed | complained | bounced | manual

  Why they are blocked.

• emailstringrequired

  The address to block. With scope: domain, a domain like example.com (no @).

• scopestringaddress | domain

  address (the default) blocks one address. domain blocks every address at a domain.

• notestring

  Optional. Your own note on why.

Request

curl -X POST 'https://app.mailyte.com/api/v1/email-suppressions' \
  -H 'Authorization: Bearer mk_live_YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "reason": "unsubscribed",
    "email": "ada@example.com"
  }'

const response = await fetch('https://app.mailyte.com/api/v1/email-suppressions', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer mk_live_YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "reason": "unsubscribed",
    "email": "ada@example.com"
  }),
});
const { data } = await response.json();

import requests
response = requests.post(
    "https://app.mailyte.com/api/v1/email-suppressions",
    headers={"Authorization": "Bearer mk_live_YOUR_API_KEY"},
    json={
      "reason": "unsubscribed",
      "email": "ada@example.com"
    },
)
data = response.json()["data"]

<?php

$response = Http::withToken('mk_live_YOUR_API_KEY')
    ->post('https://app.mailyte.com/api/v1/email-suppressions', [
    'reason' => 'unsubscribed',
    'email' => 'ada@example.com',
]);

$data = $response->json('data');

require "net/http"
require "json"
uri = URI("https://app.mailyte.com/api/v1/email-suppressions")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer mk_live_YOUR_API_KEY"
request["Content-Type"] = "application/json"
request.body = {
  "reason": "unsubscribed",
  "email": "ada@example.com"
}.to_json
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

Response

Success.

• dataobject
  • objectstringsuppression
  • idstring
  • emailstring

    The address, or the bare domain when scope is domain. Always lowercase.

  • scopestringaddress | domain

    A domain rule blocks every recipient at that EXACT domain. Subdomains are separate rules, matching SendGrid and Mailgun, so a rule never blocks more than the string somebody typed.

  • applies_tostringall | marketing

    What this blocks. all stops every email, including app email such as receipts and password resets. marketing stops only marketing. An unsubscribe blocks marketing; a bounce or complaint blocks everything.

  • reasonstring

    Why the address is blocked: usually unsubscribed, complained, bounced or manual. Imported rows can carry other values (import by default), so do not treat this as a closed list.

  • sourcestringmanual | automatic

    manual is a person or your API call; automatic is our bounce and complaint listener. A manual entry is never downgraded to automatic by a later event.

  • notestring

    Your own note. Null when none was written; entries we add automatically have none.

  • suppressed_atstring

    When the address was blocked.

  • expires_atstring

    When the block ends and the address can be emailed again. Null means never, which is the case for everything you add and for every bounce, complaint and unsubscribe. The one block that ends: a mailbox that stayed full for three days is skipped for 30.

Returned inside the standard envelope.

Errors

Every status, with what causes it and what to do, is on the error reference.