curl --request POST \
--url https://api.sendbaze.com/v1/emails \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"from": "Yourshop <orders@yourshop.co.za>",
"to": [
"thandi@example.com"
],
"replyTo": "help@yourshop.co.za",
"subject": "Your order #1042 has shipped",
"html": "<p>Tracking: <b>CG123456789ZA</b></p>",
"text": "Tracking: CG123456789ZA",
"tags": [
"order-shipped"
]
}
'{
"id": "em_01j9x7k2r4m8q3v5n6b7c8d9e0",
"status": "queued",
"mode": "live"
}{
"error": {
"code": "validation_error",
"message": "<string>",
"docs": "<string>",
"fields": {},
"limit": 123,
"upgradeUrl": "<string>",
"topUpUrl": "<string>",
"settingsUrl": "<string>",
"domainsUrl": "<string>"
}
}{
"error": {
"code": "domain_not_verified",
"message": "yourshop.co.za is not a verified sending domain of this organisation.",
"docs": "https://docs.sendbaze.com/errors#domain_not_verified"
}
}{
"error": {
"code": "payload_too_large",
"message": "Attachments may be at most 3 MB in total.",
"docs": "https://docs.sendbaze.com/errors#payload_too_large"
}
}{
"error": {
"code": "validation_error",
"message": "The request has invalid fields.",
"docs": "https://docs.sendbaze.com/errors#validation_error",
"fields": {
"to.1": [
"must be a valid email address"
]
}
}
}{
"error": {
"code": "validation_error",
"message": "<string>",
"docs": "<string>",
"fields": {},
"limit": 123,
"upgradeUrl": "<string>",
"topUpUrl": "<string>",
"settingsUrl": "<string>",
"domainsUrl": "<string>"
}
}{
"error": {
"code": "validation_error",
"message": "<string>",
"docs": "<string>",
"fields": {},
"limit": 123,
"upgradeUrl": "<string>",
"topUpUrl": "<string>",
"settingsUrl": "<string>",
"domainsUrl": "<string>"
}
}Emails
Send an email
Validates the request, stores the message, queues it and returns the id. Requires the emails:send scope
and, for live keys, a verified sending domain, or the shared test address onboarding@sendbaze.com, which
delivers to your organisation’s own addresses only (100 emails per organisation in total). Add an
Idempotency-Key header to make retries safe.
POST
/
v1
/
emails
curl --request POST \
--url https://api.sendbaze.com/v1/emails \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"from": "Yourshop <orders@yourshop.co.za>",
"to": [
"thandi@example.com"
],
"replyTo": "help@yourshop.co.za",
"subject": "Your order #1042 has shipped",
"html": "<p>Tracking: <b>CG123456789ZA</b></p>",
"text": "Tracking: CG123456789ZA",
"tags": [
"order-shipped"
]
}
'{
"id": "em_01j9x7k2r4m8q3v5n6b7c8d9e0",
"status": "queued",
"mode": "live"
}{
"error": {
"code": "validation_error",
"message": "<string>",
"docs": "<string>",
"fields": {},
"limit": 123,
"upgradeUrl": "<string>",
"topUpUrl": "<string>",
"settingsUrl": "<string>",
"domainsUrl": "<string>"
}
}{
"error": {
"code": "domain_not_verified",
"message": "yourshop.co.za is not a verified sending domain of this organisation.",
"docs": "https://docs.sendbaze.com/errors#domain_not_verified"
}
}{
"error": {
"code": "payload_too_large",
"message": "Attachments may be at most 3 MB in total.",
"docs": "https://docs.sendbaze.com/errors#payload_too_large"
}
}{
"error": {
"code": "validation_error",
"message": "The request has invalid fields.",
"docs": "https://docs.sendbaze.com/errors#validation_error",
"fields": {
"to.1": [
"must be a valid email address"
]
}
}
}{
"error": {
"code": "validation_error",
"message": "<string>",
"docs": "<string>",
"fields": {},
"limit": 123,
"upgradeUrl": "<string>",
"topUpUrl": "<string>",
"settingsUrl": "<string>",
"domainsUrl": "<string>"
}
}{
"error": {
"code": "validation_error",
"message": "<string>",
"docs": "<string>",
"fields": {},
"limit": 123,
"upgradeUrl": "<string>",
"topUpUrl": "<string>",
"settingsUrl": "<string>",
"domainsUrl": "<string>"
}
}Authorizations
An API key from the dashboard. sk_live_… sends; sk_test_… validates and returns ids without sending.
Headers
Up to 255 characters. The same key and body return the same response for 24 hours.
Maximum string length:
255Body
application/json
A bare address or Name <address> on a verified domain, or the shared test address onboarding@sendbaze.com (own addresses only).
Example:
"Yourshop <orders@yourshop.co.za>"
One address or up to 50.
One address or up to 50.
One address or up to 50.
Required unless templateId is set, in which case it overrides the template's subject.
Maximum string length:
998HTML body, up to 2 MB. One of html, text or templateId is required.
Plain-text body, up to 2 MB.
Render a template (its current version) instead of passing html or text.
String, number or boolean values keyed by placeholder name.
Show child attributes
Show child attributes
Up to 10 files, 3 MB decoded in total.
Maximum array length:
10Show child attributes
Show child attributes
Custom headers. Standard headers such as From, To and Subject cannot be overridden.
Show child attributes
Show child attributes
Maximum array length:
10Maximum string length:
64Available options:
transactional, marketing