Blokované adresy

Čtěte a spravujte adresy, na které Emailit nebude odesílat.

Základní URLhttps://api.emailit.com/v2Autentizace Chyby Limity rychlosti

POST/suppressions
GET/suppressions/{id}
POST/suppressions/{id}
GET/suppressions
DEL/suppressions/{id}

Vytvoření blokace

Přidá adresu na seznam blokovaných adres vašeho workspace. E-maily přes API a SMTP na adresu s blokací typu recipient se neodešlou, ale dostanou stav suppressed, a kampaně blokované adresy přeskakují. Vyžaduje API klíč s oprávněním full.

POST/suppressions

Tělo požadavku

emailstringPovinné

Adresa, kterou chcete zablokovat. Emailit ji ukládá malými písmeny.

typestring

Typ blokace. Výchozí hodnota je recipient. Emailit používá typy recipient, bounce, complaint a unsubscribe.

E-maily odeslané přes API a SMTP zastaví jen blokace typu recipient. Kampaně přeskakují každou adresu s aktivní blokací jakéhokoli typu. Adresa může mít od každého typu jednu blokaci.

reasonstring

Poznámka ve volném textu, například manual nebo Asked to stop receiving invoices.

keep_untilstring | number | null

Kdy blokace vyprší. Přijímá časové razítko ISO 8601 (2026-12-31T00:00:00Z), unixové časové razítko v sekundách (1798675200) nebo přirozený jazyk, například in 30 days nebo tomorrow at 9am. Pro trvalou blokaci parametr vynechte, nebo pošlete null.

Po uplynutí tohoto času blokace přestane bránit odesílání. Na seznamu zůstane, dokud ji nesmažete.

Odpověď

Vrací 201 Created s objektem blokace. Emailit také odešle webhookovou událost suppression.created.

Stavový kód	Kdy
`400`	`email` není platná adresa nebo `keep_until` nelze zpracovat (tělo obsahuje řetězec `error`), nebo `email` chybí (standardní chyba validace).
`409`	Adresa už má blokaci tohoto typu. Tělo obsahuje existující blokaci v poli `existing`.

POST/suppressions

JavaScript

import { Emailit } from '@emailit/node';
const emailit = new Emailit('your_api_key');

const suppression = await emailit.suppressions.create({
    email: 'ada@example.com',
    reason: 'manual'
});

Python

from emailit import EmailitClient
client = EmailitClient("your_api_key")

suppression = client.suppressions.create({
    "email": "ada@example.com",
    "reason": "manual"
})

PHP

$emailit = Emailit::client('your_api_key');

$suppression = $emailit->suppressions()->create([
    'email' => 'ada@example.com',
    'reason' => 'manual'
]);

Ruby

require "emailit"
client = Emailit::EmailitClient.new("your_api_key")

suppression = client.suppressions.create(
    email: "ada@example.com",
    reason: "manual"
)

import "github.com/emailit/emailit-go/v2"
client := emailit.NewClient("your_api_key")

suppression, err := client.Suppressions.Create(&emailit.CreateSuppressionRequest{
    Email: "ada@example.com",
    Reason: "manual",
})

Rust

use emailit::Emailit;
let emailit = Emailit::new("your_api_key");

let suppression = emailit.suppressions.create(
    emailit::types::CreateSuppressionParams::new("ada@example.com")
        .with_reason("manual")
).await?;

Java

import com.emailit.*;
import com.emailit.params.*;
EmailitClient emailit = new EmailitClient("your_api_key");

EmailitObject suppression = emailit.suppressions().create(
    SuppressionCreateParams.builder()
        .setEmail("ada@example.com")
        .setReason("manual")
        .build()
);

using Emailit;
var emailit = new EmailitClient("your_api_key");

var suppression = emailit.Suppressions.Create(new SuppressionCreateOptions {
    Email = "ada@example.com",
    Reason = "manual"
});

PHP

use Emailit\Laravel\Facades\Emailit;

$suppression = Emailit::suppressions()->create([
    'email' => 'ada@example.com',
    'reason' => 'manual'
]);

Terminal

curl -X POST https://api.emailit.com/v2/suppressions \
  -H "Authorization: Bearer your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "ada@example.com",
    "reason": "manual"
  }'

