Suppressions
Manage the per-account suppression list
3 endpoints
Endpoints
| Method | Path | Description |
|---|
| GET | /v1/suppressions | GET /v1/suppressions |
| POST | /v1/suppressions | POST /v1/suppressions |
| DELETE | /v1/suppressions/{email} | DELETE /v1/suppressions/:email |
GET /v1/suppressions
GET /v1/suppressions
Parameters
| Name | In | Type | Required | Description |
|---|
page | query | integer | No | Page number (default: 1) |
per_page | query | integer | No | Items per page (default: 25) |
Responses
| Status | Description |
|---|
| 200 | Paginated suppression list |
| 401 | Unauthorized |
Example
curl -X GET https://api.euromail.dev/v1/suppressions \
-H "X-EuroMail-Api-Key: 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
| Field | Type | Required | Description |
|---|
email_address | string | Yes | |
reason | `string | null` | No |
Responses
| Status | Description |
|---|
| 201 | Address added to suppression list |
| 401 | Unauthorized |
| 422 | Validation error |
Example
curl -X POST https://api.euromail.dev/v1/suppressions \
-H "X-EuroMail-Api-Key: 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;
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]",
})
DELETE /v1/suppressions/{email}
DELETE /v1/suppressions/:email
Parameters
| Name | In | Type | Required | Description |
|---|
email | path | string | Yes | Email address to remove from suppression list |
Responses
| Status | Description |
|---|
| 204 | Suppression removed |
| 401 | Unauthorized |
Example
curl -X DELETE https://api.euromail.dev/v1/suppressions/{email} \
-H "X-EuroMail-Api-Key: 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_...")