/api/v1/emailer/send

Queues or immediately sends an email through the organisation mail system. Supports HTML body, attachments (from blob storage, URL, or raw text), and priority control.

emailerpostApiV1EmailerSend

Parameters

1 query · 12 body

13 total

Query · 1

apiKeystringRequired

Your BizKitHub API key (passed as GET parameter).

Key format: A 32-character string matching: ^(PROD|DEV_|ROOT)[A-Za-z0-9]{28}$
Prefixes: PROD (production key), DEV_ (individual developer), ROOT (system key with no limits). Learn more

Body · 12

subjectstringRequired

Email subject line.

fromstring

Sender email address or name+email. If omitted, organisation default is used.

tostringRequired

Recipient email address.

ccstring

CC recipient email address.

bccstring

BCC recipient email address.

replyTostring

Reply-To email address.

prioritynumber

Email priority (lower = higher priority). Default queue priority if omitted.

notestring

Internal note attached to the email record (not sent to recipient).

htmlBodystring

HTML content of the email body.

tagstring

Tag for categorizing the email (e.g. for analytics).

forceSendNowboolean

If true, send immediately bypassing the queue. Default: false.

attachmentListobject | object | object[]

List of attachments. Each item is one of blobToken, attachmentUrl, or rawTextContent.

Request

POST /api/v1/emailer/send

post

curl -X POST "https://api.bizkithub.com/api/v1/emailer/send?apiKey=PRODPGrFxpGEtrOZfuWhnoJohUYBXuOE" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "subject": "Order confirmation #12345",
  "from": "support@example.com",
  "to": "customer@example.com",
  "cc": "example_cc",
  "bcc": "example_bcc",
  "replyTo": "example_replyTo",
  "priority": 1,
  "note": "example_note",
  "htmlBody": "example_htmlBody",
  "tag": "order-confirmation",
  "forceSendNow": false,
  "attachmentList": []
}'

Response

JSON payload

{
  "success": true
}

All response codes

1 status code documented

Need an API key?

All BizKitHub API endpoints require authentication via API key.

Get API Key