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

/api/v1/emailer/send

API endpoint documentation

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
fromstring
tostringrequired
ccstring
bccstring
replyTostring
prioritynumber
notestring
htmlBodystring
tagstring
forceSendNowboolean
attachmentListobject | object | object[]

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": "example_subject",
    "from": "example_from",
    "to": "example_to",
    "cc": "example_cc",
    "bcc": "example_bcc",
    "replyTo": "example_replyTo",
    "priority": 0,
    "note": "example_note",
    "htmlBody": "example_htmlBody",
    "tag": "example_tag",
    "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": "example_subject",
  "from": "example_from",
  "to": "example_to",
  "cc": "example_cc",
  "bcc": "example_bcc",
  "replyTo": "example_replyTo",
  "priority": 0,
  "note": "example_note",
  "htmlBody": "example_htmlBody",
  "tag": "example_tag",
  "forceSendNow": false,
  "attachmentList": [
    []
  ]
}'

Need an API key?

All BizKitHub API endpoints require authentication via API key.

Get API Key