← All API sections

Suppressions

Manage the per-account suppression list

5 endpoints
Menu

Endpoints

MethodPathDescription
GET/v1/suppressionsGET /v1/suppressions
POST/v1/suppressionsPOST /v1/suppressions
GET/v1/suppressions/exportGET /v1/suppressions/export — export all suppressions as CSV.
POST/v1/suppressions/importPOST /v1/suppressions/import — bulk import suppressions from a list of emails.
DELETE/v1/suppressions/{email}DELETE /v1/suppressions/:email

GET /v1/suppressions

GET /v1/suppressions

Parameters

NameInTypeRequiredDescription
pagequeryintegerNoPage number (default: 1)
per_pagequeryintegerNoItems per page (default: 25)

Responses

StatusDescription
200Paginated suppression list
401Unauthorized

Example

curl -X GET https://api.euromail.dev/v1/suppressions \
  -H "Authorization: Bearer em_live_..."
import { EuroMail } from "@euromail/sdk";

const euromail = new EuroMail({ apiKey: "em_live_..." });

const result = await euromail.listSuppressions();
from euromail import EuroMail

client = EuroMail(api_key="em_live_...")

result = client.list_suppressions()
use euromail::EuroMail;

let client = EuroMail::new("em_live_...");

let result = client.list_suppressions().await?;
client := euromail.NewClient("em_live_...")

result, err := client.ListSuppressions(ctx)

POST /v1/suppressions

POST /v1/suppressions

Request Body

FieldTypeRequiredDescription
email_addressstringYes
reasonstring | nullNo

Responses

StatusDescription
201Address added to suppression list
401Unauthorized
422Validation error

Example

curl -X POST https://api.euromail.dev/v1/suppressions \
  -H "Authorization: Bearer em_live_..." \
  -H "Content-Type: application/json" \
  -d '{
  "email_address": "[email protected]"
}'
import { EuroMail } from "@euromail/sdk";

const euromail = new EuroMail({ apiKey: "em_live_..." });

const result = await euromail.createSuppression({
  email_address: "[email protected]"
});
from euromail import EuroMail

client = EuroMail(api_key="em_live_...")

result = client.create_suppression(
    email_address="[email protected]",
)
use euromail::{EuroMail, CreateSuppressionParams};

let client = EuroMail::new("em_live_...");

let result = client.create_suppression(&CreateSuppressionParams {
    email_address: "[email protected]".into(),
    ..Default::default()
}).await?;
client := euromail.NewClient("em_live_...")

result, err := client.CreateSuppression(ctx, euromail.CreateSuppressionParams{
    EmailAddress: "[email protected]",
})

GET /v1/suppressions/export

GET /v1/suppressions/export — export all suppressions as CSV.

Responses

StatusDescription
200CSV export
401Unauthorized

Example

curl -X GET https://api.euromail.dev/v1/suppressions/export \
  -H "Authorization: Bearer em_live_..."
import { EuroMail } from "@euromail/sdk";

const euromail = new EuroMail({ apiKey: "em_live_..." });

const result = await euromail.getSuppression();
from euromail import EuroMail

client = EuroMail(api_key="em_live_...")

result = client.get_suppression()
use euromail::EuroMail;

let client = EuroMail::new("em_live_...");

let result = client.get_suppression().await?;
client := euromail.NewClient("em_live_...")

result, err := client.GetSuppression(ctx)

POST /v1/suppressions/import

POST /v1/suppressions/import — bulk import suppressions from a list of emails.

Request Body

FieldTypeRequiredDescription
emailsstring[]YesList of email addresses to suppress.
reasonstring | nullNoReason for suppression (default: "import").

Responses

StatusDescription
200Import results
401Unauthorized
422Validation error

Example

curl -X POST https://api.euromail.dev/v1/suppressions/import \
  -H "Authorization: Bearer em_live_..." \
  -H "Content-Type: application/json" \
  -d '{
  "emails": [
    "[email protected]"
  ]
}'
import { EuroMail } from "@euromail/sdk";

const euromail = new EuroMail({ apiKey: "em_live_..." });

const result = await euromail.createSuppression({
  emails: [
    "[email protected]"
  ]
});
from euromail import EuroMail

client = EuroMail(api_key="em_live_...")

result = client.create_suppression(
    emails=[
    "[email protected]"
  ],
)
use euromail::{EuroMail, CreateSuppressionParams};

let client = EuroMail::new("em_live_...");

let result = client.create_suppression(&CreateSuppressionParams {
    emails: vec!["[email protected]".into()],
    ..Default::default()
}).await?;
client := euromail.NewClient("em_live_...")

result, err := client.CreateSuppression(ctx, euromail.CreateSuppressionParams{
    Emails: []string{"[email protected]"},
})

DELETE /v1/suppressions/{email}

DELETE /v1/suppressions/:email

Parameters

NameInTypeRequiredDescription
emailpathstringYesEmail address to remove from suppression list

Responses

StatusDescription
204Suppression removed
401Unauthorized

Example

curl -X DELETE https://api.euromail.dev/v1/suppressions/{email} \
  -H "Authorization: Bearer em_live_..."
import { EuroMail } from "@euromail/sdk";

const euromail = new EuroMail({ apiKey: "em_live_..." });

const result = await euromail.deleteSuppression("id_...");
from euromail import EuroMail

client = EuroMail(api_key="em_live_...")

result = client.delete_suppression("id_...")
use euromail::EuroMail;

let client = EuroMail::new("em_live_...");

let result = client.delete_suppression("id_...").await?;
client := euromail.NewClient("em_live_...")

result, err := client.DeleteSuppression(ctx, "id_...")