Quick Start
POST
/api/v1/campaigns/submit
Submit a new email campaign with leads and automated sequences. Perfect for sales outreach, marketing campaigns, and customer engagement.
Key Validation Rules
- Schedule: Valid IANA timezone, unique days, HH:MM time format, start_time < end_time
- Leads: No duplicate emails, LinkedIn URLs must start with http(s):// and contain 'linkedin.com'
- Attributes: Keys must be alphanumeric with _ or - only (max 100 chars). Reserved keys: id, customer_id, email, first_name, last_name, company, company_name, linkedin_url, created_at, updated_at
- Sequence: Steps must be sequential (1, 2, 3...) with no gaps or duplicates
- Variants: Automatically labeled A, B, C based on array position. 'new' type requires at least 1 subject line (max 200 chars). 'thread' type inherits subject from parent and supports only 1 variant (no A/B testing for follow-ups)
Example Request
curl -X POST https://beam.lightmeter.io/api/v1/campaigns/submit \
-H "Authorization: Bearer your_api_key_here" \
-H "Content-Type: application/json" \
-d '{
"campaign_name": "Product Launch Outreach",
"schedule": {
"timezone": "America/New_York",
"days": ["Mon", "Tue", "Wed", "Thu", "Fri"],
"daily_start_time": "09:00",
"daily_end_time": "17:00"
},
"leads": [
{
"email": "contact@example.com",
"first_name": "Alex",
"last_name": "Johnson",
"company_name": "TechCorp Inc",
"contact_linkedin_url": "https://linkedin.com/in/alexjohnson",
"account_linkedin_url": "https://linkedin.com/company/techcorp",
"attributes": {
"job_title": "VP of Engineering",
"industry": "Technology",
"custom_note": "Interested in automation tools"
}
}
],
"sequence": [
{
"step": 1,
"type": "new",
"variants": [
{
"subject": ["Quick question for {{first_name}}"],
"body": "Hi {{first_name}}, I noticed your recent work at {{company_name}}..."
}
]
}
]
}'
