Campaign Email Templates — Add, Retrieve, and Delete

Overview

The Templates API lets you create, retrieve, and delete reusable HTML email templates. Templates can be referenced when building campaign send tasks, ensuring consistent branding and reducing content duplication across campaigns. Base URL: https://api.effilink.co All endpoints require authentication via an ApiKey or OAuth header.

Add Template

string

/v5/campaign/mail/template/add

Creates a new email template in your EffiLink account. Template names must be unique.

Request Parameters

string

required

A unique name for the template. Maximum 250 bytes. Used to reference the template when creating campaigns.

string

required

The full HTML content of the template. Supports personalization tags (e.g., {{firstName}}, {{mainContent}}).

string

required

The default subject line for this template. Can be overridden when creating a send task.

string

The editor type used to create the template. Defaults to DRAG.

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

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/template/add \
  --header 'Content-Type: application/json' \
  --header 'ApiKey: YOUR_API_KEY' \
  --data '{
    "templateName": "monthly-newsletter-v1",
    "templateContent": "<h1>Hello {{firstName}}!</h1><p>{{mainContent}}</p>",
    "templateSubject": "Monthly Newsletter",
    "editorType": "CLASSIC"
  }'

Example Response

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

Get Templates

string

/v5/campaign/mail/template/get

Returns a paginated list of email templates in your account. Optionally filter by template name.

Request Parameters

string

Filter results to templates whose name contains this value. Omit to return all templates.

integer

Number of templates to return 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 templates matching the filter criteria.

array[object]

An array of template objects.

Show templateList[] properties

string

The unique name of the template.

string

The full HTML content of the template.

string

The default subject line of the template.

string

The date and time the template was created (e.g., "2023-10-30 08:15:54.921").

Example Request

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

Example Response

{
  "code": 200,
  "message": "",
  "templateList": [
    {
      "templateName": "monthly-newsletter-v1",
      "templateContent": "<h1>Hello {{firstName}}!</h1><p>{{mainContent}}</p>",
      "templateSubject": "Monthly Newsletter",
      "createDate": "2025-05-01 08:30:00.000"
    }
  ],
  "totalRecords": 1
}

Delete Template

string

/v5/campaign/mail/template/delete

Permanently deletes an email template by name.

This action is irreversible. Deleting a template does not affect existing campaign send tasks that were already created using it, but the template will no longer be available for new campaigns.

Request Parameters

string

required

The name of the template to delete.

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/template/delete \
  --header 'Content-Type: application/json' \
  --header 'ApiKey: YOUR_API_KEY' \
  --data '{
    "templateName": "monthly-newsletter-v1"
  }'

Example Response

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

Transactional Email

Campaign Email

SMS

Contacts & Lists

Webhooks

Authentication

Campaign Email Templates — Add, Retrieve, and Delete

Overview

Add Template

Request Parameters

Response

Example Request

Example Response

Get Templates

Request Parameters

Response

Example Request

Example Response

Delete Template

Request Parameters

Response

Example Request

Example Response

​Overview

​Add Template

​Request Parameters

​Response

​Example Request

​Example Response

​Get Templates

​Request Parameters

​Response

​Example Request

​Example Response

​Delete Template

​Request Parameters

​Response

​Example Request

​Example Response

Overview

Add Template

Request Parameters

Response

Example Request

Example Response

Get Templates

Request Parameters

Response

Example Request

Example Response

Delete Template

Request Parameters

Response

Example Request

Example Response