Logo

Superx Mailer®

Developer Hub

Developer API Console

Verify your purchased developer keys, explore implementation code, and execute live test outbound dispatches.

Verify API Key

Input your Developer API Key purchased from our portal. Valid keys enable server-to-server outbound email dispatches.

Unverified Console

Please enter your purchased API key to load active metadata and enable tester tools.

Integration Code

Copy copy-pasteable snippets. Once your API Key is verified above, it will dynamically populate directly in the code! 

Loading snippet...

Live Email Dispatch Tester

Test your Developer API Key by sending outbound mailer emails instantly. Enter your API Key and email content below to dispatch a live transaction through the default testing SMTP server.

Execution Console Log
> Ready for execution. Prefill configuration and trigger 'Run Outbound Test' to start dispatch lifecycle.

Developer Reference Manual

Here is the technical specification of the outbound email dispatch API endpoint. Use this reference when building integrations.

POST /api/send-email

Headers

Header Type Required Description
Content-Type string Yes Must be set to application/json.
x-api-key string No * Your Developer API Key. * Required if not passed inside the JSON body payload.

Request Payload (JSON Body)

Field Type Required Description
apiKey string No * Developer API Key. Required if not provided in the x-api-key request header.
to string Yes Recipient email address. Must be a valid email format.
subject string Yes Subject header of the outbound email.
html string Yes The markup body content. Supports HTML formatting.
senderEmail string No Outbound SMTP account email address. Falls back to default system testing SMTP credentials if omitted.
senderPass string No SMTP password or app-specific password. Falls back to default system testing SMTP credentials if omitted.
smtpHost string No Hostname of SMTP server. Falls back to default system testing SMTP credentials if omitted.
smtpPort number No Outbound connection port. Falls back to default system testing SMTP credentials if omitted.
senderName string No Display name. E.g. "Superx Corporation Support".
smtpSecure boolean No Force SSL/TLS authentication. Defaults to true if port is 465.

Response Specifications

Success (200 OK)
{
  "success": true,
  "messageId": ""
}
Error (400 / 402 / 500)
{
  "success": false,
  "error": "Reason description"
}