Dokumentasjon › Send e-post via API-et

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 }`.
`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 Activity 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" }
}

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.