Quick Start Guide
Get up and running with ContactList in just a few minutes. This guide will walk you through the essential steps to start using ContactList.
Prerequisites
Before you begin, make sure you have:
- A ContactList account (sign up at dashboard.contactlist.io)
- Access to your dashboard
Step 1: Create Your Account
Visit the ContactList dashboard and create your free account. You'll receive a confirmation email to verify your account.
Step 2: Select a Plan
Choose the plan that best fits your needs:
- Free Plan: 0 active forms, 0 collections, 0 email lists, limited features
- Pro Plan: 10 active forms, 5 collections, unlimited email lists, 1 million data records, 10 active campaigns
- Enterprise Plan: Unlimited everything, priority support, custom integrations
Step 3: Create Your Workspace
Workspaces are like project folders that organize all your data. Each workspace is completely isolated:
- Forms belong to a workspace
- Email lists belong to a workspace
- Data collections belong to a workspace
- Campaigns belong to a workspace
You can create multiple workspaces for different projects, clients, or departments.
Step 4: Configure Email Service
Before sending emails, you must configure an email service. You can use either SMTP or Resend.
SMTP Setup
- Go to Email Settings
- Enter SMTP details:
- Host (e.g., smtp.gmail.com)
- Port (587 for TLS, 465 for SSL)
- Username (your email)
- Password (app password)
- Test connection
- Save
Resend Setup
- Get API key from Resend
- Enter in Email Settings
- Test connection
- Save
Quick Start Guides
Creating Your First Form
- Navigate to Forms in the sidebar
- Click "Create Form"
- Enter form title and description
- Drag fields from the left sidebar onto the canvas
- Configure field properties (label, required, validation)
- Set form status to "Active"
- Click "Share" to get the form URL
- Share the link or embed on your website
Creating Your First Email Campaign
- Navigate to Email Lists and create a list
- Add subscribers manually or import from CSV
- Go to Email Campaigns → "New Campaign"
- Select your email list or segment
- Use the email builder to design your email
- Add variables like
{{firstName}}for personalization - Set subject line and sender information
- Click "Send Now" or schedule for later
- View analytics after sending
Setting Up API Collections
- Navigate to Data Lake → "New Collection"
- Define your collection schema (add fields)
- Set field types and validation rules
- Save the collection
- Go to "API Keys" tab and create an API key
- Use the API endpoint to submit data:
POST https://api.contactlist.io/api/v1/submit Authorization: Bearer YOUR_API_KEY Content-Type: application/json { "collectionId": "your_collection_id", "data": { "field1": "value1" } }
Core Concepts
Variables in Emails
Use variables to personalize emails:
{{firstName}}- Subscriber's first name{{email}}- Subscriber's email{{lastName}}- Subscriber's last name{{variableName}}- Custom variables from metadata or external databases
Variables are automatically replaced when emails are sent.
Segmentation
Segments are dynamic groups of subscribers based on conditions:
Example Segments:
- Subscribers with tag "vip"
- Subscribers who opened last campaign
- Subscribers in "Premium" group
- Subscribers with email containing "@company.com"
- Subscribers who clicked a specific link
Segments automatically update as subscriber data changes.
Next Steps
Congratulations! You're ready to start using ContactList. For more detailed information, check out:
- Installation & Setup - Detailed setup instructions
- API Reference - Complete API documentation
- Guides - Comprehensive feature guides
- Best Practices - Tips and recommendations