Email campaigns
Add every matching lead to an email campaign automatically.
Authenticated with ?privateKey=YOUR_KEY (see Authentication).
| POST | /admin/automations | Create a new automation |
| GET | /admin/automations | Get all automations for a website |
| PATCH | /admin/automations/{id} | Enable or disable an automation |
| GET | /admin/email-campaigns | Get all email campaigns for a website |
POST
/admin/automationsTry:
Request body
NameName of the automation
Is ActiveWhether automation is active
WebsiteWebsite ID this automation belongs to
FilterFilter criteria for leads
Trigger
WhenEvent that triggers the automation
ThenAction to perform
Interval
Contact Persona
Roles
Excluded Roles
Email Verification
Allow Only Valid Emails
Allow Catch All Emails
Allow Guessed Emails
Allow Without Emails
Contact Selection Strategy
Max Contacts To Send
ActionsAction-specific configurations
Sent To Slack
Send Messages ToSlack channel, e.g.
Message TemplateMessage with merge fields such as {{name}} and {{company}}; empty uses the saved template
How Many To Add
Sent To Webhook
Url
When To Push
Send To Clay
UrlThe webhook URL of your Clay table
When To Push
Sent To Email Campaign
Email CampaignCampaign ID from GET /admin/email-campaigns
Email Accounts
Sent To Hubspot
Action
Assign Contacts ToOwner ID from GET /v3/crm/owners
Sent To Pipedrive
Assign Contacts To
Sent To Salesforce
Assign Contacts To
Sent To Zoho
Assign Contacts To
Sent To Go High Level
Assign Contacts To
Create Opportunity
Pipeline Id
Pipeline Stage Id
Opportunity Status
Tags
curl -X POST "https://rest-admin.happierleads.com/admin/automations?privateKey=YOUR_KEY" \ -H "Content-Type: application/json" \ -d '{ "name": "Docs example: send-to-emailCampaign", "isActive": true, "website": "64b7f0a1c2d3e4f5a6b7c8d9", "when": "new-lead-is-identified", "then": "send-to-emailCampaign", "interval": "immediately", "actions": { "sentToEmailCampaign": { "emailCampaign": "6a3f00000000000000000004" } }}'Response
Press Send request to try it with sample data.
Use case: Find the campaign
GET /admin/email-campaigns lists your campaigns; use one's _id as emailCampaign.