BizKitHub Developer Documentation

Parameters

1 query · JSON body

Query parameters

· 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

ExamplePRODPGrFxpGEtrOZfuWhnoJohUYBXuOE

Request body

application/json

subjectstringRequired

Email subject line.

ExampleOrder confirmation #12345

fromstringOptional

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

Examplesupport@example.com

tostringRequired

Recipient email address.

Examplecustomer@example.com

ccstringOptional

CC recipient email address.

bccstringOptional

BCC recipient email address.

replyTostringOptional

Reply-To email address.

prioritynumberOptional

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

Examples1510

notestringOptional

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

htmlBodystringOptional

HTML content of the email body.

tagstringOptional

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

Examplesorder-confirmationnewsletter

forceSendNowbooleanOptional

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

attachmentListobject | object | object[]Optional

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

Each array item:

object | object | object

One of 3:

Variant 1

blobTokenstringRequired

Token of a file stored in blob storage.

Variant 2

attachmentUrlstringRequired

Public URL of the file to attach.

Variant 3

rawTextContentstringRequired

Raw text content to attach as a file.

Response schema

1 status code documented

200Success

success"true"Required

Response example

application/json

{
  "success": true
}

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": [] }'

/api/v1/emailer/send

Parameters

Query parameters

Request body

Response schema

Response example

Request example

Need an API key?