Send email
Send email through API
POST
https://api.mailhub.sh/v1/send
Headers
Name
Value
Content-Type
application/json
Authorization
Bearer <token>
Body
Name
Type
Required
Comment
from
string
Yes
to
string | string[]
Yes
subject
string
Yes
bcc
string[]
No
cc
string[]
No
reply_to
string[]
No
layout_identifier
string
Yes/No
Layout or page identifier
Eg. tp-xxxxxx
Can't be used with code
parameter
code
string
Yes/No
HTML Code you want to send
Can't be used with layout_identifier
parameter
text
string
No
tags
object[]
{
name: string
}
No
attachments
object[]
{
filename: string, // (optional)
content: string | Buffer, //(optional)
path: string, //(optional)
contentType: string, //(optional)
}
No
Example (payload)
{
"layout_identifier": "string", // The identifier of the layout used for generating the email (e.g., "welcome-email")
"language": "string", // ISO language code, e.g., "en", "fr"
"variables": {
"name": "John Doe"
// Any dynamic variables used in the template (e.g., { "order_id": "12345" })
},
"code": null, // Always null when using layout_identifier; can contain raw HTML if no layout is used (Tailwind compatible)
"from": "string", // Sender email address
"to": "string", // Recipient email address
"subject": "string" // Email subject line
}
Example (request)
curl -X POST "https://api.mailhub.sh/v1/send" \
--header "Authorization: Bearer <<YOUR_API_KEY_HERE>>" \
--header "Content-Type: application/json" \
--data '{
"layout_identifier": "<<YOUR_LAYOUT_ID>>",
"variables": {},
"code": null,
"from": "Example <[email protected]>",
"to": "[email protected]",
"subject": "hello world",
...
}'
Last updated