JSON

{
  "object": "suppression",
  "id": "sup_2xL1c8NqT4pWm6Rb0YsKd3HvF9e",
  "type": "recipient",
  "email": "ada@example.com",
  "reason": "manual",
  "created_at": "2026-10-01T09:30:12.481000+00:00",
  "keep_until": null
}

JSON

{
  "error": "Invalid keep_until format. Accepts ISO 8601, Unix timestamp, or natural language like \"tomorrow at 9am\"."
}

JSON

{
  "error": "Suppression already exists for this email and type",
  "existing": {
    "object": "suppression",
    "id": "sup_2xKz0Pq5Rm8Nw2Tb7YdLc4HsE1a",
    "type": "recipient",
    "email": "ada@example.com",
    "reason": "too many bounces",
    "created_at": "2026-09-12T16:04:51.207000+00:00",
    "keep_until": null
  }
}

Načtení blokace

Vrací jednu blokaci dohledanou podle ID, nebo podle e-mailové adresy. Vyžaduje API klíč s oprávněním full.

GET/suppressions/:id

Parametry v cestě

idstringPovinné

ID blokace (sup_…), nebo blokovaná adresa. Adresu zakódujte pro URL, například ada%40example.com.

Adresa může mít od každého typu jednu blokaci. Když hledáte podle adresy, Emailit vrátí jednu z nich; pro konkrétní typ použijte ID.

Odpověď

Vrací 200 OK s objektem blokace. Blokace, jejíž keep_until je v minulosti, už odesílání nebrání.

Pokud id není ID sup_ ani platná e-mailová adresa, vrací 400, a pokud žádná blokace neodpovídá, vrací 404.

GET/suppressions/{id}

JavaScript

import { Emailit } from '@emailit/node';
const emailit = new Emailit('your_api_key');

const suppression = await emailit.suppressions.get('sup_2xL1c8NqT4pWm6Rb0YsKd3HvF9e');

Python

from emailit import EmailitClient
client = EmailitClient("your_api_key")

suppression = client.suppressions.get("sup_2xL1c8NqT4pWm6Rb0YsKd3HvF9e")

PHP

$emailit = Emailit::client('your_api_key');

$suppression = $emailit->suppressions()->get('sup_2xL1c8NqT4pWm6Rb0YsKd3HvF9e');

Ruby

require "emailit"
client = Emailit::EmailitClient.new("your_api_key")

suppression = client.suppressions.get("sup_2xL1c8NqT4pWm6Rb0YsKd3HvF9e")

import "github.com/emailit/emailit-go/v2"
client := emailit.NewClient("your_api_key")

suppression, err := client.Suppressions.Get("sup_2xL1c8NqT4pWm6Rb0YsKd3HvF9e")

Rust

use emailit::Emailit;
let emailit = Emailit::new("your_api_key");

let suppression = emailit.suppressions.get("sup_2xL1c8NqT4pWm6Rb0YsKd3HvF9e").await?;

Java

import com.emailit.*;
import com.emailit.params.*;
EmailitClient emailit = new EmailitClient("your_api_key");

EmailitObject suppression = emailit.suppressions().get("sup_2xL1c8NqT4pWm6Rb0YsKd3HvF9e");

using Emailit;
var emailit = new EmailitClient("your_api_key");

var suppression = emailit.Suppressions.Get("sup_2xL1c8NqT4pWm6Rb0YsKd3HvF9e");

PHP

use Emailit\Laravel\Facades\Emailit;

$suppression = Emailit::suppressions()->get('sup_2xL1c8NqT4pWm6Rb0YsKd3HvF9e');

Terminal

curl https://api.emailit.com/v2/suppressions/sup_2xL1c8NqT4pWm6Rb0YsKd3HvF9e \
  -H "Authorization: Bearer your_api_key"

JSON

{
  "object": "suppression",
  "id": "sup_2xL1c8NqT4pWm6Rb0YsKd3HvF9e",
  "type": "recipient",
  "email": "ada@example.com",
  "reason": "too many bounces",
  "created_at": "2026-10-01T09:30:12.481000+00:00",
  "keep_until": null
}

JSON

{
  "error": "Invalid identifier. Must be a suppression ID (sup_xxx) or valid email address."
}

