← All API sections

Newsletters

Draft, update, and send newsletters to a contact list

6 endpoints
Menu

Endpoints

MethodPathDescription
GET/v1/newslettersGET /v1/newsletters
POST/v1/newslettersPOST /v1/newsletters
GET/v1/newsletters/{id}GET /v1/newsletters/{id}
PUT/v1/newsletters/{id}PUT /v1/newsletters/{id}
DELETE/v1/newsletters/{id}DELETE /v1/newsletters/{id}
POST/v1/newsletters/{id}/sendPOST /v1/newsletters/{id}/send

GET /v1/newsletters

GET /v1/newsletters

Parameters

NameInTypeRequiredDescription
limitqueryinteger | nullNo
offsetqueryinteger | nullNo

Responses

StatusDescription
200Newsletters for this account
401Unauthorized

Example

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

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

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

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

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

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

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

result, err := client.ListNewsletters(ctx)

POST /v1/newsletters

POST /v1/newsletters

Request Body

FieldTypeRequiredDescription
from_addressstringYes
html_bodystring | nullNo
list_idstringYes
reply_tostring | nullNo
subjectstringYes
tagsstring[]No
template_dataanyNo
template_idstring | nullNo
text_bodystring | nullNo

Responses

StatusDescription
201Newsletter draft created
401Unauthorized
404Contact list not found
422Invalid from_address, or no content/template given

Example

curl -X POST https://api.euromail.dev/v1/newsletters \
  -H "Authorization: Bearer em_live_..." \
  -H "Content-Type: application/json" \
  -d '{
  "subject": "Welcome aboard",
  "from_address": "[email protected]",
  "list_id": "3f8b1c52-7a4e-4d0b-9c61-2e5d8a7f4b10"
}'
import { EuroMail } from "@euromail/sdk";

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

const result = await euromail.createNewsletter({
  subject: "Welcome aboard",
  from_address: "[email protected]",
  list_id: "3f8b1c52-7a4e-4d0b-9c61-2e5d8a7f4b10"
});
from euromail import EuroMail

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

result = client.create_newsletter(
    subject="Welcome aboard",
    from_address="[email protected]",
    list_id="3f8b1c52-7a4e-4d0b-9c61-2e5d8a7f4b10",
)
use euromail::{EuroMail, CreateNewsletterParams};

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

let result = client.create_newsletter(&CreateNewsletterParams {
    subject: "Welcome aboard".into(),
    from_address: "[email protected]".into(),
    list_id: "3f8b1c52-7a4e-4d0b-9c61-2e5d8a7f4b10".into(),
    ..Default::default()
}).await?;
client := euromail.NewClient("em_live_...")

result, err := client.CreateNewsletter(ctx, euromail.CreateNewsletterParams{
    Subject: "Welcome aboard",
    FromAddress: "[email protected]",
    ListID: "3f8b1c52-7a4e-4d0b-9c61-2e5d8a7f4b10",
})

GET /v1/newsletters/{id}

GET /v1/newsletters/{id}

Parameters

NameInTypeRequiredDescription
idpathstringYesNewsletter id

Responses

StatusDescription
200The newsletter (with stats, once sent)
401Unauthorized
404Newsletter not found

Example

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

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

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

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

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

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

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

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

PUT /v1/newsletters/{id}

PUT /v1/newsletters/{id}

Parameters

NameInTypeRequiredDescription
idpathstringYesNewsletter id

Request Body

FieldTypeRequiredDescription
from_addressstring | nullNo
html_bodystring | nullNo
list_idstring | nullNo
reply_tostring | nullNo
subjectstring | nullNo
tagsstring[]No
template_dataanyNo
template_idstring | nullNo
text_bodystring | nullNo

Responses

StatusDescription
200Newsletter updated
401Unauthorized
404Newsletter not found, or not a draft
422Newsletter is not in draft status, or tags are invalid

Example

curl -X PUT https://api.euromail.dev/v1/newsletters/{id} \
  -H "Authorization: Bearer em_live_..." \
  -H "Content-Type: application/json" \
  -d '{}'
import { EuroMail } from "@euromail/sdk";

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

const result = await euromail.updateNewsletter({});
from euromail import EuroMail

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

result = client.update_newsletter(
)
use euromail::{EuroMail, UpdateNewsletterParams};

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

let result = client.update_newsletter(&UpdateNewsletterParams {
    ..Default::default()
}).await?;
client := euromail.NewClient("em_live_...")

result, err := client.UpdateNewsletter(ctx, euromail.UpdateNewsletterParams{
})

DELETE /v1/newsletters/{id}

DELETE /v1/newsletters/{id}

Parameters

NameInTypeRequiredDescription
idpathstringYesNewsletter id

Responses

StatusDescription
204Newsletter deleted
401Unauthorized
404Newsletter not found, or not a draft

Example

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

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

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

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

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

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

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

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

POST /v1/newsletters/{id}/send

POST /v1/newsletters/{id}/send

Parameters

NameInTypeRequiredDescription
idpathstringYesNewsletter id

Responses

StatusDescription
202Newsletter accepted for delivery
401Unauthorized
403The account's state or the key's scope blocks the send: CARD_VERIFICATION_REQUIRED (verify a card before sending to a list), ACCOUNT_UNDER_REVIEW (the account is under a review that holds its mail, because a message was flagged or because mail providers refused its recent mail; the message says which), ACCOUNT_SUSPENDED, or the key lacks a scope. Nothing was sent
404Newsletter or its contact list not found
422Newsletter is not a draft, has no content, no subscribers, or failed a pre-send gate
429The monthly quota cannot hold the whole list; nothing was sent

Example

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

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

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

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

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

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

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

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