/v5/campaign/mail/sends endpoint lets you compose a campaign, target lists, apply exclusions, schedule delivery, and optionally save a draft without sending — all through a single API call.
Workflow overview
Before sending a campaign, you need contacts organised into lists inside EffiLink. The typical workflow is:- Import contacts — Upload or sync your contacts into EffiLink. See Contacts for how to create and manage contact lists.
- Target lists with
sendListNames— Specify one or more list names to receive the campaign. - Compose and send — Provide your email content (or a template), set a sender, and call the endpoint.
Send a campaign
Required parameters
Optional parameters
Scheduling a campaign
SetsendDate to an ISO 8601 UTC timestamp to schedule the campaign for future delivery. Omit or leave empty to send immediately.
A/B test campaigns can be scheduled up to 30 days in the future. Standard campaign sends should be scheduled as close to your intended delivery time as practical.
Saving a draft without sending
PassonlySave: true to save the campaign configuration without dispatching any emails. This is useful for building drafts via the API for later review or launch via the EffiLink dashboard.
onlySave is true, sendListNames is not required.
Excluding contacts with repelListNames
Use repelListNames to specify one or more contact lists whose members should be excluded from receiving the campaign, even if they also appear in a targeted list. This is useful for suppressing recently-converted customers, unsubscribed users, or any segment you want to protect from a particular send.
sendListNames.
A/B testing
EffiLink supports A/B testing for campaign emails, allowing you to compare subject lines, content variants, or sender names across a portion of your audience before sending the winning variant to the remainder. A/B test parameters are configured at the campaign level. For the full schema — including split percentages, winning criteria, and wait periods — refer to the Campaign Sends API reference.Attaching a file
Attach a single file to your campaign email using theattachment object. File content must be base64-encoded.
Next steps
- Manage contact lists — Import and segment your audience
- Campaign Sends API reference — Full parameter schema, A/B test options, and response details
- Sandbox Mode — Validate your campaign request without sending
- Email Tracking — Track opens and clicks for your campaign