JSON

{
  "error": "Suppression not found"
}

Úprava blokace

Upraví blokaci. Pošlete jen pole, která chcete změnit; alespoň jedno je povinné. Vyžaduje API klíč s oprávněním full.

POST/suppressions/:id

Parametry v cestě

idstringPovinné

ID blokace (sup_…), nebo blokovaná adresa zakódovaná pro URL (ada%40example.com). Pokud má adresa blokace více typů, použijte ID.

Tělo požadavku

emailstring

Nová adresa. Ukládá se malými písmeny.

typestring

Nový typ: recipient, bounce, complaint nebo unsubscribe. Odesílání přes API a SMTP zastaví jen blokace typu recipient.

reasonstring

Nový důvod ve volném textu.

keep_untilstring | number | null

Nové datum vypršení ve stejných formátech jako při vytvoření: ISO 8601, unixové časové razítko v sekundách nebo přirozený jazyk, například in 30 days. Pokud má být blokace trvalá, pošlete null.

Odpověď

Vrací 200 OK s upravenou blokací. Emailit také odešle webhookovou událost suppression.updated.

Stavový kód	Kdy
`400`	Tělo neobsahuje žádné z výše uvedených polí, `email` je neplatný nebo `keep_until` nelze zpracovat.
`404`	Parametru `id` neodpovídá žádná blokace.
`409`	Pro novou adresu a typ už existuje jiná blokace.

POST/suppressions/{id}

JavaScript

import { Emailit } from '@emailit/node';
const emailit = new Emailit('your_api_key');

const suppression = await emailit.suppressions.update('sup_2xL1c8NqT4pWm6Rb0YsKd3HvF9e', {
    reason: 'Asked to pause invoices until January'
});

Python

from emailit import EmailitClient
client = EmailitClient("your_api_key")

suppression = client.suppressions.update("sup_2xL1c8NqT4pWm6Rb0YsKd3HvF9e", {
    "reason": "Asked to pause invoices until January"
})

PHP

$emailit = Emailit::client('your_api_key');

$suppression = $emailit->suppressions()->update('sup_2xL1c8NqT4pWm6Rb0YsKd3HvF9e', [
    'reason' => 'Asked to pause invoices until January'
]);

Ruby

require "emailit"
client = Emailit::EmailitClient.new("your_api_key")

suppression = client.suppressions.update("sup_2xL1c8NqT4pWm6Rb0YsKd3HvF9e", reason: "Asked to pause invoices until January")

import "github.com/emailit/emailit-go/v2"
client := emailit.NewClient("your_api_key")

suppression, err := client.Suppressions.Update("sup_2xL1c8NqT4pWm6Rb0YsKd3HvF9e", &emailit.UpdateSuppressionRequest{
    Reason: "Asked to pause invoices until January",
})

Rust

use emailit::Emailit;
let emailit = Emailit::new("your_api_key");

let suppression = emailit.suppressions.update(
    "sup_2xL1c8NqT4pWm6Rb0YsKd3HvF9e",
    emailit::types::UpdateSuppressionParams {
        reason: Some("Asked to pause invoices until January".into()),
        ..Default::default()
    }
).await?;

Java

import com.emailit.*;
import com.emailit.params.*;
EmailitClient emailit = new EmailitClient("your_api_key");

EmailitObject suppression = emailit.suppressions().update("sup_2xL1c8NqT4pWm6Rb0YsKd3HvF9e",
    SuppressionUpdateParams.builder()
        .setReason("Asked to pause invoices until January")
        .build()
);

using Emailit;
var emailit = new EmailitClient("your_api_key");

var suppression = emailit.Suppressions.Update("sup_2xL1c8NqT4pWm6Rb0YsKd3HvF9e",
    new SuppressionUpdateOptions { Reason = "Asked to pause invoices until January" });

PHP

use Emailit\Laravel\Facades\Emailit;

$suppression = Emailit::suppressions()->update('sup_2xL1c8NqT4pWm6Rb0YsKd3HvF9e', [
    'reason' => 'Asked to pause invoices until January'
]);

Terminal

