Campaign Email Sends — POST /v5/campaign/mail/sends

Overview

The Campaign Sends API lets you manage the full lifecycle of a campaign email send task — from creation and scheduling to retrieval, cancellation, and deletion. All endpoints require authentication via an ApiKey or OAuth header. Base URL: https://api.effilink.co

Create Send Task

string

/v5/campaign/mail/sends

Creates a new campaign email send task. The task can be saved immediately without sending, scheduled for a future time, or dispatched right away.

Request Parameters

string

required

The name of the send task. Maximum 200 bytes. Must be unique within your team.

string

required

The verified sender email address. Must be an address already verified in your EffiLink account.

string

The display name shown to recipients in the “From” field.

string

The email subject line. Supports personalization tags (e.g., {{firstName}}).

string

The HTML body content of the email. Supports personalization tags.

string

Scheduled send time in ISO 8601 UTC format (e.g., 2025-06-01T10:00:00Z). Omit to send immediately.

boolean

Set to true to save the task as a draft without sending. When true, sendListNames is not required. Defaults to false.

array[string]

An array of target contact list names. Required unless onlySave is true.

["Newsletter Subscribers", "VIP Customers"]

array[string]

An array of exclusion contact list names. Recipients on these lists will be excluded from the send.

string

The reply-to email address. If omitted, replies go to senderMail.

object

A single file attachment to include with the email.

Show attachment properties

string

required

The filename, including extension (e.g., report.pdf).

string

required

The Base64-encoded content of the file.

string

The language code for the email. Controls locale-aware rendering.Accepted values: zh-cn, en, ja, ko, de, tt, es, zh-tw, ar, pt-br, id

string

Associates this send task with a named marketing activity.

string

Associates this send task with a named subscription.

string

Associates this send task with a project. If the project does not exist, it will be created automatically.

string

The editor type used to compose the email. Defaults to DRAG.

Value	Description
`DRAG`	Drag-and-drop visual editor (default)
`CLASSIC`	HTML code editor

boolean

Set to true to run in sandbox mode. Emails are processed but not actually delivered.

Response

integer

HTTP-style status code. 200 on success.

string

A human-readable status message. Empty string on success.

long

The internal numeric ID of the newly created send task.

string

A globally unique identifier (GUID) for the send task.

Error Codes

Code	Message	Cause
`400`	Missing required parameter	A required field is absent from the request
`400`	mailName too long	`mailName` exceeds 200 bytes
`400`	Invalid sendDate	`sendDate` is not valid ISO 8601 UTC format
`400`	Missing attachment data	`attachment` object is incomplete (missing `fileName` or `fileData`)
`400`	Missing send lists	`sendListNames` is empty and `onlySave` is not `true`
`403`	Send list not found	One or more names in `sendListNames` do not exist
`403`	Exclusion list not found	One or more names in `repelListNames` do not exist
`500`	Task creation failed	An internal server error occurred

Example Request

curl --request POST \
  --url https://api.effilink.co/v5/campaign/mail/sends \
  --header 'Content-Type: application/json' \
  --header 'ApiKey: YOUR_API_KEY' \
  --data '{
    "mailName": "May Newsletter",
    "senderMail": "newsletter@yourdomain.com",
    "senderName": "Your Company",
    "subject": "What'\''s new this month",
    "content": "<p>Hello {{name}},</p><p>Here are this month'\''s highlights...</p>",
    "sendListNames": ["Newsletter Subscribers"],
    "repelListNames": ["Unsubscribed"],
    "sendDate": "2025-06-01T10:00:00Z"
  }'

Example Response

{
  "code": 200,
  "message": "",
  "id": 1120,
  "guid": "915cb709ac96418495fcf4f666f15c0d"
}

Cancel Send Task

string

/v5/campaign/mail/cancel

Cancels a scheduled send task. Only tasks with a future sendDate (i.e., not yet dispatched) can be cancelled.

Request Parameters

string

required

The name of the send task to cancel.

boolean

Set to true to cancel a task that was created in sandbox mode.

Response

integer

200 on success.

string

A human-readable status message. Empty string on success.

Example Request

