Send a Single Transactional Email — EffiLink API

Overview

Send a single transactional email to one recipient. You can supply raw HTML content or reference a saved template, personalize the message with dynamic tags, schedule delivery up to 72 hours in advance, track opens and clicks, and attach a file — all in one request. Base URL: https://api.effilink.co Endpoint: POST /v5/transactional/mail/sends_customised Authentication: ApiKey header

Request Parameters

string

required

Email subject line.

string

HTML email body content. Required if templateName is not provided.

string

Name of an existing saved template. Takes priority over content when both are provided.

object

Key-value pairs used to populate personalization tags in the format {{tagName}} within your content or template.

{ "name": "Jane", "orderId": "ORD-5678" }

string

required

Verified sender email address. Must be registered in your EffiLink account before use.

string

Sender display name shown in the recipient’s inbox. Maximum 200 bytes.

string

Reply-to email address. Replies from recipients will be directed here instead of senderMail.

string

Scheduled send time in ISO 8601 UTC format (e.g. 2024-03-10T12:00:00Z). Schedule up to 72 hours in advance. Omit this field to send immediately.

object

required

The single recipient of this email.

Show to fields

string

required

Recipient email address.

string

Recipient display name.

string

Email category label for organizational and reporting purposes. Maximum 100 bytes. Alphanumeric characters only.

string

Campaign name for grouping emails in analytics. Maximum 100 bytes. Alphanumeric characters only.

integer

Set to 1 to enable open tracking for this email.

integer

Set to 1 to enable link click tracking. To exclude a specific link from tracking, add the ef:disable-tracking attribute to its anchor tag.

string

A unique message identifier for tracking and deduplication purposes. Maximum 50 bytes.

object

A single file to attach to the email. Only one attachment is supported per request.

Show attachment fields

string

required

The filename of the attachment, including its extension (e.g. invoice.pdf).

string

required

Base64-encoded content of the file to attach.

boolean

Set to true to run a test send. The API validates and processes the request normally but does not deliver the email.

Response Fields

integer

200 on success. See Error Codes for failure values.

string

Empty string ("") on success. Contains an error description on failure.

Error Codes

Code	Cause
`400`	Missing required parameter; invalid `sendDate` format; `category`, `campaign`, or `uniqueMsgID` exceeds length limit; invalid recipient address; sender name too long; invalid reply-to address; missing email content
`403`	Sender address not registered; template not found; insufficient account credits

Example

Request

curl --request POST \
  --url https://api.effilink.co/v5/transactional/mail/sends_customised \
  --header 'Content-Type: application/json' \
  --header 'ApiKey: YOUR_API_KEY' \
  --data '{
    "subject": "Your order has shipped",
    "content": "<p>Hello {{name}}, your order {{orderId}} has shipped!</p>",
    "params": {"name": "Jane", "orderId": "ORD-5678"},
    "senderMail": "noreply@yourdomain.com",
    "senderName": "Your Store",
    "to": {
      "email": "jane@example.com",
      "name": "Jane Smith"
    },
    "trackOpen": 1,
    "trackClick": 1,
    "category": "shipping",
    "campaign": "order_confirmation"
  }'

Response

{
  "code": 200,
  "message": ""
}

Transactional Email

Campaign Email

SMS

Contacts & Lists

Webhooks

Authentication

Send a Single Transactional Email — EffiLink API

Overview

Request Parameters

Response Fields

Error Codes

Example

Request

Response

​Overview

​Request Parameters

​Response Fields

​Error Codes

​Example

​Request

​Response

Overview

Request Parameters

Response Fields

Error Codes

Example

Request

Response