curl -X POST https://api.emailit.com/v2/suppressions/sup_2xL1c8NqT4pWm6Rb0YsKd3HvF9e \
  -H "Authorization: Bearer your_api_key" \
  -H "Content-Type: application/json" \
  -d '{"reason": "Asked to pause invoices until January"}'

JSON

{
  "object": "suppression",
  "id": "sup_2xL1c8NqT4pWm6Rb0YsKd3HvF9e",
  "type": "recipient",
  "email": "ada@example.com",
  "reason": "Asked to pause invoices until January",
  "created_at": "2026-10-01T09:30:12.481000+00:00",
  "keep_until": "2027-01-01T00:00:00.000000+00:00"
}

JSON

{
  "error": "No valid fields provided for update. Provide at least one of: email, type, reason, keep_until"
}

JSON

{
  "error": "Suppression not found"
}

JSON

{
  "error": "Another suppression already exists for this email and type combination"
}

Výpis blokovaných adres

Vrací blokace ve vašem workspace od nejnovějších. Seznam obsahuje i blokace, které Emailit přidává automaticky po nedoručeních a stížnostech, a vypršené blokace, jejichž keep_until už uplynulo. Vyžaduje API klíč s oprávněním full.

GET/suppressions

Parametry dotazu

pageinteger

Číslo stránky, začíná na 1. Výchozí hodnota je 1.

limitinteger

Počet blokací na stránce, od 1 do 100. Výchozí hodnota je 10.

searchstring

Hledá v adrese nebo v důvodu bez ohledu na velikost písmen. Jako alias funguje q.

matchstring

all (výchozí) vyžaduje shodu všech filtrů key.condition. U or stačí shoda kteréhokoli z nich. Viz Filtrování a řazení.

sortstring

Klíč řazení: email, reason, type nebo created_at (výchozí).

orderstring

Směr řazení: asc, nebo desc (výchozí).

Filtry

Filtry výpisů jsou jedna úroveň parametrů dotazu ve tvaru key.condition=value. Parametry match, order a direction a seznam podmínek pro každý typ najdete na stránce Filtrování.

Klíče filtrů

Klíč	Typ	Podmínky
`email`	string	exact, not_exact, contains, not_contains, starts_with, ends_with, empty, not_empty
`reason`	string	exact, not_exact, contains, not_contains, starts_with, ends_with, empty, not_empty
`type`	string	exact, not_exact, contains, not_contains, starts_with, ends_with, empty, not_empty
`created_at`	date	exact, before, after, empty, not_empty
`keep_until`	date	exact, before, after, empty, not_empty

Klíče řazení

Tento endpoint řadí podle parametru sort s jedním z těchto klíčů a parametru order s hodnotou asc, nebo desc (order=<key> tu vrací 400): email, reason, type, created_at, keep_until

U tohoto endpointu přijímá order jen asc, nebo desc. Klíč řazení předejte v sort, například sort=email&order=asc.

Odpověď

Vrací 200 OK s blokacemi v poli data a k tomu next_page_url a previous_page_url (null, když další nebo předchozí stránka neexistuje). URL stránek zachovávají vaše vyhledávání, filtry a řazení.

GET/suppressions

JavaScript

import { Emailit } from '@emailit/node';
const emailit = new Emailit('your_api_key');

const suppressions = await emailit.suppressions.list();

Python

from emailit import EmailitClient
client = EmailitClient("your_api_key")

suppressions = client.suppressions.list()

PHP

$emailit = Emailit::client('your_api_key');

$suppressions = $emailit->suppressions()->list();

Ruby

require "emailit"
client = Emailit::EmailitClient.new("your_api_key")

suppressions = client.suppressions.list

import "github.com/emailit/emailit-go/v2"
client := emailit.NewClient("your_api_key")

suppressions, err := client.Suppressions.List(nil)

Rust

use emailit::Emailit;
let emailit = Emailit::new("your_api_key");

let suppressions = emailit.suppressions.list(None).await?;

Java

import com.emailit.*;
import com.emailit.params.*;
EmailitClient emailit = new EmailitClient("your_api_key");

EmailitObject suppressions = emailit.suppressions().list();

using Emailit;
var emailit = new EmailitClient("your_api_key");

var suppressions = emailit.Suppressions.List();

PHP

use Emailit\Laravel\Facades\Emailit;

$suppressions = Emailit::suppressions()->list();

