Getting Started

Welcome to FormaMail! This guide will help you get up and running in just a few minutes.

What You’ll Learn

• How to create an account and set up your team
• How to generate your first API key
• How to send your first email
• Next steps after getting started

Step 1: Create an Account

1. Visit https://app.formamail.com/signup
2. Enter your email address and create a strong password
3. Click Create Account
4. Check your email for the verification link
5. Click the verification link to activate your account

Step 2: Complete Your Profile

After creating your account, you’ll be guided through a quick onboarding:

1. Company Information: Enter your company name and role
2. Team Size: Select your team size
3. Use Case: Tell us how you plan to use FormaMail

This helps us customize your experience!

Step 3: Create Your First API Key

API keys are required to send emails programmatically.

Via Dashboard:

1. Navigate to Settings → API Keys
2. Click Create New API Key
3. Give it a descriptive name (e.g., “Production Key”)
4. Select the permissions you need:
   • ✅ Send Emails
   • ✅ Manage Templates
   • ✅ View Analytics
5. Click Create Key

Example API Key:

fm_sk_abc123xyz456...

Store this securely in your environment variables:

# .env
FORMAMAIL_API_KEY=fm_sk_abc123xyz456...

Step 4: Send Your First Email

Now let’s send your first email using the API!

Quick Test with API Playground

Use our API Playground for the easiest way to test:

1. Go to API → Playground
2. Select the Send Email endpoint
3. Choose a template from the dropdown
4. Fill in the recipient email and variables
5. Click Send Request

You should receive the email within seconds!

Using cURL

curl -X POST https://api.formamail.com/api/emails/send \
  -H "Authorization: Bearer fm_sk_abc123xyz456..." \
  -H "Content-Type: application/json" \
  -d '{
    "templateId": "your-template-id",
    "to": [
      {
        "email": "recipient@example.com",
        "name": "John Doe"
      }
    ],
    "variables": {
      "firstName": "John",
      "message": "Hello from FormaMail!"
    }
  }'

Using JavaScript/TypeScript

async function sendEmail() {
  const response = await fetch('https://api.formamail.com/api/emails/send', {
    method: 'POST',
    headers: {
      'Authorization': 'Bearer fm_sk_abc123xyz456...',
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      templateId: 'your-template-id',
      to: [
        {
          email: 'recipient@example.com',
          name: 'John Doe'
        }
      ],
      variables: {
        firstName: 'John',
        message: 'Hello from FormaMail!',
      },
    }),
  })
 
  const data = await response.json()
  console.log('Email sent:', data)
}
 
sendEmail()

Step 5: Create Your First Template

Templates allow you to create reusable email designs:

1. Navigate to Templates → Create New Template
2. Choose Email Template
3. Use the drag-and-drop designer to create your layout
4. Add variables like {{name}} and {{companyName}}
5. Click Save and Publish

Now you can use this template when sending emails!

Next Steps

Now that you’ve sent your first email, here’s what to explore next:

🎨 Design Templates

Learn how to create beautiful email templates with our visual designer.

👉 Template Designer Guide

📊 Track Performance

Monitor email opens, clicks, and delivery status.

👉 Analytics Guide

🔌 API Integration

Integrate FormaMail into your application.

👉 API Reference

📎 Generate Attachments

Create PDF invoices and Excel reports from templates.

👉 Attachment Guide

Common Questions

How many emails can I send?

You get 1,000 free emails when you sign up (no credit card required). After that, you can purchase email credits in blocks - 1 block = 10,000 emails. Credits never expire! Check our Pricing Page for volume discounts.

Can I use my own domain?

Yes! You can configure a custom sending domain in Settings → Domains.

Where can I view sent emails?

All sent emails are visible in Email Logs with detailed status information.

Do you support attachments?

Yes! You can attach files or generate PDFs/Excel files from templates.

Need Help?

• 📖 User Guide
• 💻 Developer Guide
• 📚 API Reference
• 💬 Discord Community
• 📧 support@formamail.com

Ready to dive deeper? → User Guide