Email Schedules - SMB Sales Boost API

Set up automated email delivery of leads matching your saved filters. Configure delivery frequency, filter presets, export format preferences, and multi-recipient splitting.

Endpoints

GET /api/v1/email-schedules: List all your email export schedules.
POST /api/v1/email-schedules: Create a new email schedule. Requires name, filterPresetId, intervalValue (a whole number from 1 to 720), intervalUnit and recipients. isActive defaults to true: an active schedule sends its first email within about 15 minutes; send false to create it paused.
PATCH /api/v1/email-schedules/:id: Update an existing email schedule. All fields are optional; intervalValue must be a whole number from 1 to 720.
DELETE /api/v1/email-schedules/:id: Delete an email schedule by ID.
POST /api/v1/email-schedules/:id/trigger: Manually trigger an active email schedule to send immediately. A send that is not finished within about 75 seconds answers 202 Accepted with a jobId and keeps running; GET /api/v1/jobs/{jobId} then returns this response (kept for up to 24 hours). Send an Idempotency-Key header: repeating the request with the same key returns the same send instead of sending again (the key is kept with the job for up to about 48 hours; a server restart forgets it, so then check lastSent first), and triggering the same schedule while a trigger of it is still running returns that job. A 409 schedule_run_in_progress means the schedule's regular run is sending it right now: nothing was sent, so check lastSent when it finishes and trigger it again only if needed.

Schedule Object Fields

Each schedule includes: id, name, filterPresetId, exportFormatId, intervalValue, intervalUnit, isActive, pauseReason (null, "user", or "insufficient_credits"), recipients (array of objects with email and optional splitParts), distributionMode, fullCopyRecipients, maxLeadsPerEmail, lastSent, totalSentCount, createdAt.

Max Leads Per Email

maxLeadsPerEmail (optional, 1-100,000, null for no cap) limits how many leads one email carries. New leads that do not fit, and new leads your credits could not cover, are kept in the lead reservoir (one pool per account, shared by your schedules and API exports, up to your plan's monthly credit allowance; when it is full, more leads are not kept) and sent with a later email. On credit plans, leads you already received that do not fit are not kept. Schedules pause only when no credits are left to spend.

Combined File Feature

When file splitting is enabled, you can configure a combined file that includes an assignee column and file name column, sent to dedicated combined recipients.

API Documentation Sections

View Full API Documentation

Ready to Find Your Next Customers? Get access to growing local business leads updated every 5 minutes. See plans starting at $49/mo →