Terminal

curl https://api.emailit.com/v2/suppressions \
  -H "Authorization: Bearer your_api_key"

JSON

{
  "data": [
    {
      "object": "suppression",
      "id": "sup_2xL1c8NqT4pWm6Rb0YsKd3HvF9e",
      "type": "recipient",
      "email": "ada@example.com",
      "reason": "too many bounces",
      "created_at": "2026-10-01T09:30:12.481000+00:00",
      "keep_until": null
    },
    {
      "object": "suppression",
      "id": "sup_2xKz0Pq5Rm8Nw2Tb7YdLc4HsE1a",
      "type": "complaint",
      "email": "grace@example.com",
      "reason": "complaint",
      "created_at": "2026-09-28T13:17:40.912000+00:00",
      "keep_until": null
    }
  ],
  "next_page_url": "/v2/suppressions?limit=10&page=2",
  "previous_page_url": null
}

JSON

{
  "statusCode": 401,
  "error": "Unauthorized",
  "message": "Invalid API key"
}

Smazání blokace

Smaže blokaci, aby adresa mohla znovu dostávat e-maily. Vyžaduje API klíč s oprávněním full.

DELETE/suppressions/:id

Parametry v cestě

idstringPovinné

ID blokace (sup_…), nebo blokovaná adresa zakódovaná pro URL (ada%40example.com).

Požadavek podle adresy smaže jednu blokaci. Pokud má adresa blokace více typů, smažte každou podle ID, nebo požadavek opakujte, dokud nevrátí 404.

Odpověď

Vrací 200 OK s poli id a email smazané blokace a deleted: true. Emailit také odešle webhookovou událost suppression.deleted.

Pokud id není ID sup_ ani platná e-mailová adresa, vrací 400, a pokud žádná blokace neodpovídá, vrací 404.

DELETE/suppressions/{id}

JavaScript

import { Emailit } from '@emailit/node';
const emailit = new Emailit('your_api_key');

await emailit.suppressions.delete('sup_2xL1c8NqT4pWm6Rb0YsKd3HvF9e');

Python

from emailit import EmailitClient
client = EmailitClient("your_api_key")

client.suppressions.delete("sup_2xL1c8NqT4pWm6Rb0YsKd3HvF9e")

PHP

$emailit = Emailit::client('your_api_key');

$emailit->suppressions()->delete('sup_2xL1c8NqT4pWm6Rb0YsKd3HvF9e');

Ruby

require "emailit"
client = Emailit::EmailitClient.new("your_api_key")

client.suppressions.delete("sup_2xL1c8NqT4pWm6Rb0YsKd3HvF9e")

import "github.com/emailit/emailit-go/v2"
client := emailit.NewClient("your_api_key")

err := client.Suppressions.Delete("sup_2xL1c8NqT4pWm6Rb0YsKd3HvF9e")

Rust

use emailit::Emailit;
let emailit = Emailit::new("your_api_key");

emailit.suppressions.delete("sup_2xL1c8NqT4pWm6Rb0YsKd3HvF9e").await?;

Java

import com.emailit.*;
import com.emailit.params.*;
EmailitClient emailit = new EmailitClient("your_api_key");

emailit.suppressions().delete("sup_2xL1c8NqT4pWm6Rb0YsKd3HvF9e");

using Emailit;
var emailit = new EmailitClient("your_api_key");

emailit.Suppressions.Delete("sup_2xL1c8NqT4pWm6Rb0YsKd3HvF9e");

PHP

use Emailit\Laravel\Facades\Emailit;

Emailit::suppressions()->delete('sup_2xL1c8NqT4pWm6Rb0YsKd3HvF9e');

Terminal

curl -X DELETE https://api.emailit.com/v2/suppressions/sup_2xL1c8NqT4pWm6Rb0YsKd3HvF9e \
  -H "Authorization: Bearer your_api_key"

JSON

{
  "object": "suppression",
  "id": "sup_2xL1c8NqT4pWm6Rb0YsKd3HvF9e",
  "email": "ada@example.com",
  "deleted": true
}

JSON

{
  "error": "Invalid identifier. Must be a suppression ID (sup_xxx) or valid email address."
}

JSON

{
  "error": "Suppression not found"
}