ConvertKit (独立发布服务器)
ConvertKit 是面向创建者的 go-to 营销中心,可帮助你轻松增长和盈利受众。 使用美丽的登陆页面和选择加入模板将关注者从社交媒体、YouTube 等内容转换为电子邮件列表。
此连接器在以下产品和区域中可用:
| 服务 | Class | 区域 |
|---|---|---|
| Copilot Studio | 高级 | 除以下各项外的所有 Power Automate 区域 : - 美国政府 (GCC) - 美国政府 (GCC High) - 由世纪互联运营的中国云 - 美国国防部(DoD) |
| 逻辑应用程序 | 标准 | 除以下各项外的所有 逻辑应用区域 : - Azure 政府区域 - Azure 中国区域 - 美国国防部(DoD) |
| Power Apps | 高级 | 除以下各项外的所有 Power Apps 区域 : - 美国政府 (GCC) - 美国政府 (GCC High) - 由世纪互联运营的中国云 - 美国国防部(DoD) |
| Power Automate | 高级 | 除以下各项外的所有 Power Automate 区域 : - 美国政府 (GCC) - 美国政府 (GCC High) - 由世纪互联运营的中国云 - 美国国防部(DoD) |
| 联系人 | |
|---|---|
| Name | 特洛伊·泰勒 |
| URL | https://www.hitachisolutions.com |
| ttaylor@hitachisolutions.com |
| 连接器元数据 | |
|---|---|
| 发布者 | 特洛伊·泰勒,日立解决方案 |
| 网站 | https://convertkit.com/ |
| 隐私策略 | https://convertkit.com/privacy |
| 类别 | Marketing |
正在创建连接
连接器支持以下身份验证类型:
| 默认 | 用于创建连接的参数。 | 所有区域 | 不可共享 |
违约
适用:所有区域
用于创建连接的参数。
这是不可共享的连接。 如果 Power App 与另一个用户共享,系统会提示其他用户显式创建新连接。
| Name | 类型 | Description | 必选 |
|---|---|---|---|
| API 机密 | securestring | 此 API 的 API 机密 | True |
限制
| 名称 | 调用 | 续订期 |
|---|---|---|
| 每个连接的 API 调用数 | 100 | 60 秒 |
操作
| 从订阅服务器中删除标记 |
从订阅服务器中删除标记。 |
| 列出广播 |
检索帐户的所有广播的列表。 |
| 列出序列 |
检索帐户的序列列表。 |
| 列出序列的订阅 |
检索对序列(包括订阅服务器数据)的订阅。 |
| 列出标记 |
检索帐户的标记列表。 |
| 列出标记的订阅 |
检索包含订阅服务器数据的标记的订阅列表。 |
| 列出表单的订阅 |
检索表单(包括订阅者数据)的订阅列表。 |
| 列出订阅者 |
返回订阅者的列表。 对于仅取消订阅,请使用已取消的排序字段参数值(当前唯一支持的额外排序字段)。 |
| 列出订阅者的标记 |
检索订阅者的所有标记的列表。 |
| 列出购买 |
检索帐户的所有购买的列表。 |
| 创建广播 |
创建草稿或计划广播。 无需任何属性即可创建草稿广播。 计划广播至少应包含主题行和内容。 |
| 创建标记 |
创建新标记。 |
| 创建购买 |
创建购买。 |
| 取消订阅订阅者 |
取消订阅所有表单和序列中的订阅者。 |
| 将订阅者添加到序列 |
订阅其中一个序列的电子邮件地址。 |
| 将订阅者添加到窗体 |
订阅其中一个表单的电子邮件地址。 |
| 更新广播 |
更新特定广播的属性。 当前发送或已发送的广播可能无法更新。 |
| 更新订阅者 |
更新单个订阅服务器的信息。 |
| 标记订阅者 |
标记作为订阅进行处理。 将电子邮件地址订阅到标记,以将该标记应用于具有该电子邮件地址的订阅者。 |
| 检索广播 |
检索特定广播的详细信息,包括草稿、计划广播和以前发送的广播。 |
| 获取帐户 |
检索当前帐户。 |
| 获取广播统计信息 |
检索特定广播的统计信息(收件人计数、打开率、单击率、取消订阅计数、总点击次数、状态和发送进度)。 |
| 获取表单 |
检索帐户的所有表单的列表。 |
| 获取订阅者 |
检索单个订阅者记录。 |
| 获取购买 |
按 ID 检索特定购买。 |
| 通过电子邮件从订阅者中删除标记 |
通过电子邮件地址从订阅者中删除标记。 |
| 销毁广播 |
永久删除草稿或计划的广播记录。 当前发送或已发送的广播可能无法删除。 |
从订阅服务器中删除标记
从订阅服务器中删除标记。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
订阅服务器 ID
|
subscriber_id | True | string |
订阅者唯一标识符。 |
|
标记 ID
|
tag_id | True | string |
标记唯一标识符。 |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
ID
|
id | integer |
唯一标识符。 |
|
Name
|
name | string |
名称。 |
|
创建时间
|
created_at | string |
创建时。 |
列出广播
检索帐户的所有广播的列表。
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
广播
|
broadcasts | array of object | |
|
ID
|
broadcasts.id | integer |
唯一标识符。 |
|
创建时间
|
broadcasts.created_at | string |
创建时。 |
|
Subject
|
broadcasts.subject | string |
主题。 |
列出序列
检索帐户的序列列表。
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
课程
|
courses | array of object | |
|
ID
|
courses.id | integer |
唯一标识符。 |
|
Name
|
courses.name | string |
名称。 |
|
创建时间
|
courses.created_at | string |
创建时。 |
列出序列的订阅
检索对序列(包括订阅服务器数据)的订阅。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
序列 ID
|
sequence_id | True | string |
序列唯一标识符。 |
|
排序方式
|
sort_order | string |
排序顺序。 |
|
|
订阅服务器状态
|
subscriber_state | string |
订阅服务器的状态。 |
|
|
页
|
page | integer |
页面。 |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
订阅总数
|
total_subscriptions | integer |
订阅总数。 |
|
页
|
page | integer |
页面。 |
|
总页数
|
total_pages | integer |
总页数。 |
|
订阅
|
subscriptions | array of object | |
|
ID
|
subscriptions.id | integer |
唯一标识符。 |
|
State
|
subscriptions.state | string |
省/市/自治区。 |
|
创建时间
|
subscriptions.created_at | string |
创建时。 |
|
来源
|
subscriptions.source | string |
源。 |
|
Referrer
|
subscriptions.referrer | string |
引用者。 |
|
可订阅 ID
|
subscriptions.subscribable_id | integer |
可订阅的唯一标识符。 |
|
可订阅类型
|
subscriptions.subscribable_type | string |
可订阅类型。 |
|
ID
|
subscriptions.subscriber.id | integer |
唯一标识符。 |
|
名字
|
subscriptions.subscriber.first_name | string |
名。 |
|
电子邮件地址
|
subscriptions.subscriber.email_address | string |
电子邮件地址。 |
|
State
|
subscriptions.subscriber.state | string |
省/市/自治区。 |
|
创建时间
|
subscriptions.subscriber.created_at | string |
创建时。 |
|
姓氏
|
subscriptions.subscriber.fields.last_name | string |
姓。 |
列出标记
检索帐户的标记列表。
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
标记
|
tags | array of object | |
|
ID
|
tags.id | integer |
唯一标识符。 |
|
Name
|
tags.name | string |
名称。 |
|
创建时间
|
tags.created_at | string |
创建时。 |
列出标记的订阅
检索包含订阅服务器数据的标记的订阅列表。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
标记 ID
|
tag_id | True | string |
标记唯一标识符。 |
|
排序方式
|
sort_order | string |
排序顺序。 |
|
|
订阅服务器状态
|
subscriber_state | string |
订阅服务器的状态。 |
|
|
页
|
page | integer |
页面。 |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
订阅总数
|
total_subscriptions | integer |
订阅总数。 |
|
页
|
page | integer |
页面。 |
|
总页数
|
total_pages | integer |
总页数。 |
|
订阅
|
subscriptions | array of object | |
|
ID
|
subscriptions.id | integer |
唯一标识符。 |
|
State
|
subscriptions.state | string |
省/市/自治区。 |
|
创建时间
|
subscriptions.created_at | string |
创建时。 |
|
来源
|
subscriptions.source | string |
源。 |
|
Referrer
|
subscriptions.referrer | string |
引用者。 |
|
可订阅 ID
|
subscriptions.subscribable_id | integer |
可订阅的唯一标识符。 |
|
可订阅类型
|
subscriptions.subscribable_type | string |
可订阅类型。 |
|
ID
|
subscriptions.subscriber.id | integer |
唯一标识符。 |
|
名字
|
subscriptions.subscriber.first_name | string |
名。 |
|
电子邮件地址
|
subscriptions.subscriber.email_address | string |
电子邮件地址。 |
|
State
|
subscriptions.subscriber.state | string |
省/市/自治区。 |
|
创建时间
|
subscriptions.subscriber.created_at | string |
创建时。 |
|
姓氏
|
subscriptions.subscriber.fields.last_name | string |
姓。 |
列出表单的订阅
检索表单(包括订阅者数据)的订阅列表。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
表单 ID
|
form_id | True | string |
表单唯一标识符。 |
|
排序方式
|
sort_order | string |
排序顺序。 |
|
|
订阅服务器状态
|
subscriber_state | string |
订阅服务器的状态。 |
|
|
页
|
page | integer |
页面。 |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
订阅总数
|
total_subscriptions | integer |
订阅总数。 |
|
页
|
page | integer |
页面。 |
|
总页数
|
total_pages | integer |
总页数。 |
|
订阅
|
subscriptions | array of object | |
|
ID
|
subscriptions.id | integer |
唯一标识符。 |
|
State
|
subscriptions.state | string |
省/市/自治区。 |
|
创建时间
|
subscriptions.created_at | string |
创建时。 |
|
来源
|
subscriptions.source | string |
源。 |
|
Referrer
|
subscriptions.referrer | string |
引用者。 |
|
可订阅 ID
|
subscriptions.subscribable_id | integer |
可订阅的唯一标识符。 |
|
可订阅类型
|
subscriptions.subscribable_type | string |
可订阅类型。 |
|
ID
|
subscriptions.subscriber.id | integer |
唯一标识符。 |
|
名字
|
subscriptions.subscriber.first_name | string |
名。 |
|
电子邮件地址
|
subscriptions.subscriber.email_address | string |
电子邮件地址。 |
|
State
|
subscriptions.subscriber.state | string |
省/市/自治区。 |
|
创建时间
|
subscriptions.subscriber.created_at | string |
创建时。 |
|
姓氏
|
subscriptions.subscriber.fields.last_name | string |
姓。 |
列出订阅者
返回订阅者的列表。 对于仅取消订阅,请使用已取消的排序字段参数值(当前唯一支持的额外排序字段)。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
来自
|
from | string |
发件人。 |
|
|
到
|
to | string |
to. |
|
|
已从 |
updated_from | string |
从中更新时。 |
|
|
已更新到
|
updated_to | string |
更新到时。 |
|
|
排序方式
|
sort_order | string |
排序顺序。 |
|
|
排序字段
|
sort_field | string |
排序字段。 |
|
|
电子邮件地址
|
email_address | string |
电子邮件地址。 |
|
|
页
|
page | integer |
页面。 |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
订阅服务器总数
|
total_subscribers | integer |
订阅服务器总数。 |
|
页
|
page | integer |
页面。 |
|
总页数
|
total_pages | integer |
总页数。 |
|
Subscribers
|
subscribers | array of object | |
|
ID
|
subscribers.id | integer |
唯一标识符。 |
|
名字
|
subscribers.first_name | string |
名。 |
|
电子邮件地址
|
subscribers.email_address | string |
电子邮件地址。 |
|
State
|
subscribers.state | string |
省/市/自治区。 |
|
创建时间
|
subscribers.created_at | string |
创建时。 |
|
姓氏
|
subscribers.fields.last_name | string |
姓。 |
列出订阅者的标记
检索订阅者的所有标记的列表。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
订阅服务器 ID
|
subscriber_id | True | string |
订阅者唯一标识符。 |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
标记
|
tags | array of object | |
|
ID
|
tags.id | integer |
唯一标识符。 |
|
Name
|
tags.name | string |
名称。 |
|
创建时间
|
tags.created_at | string |
创建时。 |
列出购买
检索帐户的所有购买的列表。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
页
|
page | integer |
页面。 |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
总购买量
|
total_purchases | integer |
总购买量。 |
|
页
|
page | integer |
页面。 |
|
总页数
|
total_pages | integer |
总页数。 |
|
购买
|
purchases | array of object | |
|
ID
|
purchases.id | integer |
唯一标识符。 |
|
事务 ID
|
purchases.transaction_id | string |
事务唯一标识符。 |
|
状态
|
purchases.status | string |
状态。 |
|
电子邮件地址
|
purchases.email_address | string |
电子邮件地址。 |
|
货币
|
purchases.currency | string |
货币。 |
|
事务时间
|
purchases.transaction_time | string |
事务时间。 |
|
小计
|
purchases.subtotal | integer |
分类汇总。 |
|
航运
|
purchases.shipping | integer |
发货。 |
|
折扣
|
purchases.discount | integer |
折扣。 |
|
税款
|
purchases.tax | integer |
税。 |
|
Total
|
purchases.total | integer |
总计。 |
|
Products
|
purchases.products | array of object | |
|
单价
|
purchases.products.unit_price | integer |
单价。 |
|
数量
|
purchases.products.quantity | integer |
数量。 |
|
SKU
|
purchases.products.sku | string |
SKU。 |
|
Name
|
purchases.products.name | string |
名称。 |
创建广播
创建草稿或计划广播。 无需任何属性即可创建草稿广播。 计划广播至少应包含主题行和内容。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
Description
|
description | string |
说明。 |
|
|
Subject
|
subject | string |
主题。 |
|
|
Content
|
content | string |
内容。 |
|
|
电子邮件地址
|
email_address | string |
电子邮件地址。 |
|
|
电子邮件布局模板
|
email_layout_template | string |
电子邮件布局模板。 |
|
|
公众
|
public | boolean |
是否公开。 |
|
|
发布时间
|
published_at | string |
发布时。 |
|
|
发送位置
|
send_at | string |
发送时。 |
|
|
缩略图 Alt
|
thumbnail_alt | string |
缩略图的替换文字。 |
|
|
缩略图 URL
|
thumbnail_url | string |
缩略图的 URL 地址。 |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
ID
|
broadcast.id | integer |
唯一标识符。 |
|
创建时间
|
broadcast.created_at | string |
创建时。 |
|
Subject
|
broadcast.subject | string |
主题。 |
|
Description
|
broadcast.description | string |
说明。 |
|
Content
|
broadcast.content | string |
内容。 |
|
公众
|
broadcast.public | boolean |
是否公开。 |
|
发布时间
|
broadcast.published_at | string |
发布时。 |
|
发送位置
|
broadcast.send_at | string |
发送时。 |
|
缩略图 Alt
|
broadcast.thumbnail_alt | string |
缩略图的替换文字。 |
|
缩略图 URL
|
broadcast.thumbnail_url | string |
缩略图的 URL 地址。 |
|
电子邮件地址
|
broadcast.email_address | string |
电子邮件地址。 |
|
电子邮件布局模板
|
broadcast.email_layout_template | string |
电子邮件布局模板。 |
创建标记
创建新标记。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
Name
|
name | True | string |
名称。 |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
帐户 ID
|
account_id | integer |
帐户唯一标识符。 |
|
创建时间
|
created_at | string |
创建时。 |
|
已删除 At
|
deleted_at | string |
删除时。 |
|
ID
|
id | integer |
唯一标识符。 |
|
Name
|
name | string |
名称。 |
|
State
|
state | string |
省/市/自治区。 |
|
已更新时间
|
updated_at | string |
在更新时。 |
创建购买
创建购买。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
事务 ID
|
transaction_id | True | string |
事务唯一标识符。 |
|
电子邮件地址
|
email_address | True | string |
电子邮件地址。 |
|
名字
|
first_name | string |
名。 |
|
|
货币
|
currency | True | string |
货币。 |
|
事务时间
|
transaction_time | string |
事务时间。 |
|
|
小计
|
subtotal | integer |
分类汇总。 |
|
|
税款
|
tax | integer |
税。 |
|
|
航运
|
shipping | integer |
发货。 |
|
|
折扣
|
discount | integer |
折扣。 |
|
|
Total
|
total | integer |
总计。 |
|
|
状态
|
status | string |
状态。 |
|
|
PID
|
pid | True | integer |
个人标识符。 |
|
盖子
|
lid | True | integer |
LID。 |
|
Name
|
name | True | string |
名称。 |
|
SKU
|
sku | string |
SKU。 |
|
|
单价
|
unit_price | True | integer |
单价。 |
|
数量
|
quantity | True | integer |
数量。 |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
ID
|
id | integer |
唯一标识符。 |
|
事务 ID
|
transaction_id | string |
事务唯一标识符。 |
|
状态
|
status | string |
状态。 |
|
电子邮件地址
|
email_address | string |
电子邮件地址。 |
|
货币
|
currency | string |
货币。 |
|
事务时间
|
transaction_time | string |
事务时间。 |
|
小计
|
subtotal | integer |
分类汇总。 |
|
折扣
|
discount | integer |
折扣。 |
|
税款
|
tax | integer |
税。 |
|
航运
|
shipping | integer |
发货。 |
|
Total
|
total | integer |
总计。 |
|
Products
|
products | array of object | |
|
单价
|
products.unit_price | integer |
单价。 |
|
数量
|
products.quantity | integer |
数量。 |
|
SKU
|
products.sku | string |
SKU。 |
|
Name
|
products.name | string |
名称。 |
取消订阅订阅者
取消订阅所有表单和序列中的订阅者。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
Email
|
True | string |
电子邮件地址。 |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
ID
|
subscriber.id | integer |
唯一标识符。 |
|
名字
|
subscriber.first_name | string |
名。 |
|
电子邮件地址
|
subscriber.email_address | string |
电子邮件地址。 |
|
State
|
subscriber.state | string |
省/市/自治区。 |
|
创建时间
|
subscriber.created_at | string |
创建时。 |
|
姓氏
|
subscriber.fields.last_name | string |
姓。 |
将订阅者添加到序列
订阅其中一个序列的电子邮件地址。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
序列 ID
|
sequence_id | True | string |
序列唯一标识符。 |
|
Email
|
True | string |
电子邮件地址。 |
|
|
名字
|
first_name | string |
名。 |
|
|
标记
|
tags | array of integer |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
ID
|
subscription.id | integer |
唯一标识符。 |
|
State
|
subscription.state | string |
省/市/自治区。 |
|
创建时间
|
subscription.created_at | string |
创建时。 |
|
来源
|
subscription.source | string |
源。 |
|
Referrer
|
subscription.referrer | string |
引用者。 |
|
可订阅 ID
|
subscription.subscribable_id | integer |
可订阅的唯一标识符。 |
|
可订阅类型
|
subscription.subscribable_type | string |
可订阅类型。 |
|
ID
|
subscription.subscriber.id | integer |
唯一标识符。 |
将订阅者添加到窗体
订阅其中一个表单的电子邮件地址。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
表单 ID
|
form_id | True | string |
表单唯一标识符。 |
|
Email
|
True | string |
电子邮件地址。 |
|
|
名字
|
first_name | string |
名。 |
|
|
标记
|
tags | array of integer |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
ID
|
subscription.id | integer |
唯一标识符。 |
|
State
|
subscription.state | string |
省/市/自治区。 |
|
创建时间
|
subscription.created_at | string |
创建时。 |
|
来源
|
subscription.source | string |
源。 |
|
Referrer
|
subscription.referrer | string |
引用者。 |
|
可订阅 ID
|
subscription.subscribable_id | integer |
可订阅的唯一标识符。 |
|
可订阅类型
|
subscription.subscribable_type | string |
可订阅类型。 |
|
ID
|
subscription.subscriber.id | integer |
唯一标识符。 |
|
名字
|
subscription.subscriber.first_name | string |
名。 |
|
电子邮件地址
|
subscription.subscriber.email_address | string |
电子邮件地址。 |
|
State
|
subscription.subscriber.state | string |
省/市/自治区。 |
|
创建时间
|
subscription.subscriber.created_at | string |
创建时。 |
更新广播
更新特定广播的属性。 当前发送或已发送的广播可能无法更新。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
广播 ID
|
broadcast_id | True | string |
广播唯一标识符。 |
|
Description
|
description | string |
说明。 |
|
|
Subject
|
subject | string |
主题。 |
|
|
Content
|
content | string |
内容。 |
|
|
电子邮件地址
|
email_address | string |
电子邮件地址。 |
|
|
电子邮件布局模板
|
email_layout_template | string |
电子邮件布局模板。 |
|
|
公众
|
public | boolean |
是否公开。 |
|
|
发布时间
|
published_at | string |
发布时。 |
|
|
发送位置
|
send_at | string |
发送时。 |
|
|
缩略图 Alt
|
thumbnail_alt | string |
缩略图的替换文字。 |
|
|
缩略图 URL
|
thumbnail_url | string |
缩略图的 URL 地址。 |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
ID
|
broadcast.id | integer |
唯一标识符。 |
|
创建时间
|
broadcast.created_at | string |
创建时。 |
|
Subject
|
broadcast.subject | string |
主题。 |
|
Description
|
broadcast.description | string |
说明。 |
|
Content
|
broadcast.content | string |
内容。 |
|
公众
|
broadcast.public | boolean |
是否公开。 |
|
发布时间
|
broadcast.published_at | string |
发布时。 |
|
发送位置
|
broadcast.send_at | string |
发送时。 |
|
缩略图 Alt
|
broadcast.thumbnail_alt | string |
缩略图的替换文字。 |
|
缩略图 URL
|
broadcast.thumbnail_url | string |
缩略图的 URL 地址。 |
|
电子邮件地址
|
broadcast.email_address | string |
电子邮件地址。 |
|
电子邮件布局模板
|
broadcast.email_layout_template | string |
电子邮件布局模板。 |
更新订阅者
更新单个订阅服务器的信息。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
订阅服务器 ID
|
subscriber_id | True | string |
订阅者唯一标识符。 |
|
名字
|
first_name | string |
名。 |
|
|
电子邮件地址
|
email_address | string |
电子邮件地址。 |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
ID
|
subscriber.id | integer |
唯一标识符。 |
|
名字
|
subscriber.first_name | string |
名。 |
|
电子邮件地址
|
subscriber.email_address | string |
电子邮件地址。 |
|
State
|
subscriber.state | string |
省/市/自治区。 |
|
创建时间
|
subscriber.created_at | string |
创建时。 |
标记订阅者
标记作为订阅进行处理。 将电子邮件地址订阅到标记,以将该标记应用于具有该电子邮件地址的订阅者。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
标记 ID
|
tag_id | True | string |
标记唯一标识符。 |
|
Email
|
string |
电子邮件地址。 |
||
|
名字
|
first_name | string |
名。 |
|
|
标记
|
tags | array of integer |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
ID
|
subscription.id | integer |
唯一标识符。 |
|
State
|
subscription.state | string |
省/市/自治区。 |
|
创建时间
|
subscription.created_at | string |
创建时。 |
|
来源
|
subscription.source | string |
源。 |
|
Referrer
|
subscription.referrer | string |
引用者。 |
|
可订阅 ID
|
subscription.subscribable_id | integer |
可订阅的唯一标识符。 |
|
可订阅类型
|
subscription.subscribable_type | string |
可订阅类型。 |
|
ID
|
subscription.subscriber.id | integer |
唯一标识符。 |
检索广播
检索特定广播的详细信息,包括草稿、计划广播和以前发送的广播。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
广播 ID
|
broadcast_id | True | string |
广播唯一标识符。 |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
ID
|
broadcast.id | integer |
唯一标识符。 |
|
创建时间
|
broadcast.created_at | string |
创建时。 |
|
Subject
|
broadcast.subject | string |
主题。 |
|
Description
|
broadcast.description | string |
说明。 |
|
Content
|
broadcast.content | string |
内容。 |
|
公众
|
broadcast.public | boolean |
是否公开。 |
|
发布时间
|
broadcast.published_at | string |
发布时。 |
|
发送位置
|
broadcast.send_at | string |
发送时。 |
|
缩略图 Alt
|
broadcast.thumbnail_alt | string |
缩略图的替换文字。 |
|
缩略图 URL
|
broadcast.thumbnail_url | string |
缩略图的 URL 地址。 |
|
电子邮件地址
|
broadcast.email_address | string |
电子邮件地址。 |
|
电子邮件布局模板
|
broadcast.email_layout_template | string |
电子邮件布局模板。 |
获取帐户
检索当前帐户。
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
Name
|
name | string |
名称。 |
|
计划类型
|
plan_type | string |
计划的类型。 |
|
主要电子邮件地址
|
primary_email_address | string |
主要电子邮件地址。 |
获取广播统计信息
检索特定广播的统计信息(收件人计数、打开率、单击率、取消订阅计数、总点击次数、状态和发送进度)。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
广播 ID
|
broadcast_id | True | string |
广播唯一标识符。 |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
广播
|
broadcast | array of object | |
|
ID
|
broadcast.id | integer |
唯一标识符。 |
|
收件人
|
broadcast.stats.recipients | integer |
收件人。 |
|
打开率
|
broadcast.stats.open_rate | float |
打开率。 |
|
单击“速率”
|
broadcast.stats.click_rate | float |
单击率。 |
|
取消订阅
|
broadcast.stats.unsubscribes | integer |
取消订阅。 |
|
总点击数
|
broadcast.stats.total_clicks | integer |
总单击次数。 |
|
显示总点击数
|
broadcast.stats.show_total_clicks | boolean |
是否显示总单击次数。 |
|
状态
|
broadcast.stats.status | string |
状态。 |
|
进展
|
broadcast.stats.progress | integer |
进度。 |
获取表单
检索帐户的所有表单的列表。
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
表单
|
forms | array of object | |
|
ID
|
forms.id | integer |
唯一标识符。 |
|
Name
|
forms.name | string |
名称。 |
|
创建时间
|
forms.created_at | string |
创建时。 |
|
类型
|
forms.type | string |
类型。 |
|
Format
|
forms.format | string |
格式。 |
|
URL
|
forms.url | string |
URL 地址。 |
|
嵌入 JS
|
forms.embed_js | string |
要嵌入的 Javascript。 |
|
嵌入 URL
|
forms.embed_url | string |
要嵌入的 URL 地址。 |
|
Title
|
forms.title | string |
标题。 |
|
Description
|
forms.description | string |
说明。 |
|
注册按钮文本
|
forms.sign_up_button_text | string |
注册按钮文本。 |
|
成功消息
|
forms.success_message | string |
成功消息。 |
|
已存档
|
forms.archived | boolean |
是否存档。 |
|
用户唯一标识 (UID)
|
forms.uid | string |
唯一标识符。 |
获取订阅者
检索单个订阅者记录。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
订阅服务器 ID
|
subscriber_id | True | string |
订阅者唯一标识符。 |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
ID
|
subscriber.id | integer |
唯一标识符。 |
|
名字
|
subscriber.first_name | string |
名。 |
|
电子邮件地址
|
subscriber.email_address | string |
电子邮件地址。 |
|
State
|
subscriber.state | string |
省/市/自治区。 |
|
创建时间
|
subscriber.created_at | string |
创建时。 |
|
姓氏
|
subscriber.fields.last_name | string |
姓。 |
获取购买
按 ID 检索特定购买。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
购买 ID
|
purchase_id | True | string |
购买标识符。 |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
ID
|
id | integer |
唯一标识符。 |
|
事务 ID
|
transaction_id | string |
事务唯一标识符。 |
|
状态
|
status | string |
状态。 |
|
电子邮件地址
|
email_address | string |
电子邮件地址。 |
|
货币
|
currency | string |
货币。 |
|
事务时间
|
transaction_time | string |
事务时间。 |
|
小计
|
subtotal | integer |
分类汇总。 |
|
航运
|
shipping | integer |
发货。 |
|
折扣
|
discount | integer |
折扣。 |
|
税款
|
tax | integer |
税。 |
|
Total
|
total | integer |
总计。 |
|
Products
|
products | array of object | |
|
单价
|
products.unit_price | integer |
单价。 |
|
数量
|
products.quantity | integer |
数量。 |
|
SKU
|
products.sku | string |
SKU。 |
|
Name
|
products.name | string |
名称。 |
通过电子邮件从订阅者中删除标记
通过电子邮件地址从订阅者中删除标记。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
标记 ID
|
tag_id | True | string |
标记唯一标识符。 |
|
Email
|
True | string |
电子邮件地址。 |
返回
| 名称 | 路径 | 类型 | 说明 |
|---|---|---|---|
|
ID
|
id | integer |
唯一标识符。 |
|
Name
|
name | string |
名称。 |
|
创建时间
|
created_at | string |
创建时。 |
销毁广播
永久删除草稿或计划的广播记录。 当前发送或已发送的广播可能无法删除。
参数
| 名称 | 密钥 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
广播 ID
|
broadcast_id | True | string |
广播唯一标识符。 |
返回
- response
- string
定义
字符串
这是基本数据类型“string”。