BizKitHub
DocsInteractive API Docs/api/v1/emailer/send
post

/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.

Endpoint Info
Base URLapi.bizkithub.com
AuthBearer Token
Methods1
Authentication Required

This endpoint requires a valid API key passed as a query parameter or Bearer token.

Get your API key

Parameters

1 query, 12 body parameters

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

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.

Example Request

JavaScript fetch

const response = await fetch("https://api.bizkithub.com/api/v1/emailer/send?apiKey=PRODPGrFxpGEtrOZfuWhnoJohUYBXuOE", {
  method: "POST",
  headers: {
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "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": [
      []
    ]
  })
});

const data = await response.json();
console.log(data);
post

Example Response

200Success
{
  "success": true
}

cURL

Command line example

curl -X POST "https://api.bizkithub.com/api/v1/emailer/send?apiKey=PRODPGrFxpGEtrOZfuWhnoJohUYBXuOE" \
  -H "Content-Type: application/json" \
  -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": [
    []
  ]
}'

Need an API key?

All BizKitHub API endpoints require authentication via API key.

Get API Key
Back to API DocumentationAPI Reference