curl --request POST \
  --url https://api.effilink.co/v5/campaign/mail/cancel \
  --header 'Content-Type: application/json' \
  --header 'ApiKey: YOUR_API_KEY' \
  --data '{
    "mailName": "May Newsletter"
  }'

Get Send Tasks

string

/v5/campaign/mail/get

Retrieves a paginated list of campaign send tasks, with optional filters. Includes full task details and send statistics.

Request Parameters

string

Filter results to tasks whose name contains this value.

string

Filter results to tasks whose subject contains this value.

string

Filter results to tasks sent from this email address.

string

Filter by task type. Accepted values: MailList, ABTest.

boolean

Set to true to return tasks across all teams in your account. Defaults to false (current team only).

array[integer]

Filter results by task status. Accepted values: -1 (draft), 1 (sending), 2 (send complete), 4 (send failed). Omit to return all statuses.

[-1, 2]

integer

Number of results per page. Defaults to 10.

integer

Page number (1-based). Defaults to 1.

Response

integer

200 on success.

string

A human-readable status message.

integer

Total number of tasks matching the filter criteria.

array[object]

An array of send task objects.

Show mailList[] properties

string

The name of the send task.

string

The email subject line.

string

The HTML body content.

string

The sender display name.

string

The sender email address.

string

The reply-to email address.

array[string]

Individual recipient email addresses (if applicable).

array[string]

Individual excluded email addresses (if applicable).

array[string]

Names of the target contact lists.

array[string]

Names of the exclusion contact lists.

integer

Scheduled or actual send time, expressed as a Unix timestamp in milliseconds (e.g., 1761199614000).

string

Task type: MailList or ABTest.

integer

Current status of the task. Possible values: -1 (draft), 1 (sending), 2 (send complete), 4 (send failed).

string

Globally unique identifier for the task.

string

The team that owns this task.

string

Language code associated with the task.

string

Associated marketing activity name.

string

Associated subscription name.

string

Associated project code.

string

Name of the reviewer who approved the task (if applicable).

object

Delivery and engagement statistics for the task.

Show mailStats properties

integer

Total number of emails sent.

integer

Number of emails confirmed as delivered.

integer

Number of unique opens.

integer

Number of unique link clicks.

integer

Number of hard bounces (permanent delivery failures).

integer

Number of soft bounces (temporary delivery failures).

integer

Number of contacts filtered out and not sent to.

integer

Number of unsubscribes triggered by this send.

Example Request

curl --request POST \
  --url https://api.effilink.co/v5/campaign/mail/get \
  --header 'Content-Type: application/json' \
  --header 'ApiKey: YOUR_API_KEY' \
  --data '{
    "pageSize": 10,
    "pageIndex": 1
  }'

Delete Send Task

string

/v5/campaign/mail/delete

Permanently deletes a campaign send task by name.

Request Parameters

string

required

The name of the send task to delete.

boolean

Set to true to delete a task that was created in sandbox mode.

Response

integer

200 on success.

string

A human-readable status message. Empty string on success.

Example Request

curl --request POST \
  --url https://api.effilink.co/v5/campaign/mail/delete \
  --header 'Content-Type: application/json' \
  --header 'ApiKey: YOUR_API_KEY' \
  --data '{
    "mailName": "May Newsletter"
  }'

Transactional Email

Campaign Email

SMS

Contacts & Lists

Webhooks

Authentication

Campaign Email Sends — POST /v5/campaign/mail/sends

Overview

Create Send Task

Request Parameters

Response

Error Codes

Example Request

Example Response

Cancel Send Task

Request Parameters

Response

Example Request

Get Send Tasks

Request Parameters

Response

Example Request

Delete Send Task

Request Parameters

Response

Example Request

​Overview

​Create Send Task

​Request Parameters

​Response

​Error Codes

​Example Request

​Example Response

​Cancel Send Task

​Request Parameters

​Response

​Example Request

​Get Send Tasks

​Request Parameters

​Response

​Example Request

​Delete Send Task

​Request Parameters

​Response

​Example Request

Overview

Create Send Task

Request Parameters

Response

Error Codes

Example Request

Example Response

Cancel Send Task

Request Parameters

Response

Example Request

Get Send Tasks

Request Parameters

Response

Example Request

Delete Send Task

Request Parameters

Response

Example Request