Send e-post via API-et
Send med en enkelt POST til /v1/email, autentisert med en Bearer API-nøkkel. from-adressen må være på et verifisert domene.
Forespørsel
POST https://api.mailhuset.com/v1/email
Authorization: Bearer $MAILHUSET_API_KEY
Content-Type: application/json
{
"from": "Acme <hello@yourdomain.com>",
"to": ["customer@example.com"],
"subject": "Your receipt",
"html": "<p>Thanks for your order.</p>",
"text": "Thanks for your order."
}Felt
| Felt | Type | Merknader |
|---|---|---|
from | string | Name <address>; adressen må være på et verifisert domene. Påkrevd. |
to | string[] | En eller flere mottakere. Påkrevd. |
cc, bcc, replyTo | string[] | Valgfritt. |
subject | string | Påkrevd med mindre en mal leverer den. |
html, text | string | Innholdet. Send begge når du kan (bedre leveringsevne). |
templateAlias, templateModel | string, object | Render en lagret mal med en datamodell; subject/html/text overstyrer det genererte resultatet. |
stream | string | transactional (standard) eller broadcast (utsendelse). |
headers | object | Egendefinerte headere. |
tags | object | Nøkkel/verdi-tagger for filtrering i Activity. |
tracking | object | { "opens": true, "clicks": true }. Felt du ikke setter, følger strømmen (se nedenfor). |
idempotencyKey | string | En gjentakelse med samme nøkkel returnerer den opprinnelige meldingen i stedet for å sende to ganger. |
Svar
En 2xx-respons returnerer den aksepterte meldingen (med id-en dens). Meldingen legges deretter i kø og leveres; spor tilstanden dens i Aktivitet eller via webhooks.
Maler
Lagre gjenbrukbart innhold og send det med alias:
{
"from": "Acme <hello@yourdomain.com>",
"to": ["customer@example.com"],
"templateAlias": "welcome",
"templateModel": { "name": "Sam", "plan": "Pro" }
}Sporing av åpninger og klikk
Utsendelser sporer åpninger og klikk som standard. Transaksjonell e-post gjør det ikke, med mindre du ber om det per melding med tracking. Begge standardene kan overstyres, for eksempel { "opens": false, "clicks": false } på en utsendelse.
- Åpninger legger et lite usynlig bilde i HTML-en. Se på dem som en pekepinn: Apple Mail laster inn bilder for brukerne sine enten de leser meldingen eller ikke, og ren tekst har ingenting å laste inn.
- Klikk sender hver lenke via en sporingsviderekobling først. La det være av for tilbakestilling av passord og engangslenker, siden lenkeskannere i bedrifts-e-post følger lenker før mottakeren gjør det.
Sporede meldinger utløser email.opened- og email.clicked-webhooks og vises under Aktivitet.
Idempotens
Nettverksforsøk kan sende dobbelt. Send en unik idempotencyKey per logisk e-post, så returnerer Mailhuset det opprinnelige resultatet ved en gjentakelse, slik at det er trygt å prøve på nytt.
Feil
401 = feil/manglende nøkkel; 403 = from-domenet ikke verifisert eller sending ikke godkjent; 422 = valideringsfeil (svaret sier hvilket felt). Se Feilsøking.
Trenger du hjelp? Send e-post til support@mailhuset.com.