Skip to main content

概述

模板 API 让您创建、获取和删除可复用的 HTML 邮件模板。构建营销发送任务时可以引用模板,确保品牌一致性并减少跨营销活动的内容重复。 基础 URL: https://api.effilink.co 认证方式: 在请求header中添加ApiKey来进行认证

添加模板

string
/v5/campaign/mail/template/add
在您的 EffiLink 账户中创建一个新的邮件模板。模板名称必须唯一。

请求参数

string
必填
模板的唯一名称。最大 250 字节。用于在创建营销活动时引用该模板。
string
必填
模板的完整 HTML 内容。支持个性化标签(例如 {{firstName}}{{mainContent}})。
string
必填
此模板的默认主题。创建发送任务时可以覆盖。
string
用于创建模板的编辑器类型。默认为 DRAG

响应

int
成功时为 200
string
人类可读的状态消息。成功时为空字符串。

请求示例

响应示例


获取模板

string
/v5/campaign/mail/template/get
返回您账户中邮件模板的分页列表。可选择按模板名称过滤。

请求参数

string
按名称包含此值的模板过滤结果。省略以返回所有模板。
int
每页返回的模板数。默认为 10
int
页码(从 1 开始)。默认为 1

响应

int
成功时为 200
string
人类可读的状态消息。
int
符合过滤条件的模板总数。
array[object]
模板对象数组。

请求示例

响应示例


删除模板

string
/v5/campaign/mail/template/delete
按名称永久删除邮件模板。
此操作不可逆。删除模板不会影响已使用该模板创建的现有营销发送任务,但该模板将不再可用于新的营销活动。

请求参数

string
必填
要删除的模板名称。

响应

int
成功时为 200
string
人类可读的状态消息。成功时为空字符串。

请求示例

响应示例