Skip to main content
Marketing campaign emails are bulk messages sent to one or more contact lists — newsletters, product announcements, promotional offers, re-engagement sequences, and similar outbound communications. Unlike transactional email, campaign sends are audience-driven: you define who receives the message by targeting named contact lists in your EffiLink account. The /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:
  1. Import contacts — Upload or sync your contacts into EffiLink. See Contacts for how to create and manage contact lists.
  2. Target lists with sendListNames — Specify one or more list names to receive the campaign.
  3. Compose and send — Provide your email content (or a template), set a sender, and call the endpoint.

Send a campaign

A successful response returns:

Required parameters

Optional parameters


Scheduling a campaign

Set sendDate 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

Pass onlySave: 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.
When 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.
Exclusion is applied server-side before sending — contacts on a repel list will not receive the email regardless of overlap with 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 the attachment object. File content must be base64-encoded.

Next steps