Mailchimp Integration - User Guide
Mailchimp integration allows you to automatically sync your PracBill customers with Mailchimp audiences for email marketing campaigns. This guide covers how to connect, configure, and manage the integration.
Overview
The Mailchimp integration provides:
Automatic Customer Sync - Keep your Mailchimp audience in sync with PracBill customers
Segment Builder - Create targeted segments based on customer data
Two-Way Status Sync - Unsubscribes in Mailchimp are reflected in PracBill
Activity Logging - Track all sync operations and troubleshoot issues
Getting Started
Prerequisites
Before connecting Mailchimp, you'll need:
A Mailchimp account (Free or paid plan)
A Mailchimp API key
Write access to the Mailchimp module in PracBill
Obtaining Your Mailchimp API Key
Log in to your Mailchimp account
Click your profile icon → Account & billing
Navigate to Extras → API keys
Click Create A Key
Copy the generated API key (you won't be able to see it again)
Security Note: Your API key provides full access to your Mailchimp account. Keep it secure and never share it publicly.
Connecting to Mailchimp
Step 1: Access the Mailchimp Module
Navigate to Mailchimp Integration in the main menu
You'll see the Connection Status panel
Step 2: Enter Your API Key
In the Connect to Mailchimp section, paste your API key
Click the Connect button
Wait for the connection to be verified
Step 3: Verify Connection
Once connected, you'll see:
✅ Connected status indicator
Your Mailchimp server prefix (e.g., us21)
Last sync timestamp
If connection fails, verify:
The API key is correct and not expired
Your Mailchimp account is active
You have the required permissions
Audience Management
What is an Audience?
A Mailchimp audience (formerly called a "list") is your collection of email subscribers. PracBill syncs customer data to a single primary audience per department.
Viewing Your Audience
Once connected, the Audience Overview panel displays:
Field | Description |
|---|---|
Audience Name | Name of your Mailchimp audience |
Member Count | Total subscribers in the audience |
Segments | Number of segments created |
Last Synced | When customers were last synced |
Creating an Audience
If you don't have an audience yet:
Click Create Audience
Fill in the required information:
Audience Name - A descriptive name (e.g., "Customer Newsletter")
From Name - Sender name for emails
From Email - Sender email address
Company - Your company name
Address - Physical mailing address (required by anti-spam laws)
Click Create
Note: You typically only need one audience. Use segments to target different customer groups.
Segment Builder
Segments let you target specific groups of customers based on their data in PracBill.
Creating a Segment
Click Create Segment in the Segments panel
Enter a Segment Name (e.g., "Active Customers - Victoria")
Add Filter Rules to define which customers are included
Filter Rules
Each filter rule consists of:
Component | Description |
|---|---|
Field | The customer attribute to filter on |
Operator | How to compare the value |
Value | The value to match (if required) |
Available Filter Fields
Field | Description | Example |
|---|---|---|
Company Name | Customer's company name | "Acme Corp" |
Customer's email address | Contains "@gmail.com" | |
City | City from address | Equals "Melbourne" |
State | State/province | Equals "VIC" |
Postcode | Postal/ZIP code | Starts with "3" |
Country | Country code | Equals "AU" |
Active/Inactive | Customer status flag | Equals "0" (active) |
Status | Customer status field | Equals "Active" |
Customer Type | Type classification | Equals "Business" |
Computed Filter Fields
These special fields perform calculations:
Field | Description | Example Value |
|---|---|---|
Created in Last N Days | Customers created recently | 30 |
Has Invoice in Last N Days | Customers with recent invoices | 90 |
Has Invoice in Last N Months | Customers with invoices in months | 6 |
Balance Greater Than | Customers with outstanding balance | 100 |
Filter Operators
Operator | Description | Requires Value |
|---|---|---|
Equals | Exact match | Yes |
Does Not Equal | Excludes exact match | Yes |
Contains | Partial text match | Yes |
Does Not Contain | Excludes partial match | Yes |
Greater Than | Numeric comparison | Yes |
Less Than | Numeric comparison | Yes |
Is Empty | Field has no value | No |
Is Not Empty | Field has a value | No |
Combining Multiple Rules
When you add multiple filter rules, customers must match ALL rules to be included in the segment (AND logic).
Example: To find active business customers in Victoria:
Rule 1: State Equals "VIC"
Rule 2: Customer Type Equals "Business"
Rule 3: Active/Inactive Equals "0"
Previewing a Segment
Before saving, you can preview which customers will be included:
Add your filter rules
Click Preview
View the customer count and sample customers
Adjust rules if needed
Editing a Segment
Click the Edit button (pencil icon) on any segment
Modify the name or filter rules
Use Preview to verify changes
Click Save
Deleting a Segment
Click the Delete button (trash icon) on the segment
Confirm the deletion
Warning: Deleting a segment is permanent and cannot be undone.
Syncing Customers
Automatic Sync
Customer data is automatically synced to Mailchimp during scheduled sync operations. The sync includes:
New customers added to the audience
Updated customer information (name, email, company)
Customer subscription status changes
Manual Sync Options
Sync Type | Description | When to Use |
|---|---|---|
Sync Now | Incremental sync of recent changes | Regular updates |
Full Sync | Re-syncs all customers | After bulk changes or troubleshooting |
Triggering a Manual Sync
Click Sync Now for incremental sync, or
Click Full Sync for complete re-sync
Wait for the sync to complete
Check the Sync Logs for results
Note: Full sync may take longer for large customer databases.
What Gets Synced
PracBill Field | Mailchimp Field |
|---|---|
Email Address | |
Company Name | COMPANY merge field |
First Name | FNAME merge field |
Last Name | LNAME merge field |
Phone | PHONE merge field |
Address | ADDRESS merge field |
Sync Logs
The Sync Logs panel shows a history of all sync operations.
Log Entry Fields
Field | Description |
|---|---|
Date | When the sync occurred |
Direction | Push (to Mailchimp) or Pull (from Mailchimp) |
Type | Incremental or Full sync |
Status | Success, Error, or Skipped |
Message | Details about the operation |
Status Indicators
Status | Meaning |
|---|---|
✅ Success | Sync completed without errors |
❌ Error | Sync failed - check message for details |
⏭️ Skipped | No changes to sync |
Troubleshooting Sync Issues
Common sync errors:
Error | Cause | Solution |
|---|---|---|
Invalid API key | API key expired or revoked | Generate a new API key in Mailchimp |
Rate limit exceeded | Too many API requests | Wait and try again later |
Invalid email | Customer has invalid email format | Fix the email in PracBill |
Compliance state | Email was previously unsubscribed | Cannot re-add without consent |
Disconnecting Mailchimp
If you need to disconnect the integration:
Click Disconnect in the Connection Status panel
Confirm the disconnection
Note: Disconnecting does not delete your Mailchimp audience or subscribers. It only removes the link between PracBill and Mailchimp.
Best Practices
Email List Hygiene
Regularly sync to keep your audience up-to-date
Remove inactive customers from segments
Honor unsubscribe requests (handled automatically)
Segment Strategy
Create segments for different campaign types
Use computed fields for engagement-based targeting
Test segments with Preview before sending campaigns
API Key Security
Never share your API key
Rotate keys periodically
Use a dedicated API key for PracBill
Permissions
Access to the Mailchimp module is controlled by user permissions:
Permission | Capabilities |
|---|---|
Read | View connection status, audiences, segments, and logs |
Read/Write | All read permissions plus: connect/disconnect, create/edit/delete segments, trigger syncs |
Contact your administrator if you need access to the Mailchimp module.
Frequently Asked Questions
How often does automatic sync run?
Automatic sync runs according to your system's cron schedule, typically every few hours. Check with your administrator for the exact frequency.
Can I sync to multiple Mailchimp audiences?
Currently, each PracBill department syncs to one primary Mailchimp audience. Use segments within that audience to organize subscribers.
What happens if a customer unsubscribes in Mailchimp?
Unsubscribe events are synced back to PracBill during pull operations. The customer's marketing consent status is updated accordingly.
Why isn't my segment showing any customers?
Check your filter rules:
Ensure the values are spelled correctly
Try using "Contains" instead of "Equals" for partial matches
Use Preview to test individual rules
Can I import existing Mailchimp subscribers?
The integration syncs customers from PracBill to Mailchimp. To import existing Mailchimp subscribers, use Mailchimp's import tools directly.
Support
If you encounter issues with the Mailchimp integration:
Check the Sync Logs for error messages
Verify your API key is valid
Ensure you have the required permissions