SparkMailer Documentation

Complete guides, tutorials, and API reference for our enterprise-grade email marketing platform. Everything you need to build, send, and optimize your email campaigns.

150+
Articles & Guides
50+
API Endpoints
24/7
Updated

Introduction to SparkMailer

Learn about our platform and its capabilities

SparkMailer is an enterprise-grade email marketing platform that combines powerful automation with AI-driven optimization. Whether you're sending simple newsletters or complex automated sequences, SparkMailer provides the tools you need to succeed.

Quick Setup

Get started in minutes with our intuitive interface and comprehensive onboarding guides.

AI-Powered

Leverage artificial intelligence for content generation, optimization, and performance insights.

Advanced Analytics

Track engagement, conversions, and ROI with detailed analytics and reporting.

Quick Start Guide

Get up and running in 15 minutes

1

Create Your Account

Sign up for a SparkMailer account and verify your email address. Choose the plan that best fits your needs.

bash 
# Visit our website to sign up
https://sparkmailer.app/register
# Or use our API to create an account programmatically
curl -X POST https://api.sparkmailer.app/v1/accounts \
  -H "Content-Type: application/json" \
  -d '{
    "email": "your@email.com",
    "password": "secure_password",
    "plan": "starter"
  }'
2

Verify Your Domain

Add DNS records to authenticate your domain and improve email deliverability.

dns 
# Add these DNS records to your domain
Type: TXT
Name: @
Value: "sparkmailer-verification=abc123def456"

Type: CNAME
Name: sparkmailer._domainkey
Value: dkim.sparkmailer.app
3

Import Your Contacts

Upload your contact list or integrate with your existing CRM.

javascript 
// Using the JavaScript SDK
const sparkmailer = require('sparkmailer-sdk');

const client = new sparkmailer.Client({
  apiKey: 'your_api_key_here'
});

// Import contacts from CSV
const result = await client.contacts.importFromCsv({
  file: 'contacts.csv',
  listId: 'your_list_id'
});
4

Send Your First Campaign

Create and send an email campaign using our drag-and-drop builder or API.

python 
import sparkmailer

client = sparkmailer.Client(api_key='your_api_key_here')

campaign = client.campaigns.create({
    'name': 'Welcome Campaign',
    'subject': 'Welcome to Our Service!',
    'from_name': 'Your Company',
    'from_email': 'hello@yourcompany.com',
    'content': '
Welcome!
Thanks for joining us.
',
    'list_id': 'your_list_id'
})

# Send immediately
client.campaigns.send(campaign['id'])

API Reference

Complete API documentation for developers

Base URL

All API requests should be made to the following base URL:

https://api.sparkmailer.app/v1

Authentication

Authenticate your API requests using your API key in the Authorization header:

http 
Authorization: Bearer your_api_key_here

Campaigns API

GET /campaigns

Retrieve a list of all campaigns in your account.

Parameters

Parameter Type Required Description
page integer optional Page number for pagination
limit integer optional Number of campaigns per page (max: 100)

Response

json 
{
  "data": [
    {
      "id": "camp_123",
      "name": "Welcome Campaign",
      "status": "sent",
      "created_at": "2024-01-15T10:30:00Z",
      "sent_at": "2024-01-15T11:00:00Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 45
  }
}
POST /campaigns

Create a new email campaign.

Parameters

Parameter Type Required Description
name string required Campaign name
subject string required Email subject line
list_id string required ID of the contact list to send to

AI Content Generation

Leverage AI to create compelling email content

SparkMailer's AI content generator helps you create engaging email content in seconds. Use our AI to generate subject lines, body content, and calls-to-action that resonate with your audience.

javascript 
// Generate AI content for your campaign
const aiContent = await client.ai.generateContent({
  prompt: "Create a welcome email for new subscribers",
  tone: "friendly",
  length: "medium",
  include_subject: true,
  include_cta: true
});

console.log(aiContent);
// {
//   subject: "Welcome to the Family! Here's What to Expect",
//   body: "Hi [First Name],\n\nWe're thrilled to have you join our community...",
//   cta: "Get Started Now"
// }

Need Help?

We're here to support you

Community Forum

Join our community of developers and marketers to share knowledge and get help.

Join Forum

Email Support

Get personalized help from our support team. Response within 24 hours.

Email Us

Video Tutorials

Watch step-by-step video guides covering all SparkMailer features.

Watch Tutorials