HubSpot Marketing V2 （独立发布者）（预览版）

营销软件使你能够推动收入、节省时间和资源，并衡量和优化投资。所有在一个易于使用的平台上。通过在电子邮件、登陆页面、表单等中与潜在顾客联系，从而推动收入。在一个位置管理联系人和市场活动，并使用自动化工具来扩大效率。使用功能强大的报告工具衡量市场活动的成功。

此连接器在以下产品和区域中可用：

服务	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
Email	ttaylor@hitachisolutions.com

连接器元数据
发布者	特洛伊·泰勒
网站	https://www.hubspot.com/products/marketing
隐私策略	https://legal.hubspot.com/privacy-policy
类别	Marketing

HubSpot Marketing V2

出版商：特洛伊·泰勒，日立解决方案

先决条件

你必须拥有 HubSpot 的帐户，并且必须是超级管理员。

获取凭据

登录到帐户后，转到“设置- 帐户设置 ->> 集成 -> 专用应用”。需要创建专用应用，并仅为其分配将使用作的范围。创建专用应用后，将在专用应用的“身份验证”部分获得访问令牌。

支持的作

发送电子邮件

异步发送事务性电子邮件。返回状态标识符的电子邮件发送的状态，该标识符可用于使用电子邮件发送状态持续查询状态。

将联系人订阅到给定的订阅类型。此作无效，用于在品牌或门户级别订阅联系人，并且将返回错误。

取消订阅联系人

取消订阅给定订阅类型的联系人。此作无效，用于在品牌或门户级别取消订阅联系人，并且将返回错误。

获取联系人订阅状态

返回给定联系人的订阅及其状态的列表。

创建批量通信首选项

创建批量通信首选项请求。此请求将返回一个状态标识符，该标识符可用于使用批量通信首选项状态持续查询状态。

获取订阅定义

检索门户的所有订阅定义的列表。

获取聚合统计信息

检索在指定时间跨度内发送的电子邮件的聚合统计信息。它还返回在时间跨度期间发送的电子邮件列表。

获取聚合统计信息间隔

按指定时间跨度按间隔检索聚合统计信息。每个间隔都包含在该时间发送的电子邮件的聚合统计信息。

获取 AB 营销电子邮件变体

检索 A/B 营销电子邮件的变体。如果电子邮件是变体 A（master），它将返回变体 B（变体），反之亦然。

重置草稿

将草稿重置回实时对象的副本。

还原草稿营销电子邮件

将营销电子邮件的先前修订还原到 DRAFT 状态。如果该对象的草稿中当前存在某些内容，则会覆盖该对象。

获取营销电子邮件草稿

检索电子邮件的草稿版本（如果存在）。如果不存在草稿版本，则返回已发布的电子邮件。

创建或更新草稿电子邮件

创建或更新营销电子邮件的草稿版本。如果不存在草稿，系统会从当前“实时”电子邮件创建草稿，然后将请求正文应用于该草稿。草稿版本仅驻留在缓冲区上，不会克隆电子邮件。

获取市场营销电子邮件修订

检索营销电子邮件的所有版本的列表，其中包含每个条目，包括该特定版本的完整状态。当前修订的 ID 为 -1。

获取市场营销电子邮件的修订

检索市场营销电子邮件的特定修订。

创建 AB 测试营销电子邮件

为 A/B 测试创建市场营销电子邮件的变体。新变体将创建为草稿。如果活动变体已存在，则不会创建一个新变体。

获取营销电子邮件

检索所有市场营销电子邮件的列表。可以筛选结果，以便找到一组特定的电子邮件。

创建市场营销电子邮件

创建新的营销电子邮件。

还原市场营销电子邮件修订

还原之前对市场营销电子邮件的修订。当前修订会变旧，并且还原的修订提供新的版本号。

克隆市场营销电子邮件

创建与原始属性相同的重复电子邮件，但唯一标识符除外。

获取市场营销电子邮件

检索市场营销电子邮件的详细信息。

删除市场营销电子邮件

删除市场营销电子邮件。

更新营销电子邮件

更改市场营销电子邮件的属性。

创建 SMTP 令牌

创建 SMTP 令牌。

查询 SMTP 令牌

按市场活动名称查询多个 SMTP 令牌，或通过电子邮件市场活动标识符查询单个令牌。

删除令牌

按标识符删除单个令牌。

查询令牌

按标识符查询单个令牌。

重置令牌密码

允许为给定令牌创建替换密码。成功重置密码后，令牌的旧密码将无效。

已知问题和限制

目前没有已知问题。

正在创建连接

连接器支持以下身份验证类型：


默认	用于创建连接的参数。	所有区域	不可共享

违约

适用：所有区域

用于创建连接的参数。

这是不可共享的连接。如果 Power App 与另一个用户共享，系统会提示其他用户显式创建新连接。

Name	类型	Description	必选
访问令牌（格式为“Bearer YOUR_ACCESS_TOKEN” ）	securestring	此 API 的访问令牌（格式为“Bearer YOUR_ACCESS_TOKEN”）	True

限制

名称	调用	续订期
每个连接的 API 调用数	100	60 秒

操作

克隆市场营销电子邮件	创建与原始属性相同的重复电子邮件，但唯一标识符除外。
创建 AB 测试营销电子邮件	为 A/B 测试创建市场营销电子邮件的变体。新变体将创建为草稿。如果活动变体已存在，则不会创建一个新变体。
创建 SMTP 令牌	创建 SMTP 令牌。
创建市场营销电子邮件	创建新的营销电子邮件。
创建或更新草稿电子邮件	创建或更新营销电子邮件的草稿版本。如果不存在草稿，系统会从当前“实时”电子邮件创建草稿，然后将请求正文应用于该草稿。草稿版本仅驻留在缓冲区上，不会克隆电子邮件。
创建批量通信首选项	创建批量通信首选项请求。此请求将返回一个状态标识符，该标识符可用于使用批量通信首选项状态持续查询状态。
删除令牌	按标识符删除单个令牌。
删除市场营销电子邮件	删除市场营销电子邮件。
发送电子邮件	异步发送事务性电子邮件。返回状态标识符的电子邮件发送的状态，该标识符可用于使用电子邮件发送状态持续查询状态。
取消订阅联系人	取消订阅给定订阅类型的联系人。此作无效，用于在品牌或门户级别取消订阅联系人，并且将返回错误。
更新营销电子邮件	更改市场营销电子邮件的属性。
查询 SMTP 令牌	按市场活动名称查询多个 SMTP 令牌，或通过电子邮件市场活动标识符查询单个令牌。
查询令牌	按标识符查询单个令牌。
获取 AB 营销电子邮件变体	检索 A/B 营销电子邮件的变体。如果电子邮件是变体 A（master），它将返回变体 B（变体），反之亦然。
获取市场营销电子邮件	检索市场营销电子邮件的详细信息。
获取市场营销电子邮件修订	检索营销电子邮件的所有版本的列表，其中包含每个条目，包括该特定版本的完整状态。当前修订的 ID 为 -1。
获取市场营销电子邮件的修订	检索市场营销电子邮件的特定修订。
获取联系人订阅状态	返回给定联系人的订阅及其状态的列表。
获取聚合统计信息	检索在指定时间跨度内发送的电子邮件的聚合统计信息。它还返回在时间跨度期间发送的电子邮件列表。
获取聚合统计信息间隔	按指定时间跨度按间隔检索聚合统计信息。每个间隔都包含在该时间发送的电子邮件的聚合统计信息。
获取营销电子邮件	检索所有市场营销电子邮件的列表。可以筛选结果，以便找到一组特定的电子邮件。
获取营销电子邮件草稿	检索电子邮件的草稿版本（如果存在）。如果不存在草稿版本，则返回已发布的电子邮件。
获取订阅定义	检索门户的所有订阅定义的列表。
订阅联系人	将联系人订阅到给定的订阅类型。此作无效，用于在品牌或门户级别订阅联系人，并且将返回错误。
还原市场营销电子邮件修订	还原之前对市场营销电子邮件的修订。当前修订会变旧，并且还原的修订提供新的版本号。
还原草稿营销电子邮件	将营销电子邮件的先前修订还原到 DRAFT 状态。如果该对象的草稿中当前存在某些内容，则会覆盖该对象。
重置令牌密码	允许为给定令牌创建替换密码。成功重置密码后，令牌的旧密码将无效。
重置草稿	将草稿重置回实时对象的副本。

克隆市场营销电子邮件

操作 ID:: CloneAMarketingEmail

创建与原始属性相同的重复电子邮件，但唯一标识符除外。

参数

名称	密钥	必需	类型	说明
电子邮件 ID	emailId	True	string	电子邮件标识符。
Name	name		string	名称。

名称	路径	类型	说明
模板路径	content.templatePath	string	模板路径。
纯文本版本	content.plainTextVersion	string	纯文本版本。
来自	from.fromName	string	名称。
回复	from.replyTo	string	答复。
自定义答复	from.customReplyTo	string	自定义答复。
ID	id	string	标识符。
Name	name	string	名称。
发布时发送	sendOnPublish	boolean	是否在发布时发送。
State	state	string	省/市/自治区。
子类别	subcategory	string	子类别。
Subject	subject	string	主题。
包括	to.contactLists.include	array of string	include 数组。
排除	to.contactLists.exclude	array of string	排除数组。
包括	to.contactIds.include	array of string	include 数组。
排除	to.contactIds.exclude	array of string	排除数组。
限制发送频率	to.limitSendFrequency	boolean	是否限制发送频率。
禁止显示灰色邮件	to.suppressGraymail	boolean	是否取消灰色邮件。
按 ID 创建	createdById	string	按标识符创建的。
类型	type	string	类型。
活动域	activeDomain	string	活动域。
已存档	archived	boolean	是否存档。
文件夹 ID	folderId	string	文件夹标识符。
反馈调查 ID	feedbackSurveyId	string	反馈调查标识符。
测试 ID	testing.testId	string	测试标识符。
等待时间	testing.hoursToWait	integer	要等待的小时数。
AB 成功指标	testing.abSuccessMetric	string	A/B 成功指标。
AB 示例大小默认值	testing.abSampleSizeDefault	string	A/B 样本大小默认值。
AB 状态	testing.abStatus	string	A/B 状态。
AB 测试百分比	testing.abTestPercentage	string	A/B 测试百分比。
AB 采样默认值	testing.abSamplingDefault	string	A/B 采样默认值。
订阅编号	subscriptionDetails.subscriptionId	string	订阅标识符。
首选项组 ID	subscriptionDetails.preferencesGroupId	string	首选项组标识符。
Office 位置 ID	subscriptionDetails.officeLocationId	string	办公室位置标识符。
按 ID 更新	updatedById	string	按标识符更新。
按 ID 发布	publishedById	string	按标识符发布的。
语言	language	string	兰高格
市场活动	campaign	string	竞选活动。
Slug	webversion.slug	string	唠叨
域名	webversion.domain	string	域。
Title	webversion.title	string	标题。
元说明	webversion.metaDescription	string	元说明。
重定向到 URL	webversion.redirectToUrl	string	重定向到 URL 地址。
重定向到页面 ID	webversion.redirectToPageId	string	重定向到页面标识符。
到期时间	webversion.expiresAt	string	过期时间。
最大条目数	rssData.maxEntries	string	最大条目。
URL	rssData.url	string	URL 地址。
HubSpot 博客 ID	rssData.hubspotBlogId	string	HubSpot 博客标识符。
博客电子邮件类型	rssData.blogEmailType	string	博客电子邮件类型。
博客图像最大宽度	rssData.blogImageMaxWidth	string	博客图像最大宽度。
条目模板	rssData.rssEntryTemplate	string	条目模板。
使用标题作为主题	rssData.useHeadlineAsSubject	boolean	是否使用标题作为主题。
博客布局	rssData.blogLayout	string	博客布局。
事务性	isTransactional	boolean	是否是事务性的。
已发布	isPublished	boolean	是否发布。
发布日期	publishDate	string	发布日期。
已更新时间	updatedAt	string	在更新时。
创建时间	createdAt	string	创建时。
已删除 At	deletedAt	string	删除时。
发布时间	publishedAt	string	发布时间。

创建 AB 测试营销电子邮件

操作 ID:: CreateAnA_bTestVariationOfAMarketingEmail

为 A/B 测试创建市场营销电子邮件的变体。新变体将创建为草稿。如果活动变体已存在，则不会创建一个新变体。

参数

名称	密钥	必需	类型	说明
电子邮件 ID	emailId	True	string	电子邮件标识符。
内容 ID	contentId		string	内容标识符。
变体名称	variationName		string	变体名称。

名称	路径	类型	说明
模板路径	content.templatePath	string	模板路径。
纯文本版本	content.plainTextVersion	string	纯文本版本。
来自	from.fromName	string	名称。
回复	from.replyTo	string	答复。
自定义答复	from.customReplyTo	string	自定义答复。
ID	id	string	标识符。
Name	name	string	名称。
发布时发送	sendOnPublish	boolean	是否在发布时发送。
State	state	string	省/市/自治区。
子类别	subcategory	string	子类别。
Subject	subject	string	主题。
包括	to.contactLists.include	array of string	include 数组。
排除	to.contactLists.exclude	array of string	排除数组。
包括	to.contactIds.include	array of string	include 数组。
排除	to.contactIds.exclude	array of string	排除数组。
限制发送频率	to.limitSendFrequency	boolean	是否限制发送频率。
禁止显示灰色邮件	to.suppressGraymail	boolean	是否取消灰色邮件。
按 ID 创建	createdById	string	按标识符创建的。
类型	type	string	类型。
活动域	activeDomain	string	活动域。
已存档	archived	boolean	是否存档。
文件夹 ID	folderId	string	文件夹标识符。
反馈调查 ID	feedbackSurveyId	string	反馈调查标识符。
测试 ID	testing.testId	string	测试标识符。
等待时间	testing.hoursToWait	integer	要等待的小时数。
AB 成功指标	testing.abSuccessMetric	string	A/B 成功指标。
AB 示例大小默认值	testing.abSampleSizeDefault	string	A/B 样本大小默认值。
AB 状态	testing.abStatus	string	A/B 状态。
AB 测试百分比	testing.abTestPercentage	string	A/B 测试百分比。
AB 采样默认值	testing.abSamplingDefault	string	A/B 采样默认值。
订阅编号	subscriptionDetails.subscriptionId	string	订阅标识符。
首选项组 ID	subscriptionDetails.preferencesGroupId	string	首选项组标识符。
Office 位置 ID	subscriptionDetails.officeLocationId	string	办公室位置标识符。
按 ID 更新	updatedById	string	按标识符更新。
按 ID 发布	publishedById	string	按标识符发布的。
语言	language	string	兰高格
市场活动	campaign	string	竞选活动。
Slug	webversion.slug	string	唠叨
域名	webversion.domain	string	域。
Title	webversion.title	string	标题。
元说明	webversion.metaDescription	string	元说明。
重定向到 URL	webversion.redirectToUrl	string	重定向到 URL 地址。
重定向到页面 ID	webversion.redirectToPageId	string	重定向到页面标识符。
到期时间	webversion.expiresAt	string	过期时间。
最大条目数	rssData.maxEntries	string	最大条目。
URL	rssData.url	string	URL 地址。
HubSpot 博客 ID	rssData.hubspotBlogId	string	HubSpot 博客标识符。
博客电子邮件类型	rssData.blogEmailType	string	博客电子邮件类型。
博客图像最大宽度	rssData.blogImageMaxWidth	string	博客图像最大宽度。
条目模板	rssData.rssEntryTemplate	string	条目模板。
使用标题作为主题	rssData.useHeadlineAsSubject	boolean	是否使用标题作为主题。
博客布局	rssData.blogLayout	string	博客布局。
事务性	isTransactional	boolean	是否是事务性的。
已发布	isPublished	boolean	是否发布。
发布日期	publishDate	string	发布日期。
已更新时间	updatedAt	string	在更新时。
创建时间	createdAt	string	创建时。
已删除 At	deletedAt	string	删除时。
发布时间	publishedAt	string	发布时间。

创建 SMTP 令牌

操作 ID:: CreateASmtpApiToken

创建 SMTP 令牌。

参数

名称	密钥	必需	类型	说明
市场活动名称	campaignName		string	市场活动名称。
创建联系人	createContact		string	创建联系人。

名称	路径	类型	说明
市场活动名称	campaignName	string	市场活动名称。
创建联系人	createContact	string	创建联系人。
创建时间	createdAt	string	创建时。
创建者	createdBy	string	创建者。
电子邮件市场活动 ID	emailCampaignId	string	电子邮件市场活动标识符。
ID	id	string	标识符。
密码	password	string	密码。

创建市场营销电子邮件

操作 ID:: CreateANewMarketingEmail

创建新的营销电子邮件。

参数

名称	密钥	类型	说明
模板路径	templatePath	string	模板路径。
纯文本版本	plainTextVersion	string	纯文本版本。
来自	fromName	string	名称。
回复	replyTo	string	答复。
自定义答复	customReplyTo	string	自定义答复。
ID	id	string	标识符。
Name	name	string	名称。
发布时发送	sendOnPublish	boolean	是否在发布时发送。
State	state	string	省/市/自治区。
子类别	subcategory	string	子类别。
Subject	subject	string	主题。
包括	include	array of string	include 数组。
排除	exclude	array of string	排除数组。
包括	include	array of string	include 数组。
排除	exclude	array of string	排除数组。
限制发送频率	limitSendFrequency	boolean	是否限制发送频率。
禁止显示灰色邮件	suppressGraymail	boolean	是否取消灰色邮件。
按 ID 创建	createdById	string	按标识符创建的。
类型	type	string	类型。
活动域	activeDomain	string	活动域。
已存档	archived	boolean	是否存档。
文件夹 ID	folderId	string	文件夹标识符。
反馈调查 ID	feedbackSurveyId	string	反馈调查标识符。
测试 ID	testId	string	测试标识符。
等待时间	hoursToWait	integer	要等待的小时数。
AB 成功指标	abSuccessMetric	string	A/B 成功指标。
AB 示例大小默认值	abSampleSizeDefault	string	A/B 样本大小默认值。
AB 状态	abStatus	string	A/B 状态。
AB 测试百分比	abTestPercentage	string	A/B 测试百分比。
AB 采样默认值	abSamplingDefault	string	A/B 采样默认值。
订阅编号	subscriptionId	string	订阅标识符。
首选项组 ID	preferencesGroupId	string	首选项组标识符。
Office 位置 ID	officeLocationId	string	办公室位置标识符。
按 ID 更新	updatedById	string	按标识符更新。
按 ID 发布	publishedById	string	按标识符发布的。
语言	language	string	兰高格
市场活动	campaign	string	竞选活动。
Slug	slug	string	唠叨
域名	domain	string	域。
Title	title	string	标题。
元说明	metaDescription	string	元说明。
重定向到 URL	redirectToUrl	string	重定向到 URL 地址。
重定向到页面 ID	redirectToPageId	string	重定向到页面标识符。
到期时间	expiresAt	string	过期时间。
最大条目数	maxEntries	string	最大条目。
URL	url	string	URL 地址。
HubSpot 博客 ID	hubspotBlogId	string	HubSpot 博客标识符。
博客电子邮件类型	blogEmailType	string	博客电子邮件类型。
博客图像最大宽度	blogImageMaxWidth	string	博客图像最大宽度。
条目模板	rssEntryTemplate	string	条目模板。
使用标题作为主题	useHeadlineAsSubject	boolean	是否使用标题作为主题。
博客布局	blogLayout	string	博客布局。
事务性	isTransactional	boolean	是否是事务性的。
已发布	isPublished	boolean	是否发布。
发布日期	publishDate	string	发布日期。
已更新时间	updatedAt	string	在更新时。
创建时间	createdAt	string	创建时。
已删除 At	deletedAt	string	删除时。
发布时间	publishedAt	string	发布时间。

名称	路径	类型	说明
模板路径	content.templatePath	string	模板路径。
纯文本版本	content.plainTextVersion	string	纯文本版本。
来自	from.fromName	string	名称。
回复	from.replyTo	string	答复。
自定义答复	from.customReplyTo	string	自定义答复。
ID	id	string	标识符。
Name	name	string	名称。
发布时发送	sendOnPublish	boolean	是否在发布时发送。
State	state	string	省/市/自治区。
子类别	subcategory	string	子类别。
Subject	subject	string	主题。
包括	to.contactLists.include	array of string	include 数组。
排除	to.contactLists.exclude	array of string	排除数组。
包括	to.contactIds.include	array of string	include 数组。
排除	to.contactIds.exclude	array of string	排除数组。
限制发送频率	to.limitSendFrequency	boolean	是否限制发送频率。
禁止显示灰色邮件	to.suppressGraymail	boolean	是否取消灰色邮件。
按 ID 创建	createdById	string	按标识符创建的。
类型	type	string	类型。
活动域	activeDomain	string	活动域。
已存档	archived	boolean	是否存档。
文件夹 ID	folderId	string	文件夹标识符。
反馈调查 ID	feedbackSurveyId	string	反馈调查标识符。
测试 ID	testing.testId	string	测试标识符。
等待时间	testing.hoursToWait	integer	要等待的小时数。
AB 成功指标	testing.abSuccessMetric	string	A/B 成功指标。
AB 示例大小默认值	testing.abSampleSizeDefault	string	A/B 样本大小默认值。
AB 状态	testing.abStatus	string	A/B 状态。
AB 测试百分比	testing.abTestPercentage	string	A/B 测试百分比。
AB 采样默认值	testing.abSamplingDefault	string	A/B 采样默认值。
订阅编号	subscriptionDetails.subscriptionId	string	订阅标识符。
首选项组 ID	subscriptionDetails.preferencesGroupId	string	首选项组标识符。
Office 位置 ID	subscriptionDetails.officeLocationId	string	办公室位置标识符。
按 ID 更新	updatedById	string	按标识符更新。
按 ID 发布	publishedById	string	按标识符发布的。
语言	language	string	兰高格
市场活动	campaign	string	竞选活动。
Slug	webversion.slug	string	唠叨
域名	webversion.domain	string	域。
Title	webversion.title	string	标题。
元说明	webversion.metaDescription	string	元说明。
重定向到 URL	webversion.redirectToUrl	string	重定向到 URL 地址。
重定向到页面 ID	webversion.redirectToPageId	string	重定向到页面标识符。
到期时间	webversion.expiresAt	string	过期时间。
最大条目数	rssData.maxEntries	string	最大条目。
URL	rssData.url	string	URL 地址。
HubSpot 博客 ID	rssData.hubspotBlogId	string	HubSpot 博客标识符。
博客电子邮件类型	rssData.blogEmailType	string	博客电子邮件类型。
博客图像最大宽度	rssData.blogImageMaxWidth	string	博客图像最大宽度。
条目模板	rssData.rssEntryTemplate	string	条目模板。
使用标题作为主题	rssData.useHeadlineAsSubject	boolean	是否使用标题作为主题。
博客布局	rssData.blogLayout	string	博客布局。
事务性	isTransactional	boolean	是否是事务性的。
已发布	isPublished	boolean	是否发布。
发布日期	publishDate	string	发布日期。
已更新时间	updatedAt	string	在更新时。
创建时间	createdAt	string	创建时。
已删除 At	deletedAt	string	删除时。
发布时间	publishedAt	string	发布时间。

创建或更新草稿电子邮件

操作 ID:: CreateOrUpdateDraftVersion

参数

名称	密钥	必需	类型	说明
电子邮件 ID	emailId	True	string	电子邮件标识符。
模板路径	templatePath		string	模板路径。
纯文本版本	plainTextVersion		string	纯文本版本。
来自	fromName		string	名称。
回复	replyTo		string	答复。
自定义答复	customReplyTo		string	自定义答复。
ID	id		string	标识符。
Name	name		string	名称。
发布时发送	sendOnPublish		boolean	是否在发布时发送。
State	state		string	省/市/自治区。
子类别	subcategory		string	子类别。
Subject	subject		string	主题。
包括	include		array of string	include 数组。
排除	exclude		array of string	排除数组。
包括	include		array of string	include 数组。
排除	exclude		array of string	排除数组。
限制发送频率	limitSendFrequency		boolean	是否限制发送频率。
禁止显示灰色邮件	suppressGraymail		boolean	是否取消灰色邮件。
按 ID 创建	createdById		string	按标识符创建的。
类型	type		string	类型。
活动域	activeDomain		string	活动域。
已存档	archived		boolean	是否存档。
文件夹 ID	folderId		string	文件夹标识符。
反馈调查 ID	feedbackSurveyId		string	反馈调查标识符。
测试 ID	testId		string	测试标识符。
等待时间	hoursToWait		integer	要等待的小时数。
AB 成功指标	abSuccessMetric		string	A/B 成功指标。
AB 示例大小默认值	abSampleSizeDefault		string	A/B 样本大小默认值。
AB 状态	abStatus		string	A/B 状态。
AB 测试百分比	abTestPercentage		string	A/B 测试百分比。
AB 采样默认值	abSamplingDefault		string	A/B 采样默认值。
订阅编号	subscriptionId		string	订阅标识符。
首选项组 ID	preferencesGroupId		string	首选项组标识符。
Office 位置 ID	officeLocationId		string	办公室位置标识符。
按 ID 更新	updatedById		string	按标识符更新。
按 ID 发布	publishedById		string	按标识符发布的。
语言	language		string	兰高格
市场活动	campaign		string	竞选活动。
Slug	slug		string	唠叨
域名	domain		string	域。
Title	title		string	标题。
元说明	metaDescription		string	元说明。
重定向到 URL	redirectToUrl		string	重定向到 URL 地址。
重定向到页面 ID	redirectToPageId		string	重定向到页面标识符。
到期时间	expiresAt		string	过期时间。
最大条目数	maxEntries		string	最大条目。
URL	url		string	URL 地址。
HubSpot 博客 ID	hubspotBlogId		string	HubSpot 博客标识符。
博客电子邮件类型	blogEmailType		string	博客电子邮件类型。
博客图像最大宽度	blogImageMaxWidth		string	博客图像最大宽度。
条目模板	rssEntryTemplate		string	条目模板。
使用标题作为主题	useHeadlineAsSubject		boolean	是否使用标题作为主题。
博客布局	blogLayout		string	博客布局。
事务性	isTransactional		boolean	是否是事务性的。
已发布	isPublished		boolean	是否发布。
发布日期	publishDate		string	发布日期。
已更新时间	updatedAt		string	在更新时。
创建时间	createdAt		string	创建时。
已删除 At	deletedAt		string	删除时。
发布时间	publishedAt		string	发布时间。

名称	路径	类型	说明
模板路径	content.templatePath	string	模板路径。
纯文本版本	content.plainTextVersion	string	纯文本版本。
来自	from.fromName	string	名称。
回复	from.replyTo	string	答复。
自定义答复	from.customReplyTo	string	自定义答复。
ID	id	string	标识符。
Name	name	string	名称。
发布时发送	sendOnPublish	boolean	是否在发布时发送。
State	state	string	省/市/自治区。
子类别	subcategory	string	子类别。
Subject	subject	string	主题。
包括	to.contactLists.include	array of string	include 数组。
排除	to.contactLists.exclude	array of string	排除数组。
包括	to.contactIds.include	array of string	include 数组。
排除	to.contactIds.exclude	array of string	排除数组。
限制发送频率	to.limitSendFrequency	boolean	是否限制发送频率。
禁止显示灰色邮件	to.suppressGraymail	boolean	是否取消灰色邮件。
按 ID 创建	createdById	string	按标识符创建的。
类型	type	string	类型。
活动域	activeDomain	string	活动域。
已存档	archived	boolean	是否存档。
文件夹 ID	folderId	string	文件夹标识符。
反馈调查 ID	feedbackSurveyId	string	反馈调查标识符。
测试 ID	testing.testId	string	测试标识符。
等待时间	testing.hoursToWait	integer	要等待的小时数。
AB 成功指标	testing.abSuccessMetric	string	A/B 成功指标。
AB 示例大小默认值	testing.abSampleSizeDefault	string	A/B 样本大小默认值。
AB 状态	testing.abStatus	string	A/B 状态。
AB 测试百分比	testing.abTestPercentage	string	A/B 测试百分比。
AB 采样默认值	testing.abSamplingDefault	string	A/B 采样默认值。
订阅编号	subscriptionDetails.subscriptionId	string	订阅标识符。
首选项组 ID	subscriptionDetails.preferencesGroupId	string	首选项组标识符。
Office 位置 ID	subscriptionDetails.officeLocationId	string	办公室位置标识符。
按 ID 更新	updatedById	string	按标识符更新。
按 ID 发布	publishedById	string	按标识符发布的。
语言	language	string	兰高格
市场活动	campaign	string	竞选活动。
Slug	webversion.slug	string	唠叨
域名	webversion.domain	string	域。
Title	webversion.title	string	标题。
元说明	webversion.metaDescription	string	元说明。
重定向到 URL	webversion.redirectToUrl	string	重定向到 URL 地址。
重定向到页面 ID	webversion.redirectToPageId	string	重定向到页面标识符。
到期时间	webversion.expiresAt	string	过期时间。
最大条目数	rssData.maxEntries	string	最大条目。
URL	rssData.url	string	URL 地址。
HubSpot 博客 ID	rssData.hubspotBlogId	string	HubSpot 博客标识符。
博客电子邮件类型	rssData.blogEmailType	string	博客电子邮件类型。
博客图像最大宽度	rssData.blogImageMaxWidth	string	博客图像最大宽度。
条目模板	rssData.rssEntryTemplate	string	条目模板。
使用标题作为主题	rssData.useHeadlineAsSubject	boolean	是否使用标题作为主题。
博客布局	rssData.blogLayout	string	博客布局。
事务性	isTransactional	boolean	是否是事务性的。
已发布	isPublished	boolean	是否发布。
发布日期	publishDate	string	发布日期。
已更新时间	updatedAt	string	在更新时。
创建时间	createdAt	string	创建时。
已删除 At	deletedAt	string	删除时。
发布时间	publishedAt	string	发布时间。

创建批量通信首选项

操作 ID:: PostCommunicationPreferencesv3StatusEmailBulk

创建批量通信首选项请求。此请求将返回一个状态标识符，该标识符可用于使用批量通信首选项状态持续查询状态。

参数

名称	密钥	必需	类型	说明
身体	body	True	array of string

删除令牌

操作 ID:: DeleteASingleTokenById

按标识符删除单个令牌。

参数

名称	密钥	必需	类型	说明
标记	tokenId	True	string	令牌标识符。

response: string

删除市场营销电子邮件

操作 ID:: DeleteAMarketingEmail

删除市场营销电子邮件。

参数

名称	密钥	必需	类型	说明
已存档	archived		boolean	是否存档。
电子邮件 ID	emailId	True	string	电子邮件标识符。

response: string

发送电子邮件

操作 ID:: SendASingleTransactionalEmailAsynchronously

异步发送事务性电子邮件。返回状态标识符的电子邮件发送的状态，该标识符可用于使用电子邮件发送状态持续查询状态。

参数

名称	密钥	类型	说明
电子邮件 ID	emailId	string	电子邮件标识符。
到	to	string	要地址。
来自	from	string	发件人地址。
发送 ID	sendId	string	发送标识符。
回复	replyTo	array of string	对数组的回复。
CC	cc	array of string	CC 数组。
BCC	bcc	array of string	BCC 数组。

名称	路径	类型	说明
状态	status	string	状态。
状态 ID	statusId	string	状态标识符。
发送结果	sendResult	string	发送结果。
请求位置	requestedAt	string	请求时。
从	startedAt	string	启动时。
已完成时间	completedAt	string	完成后。
已创建	eventId.created	string	创建时。
ID	eventId.id	string	标识符。

取消订阅联系人

操作 ID:: UnsubscribeAContact

取消订阅给定订阅类型的联系人。此作无效，用于在品牌或门户级别取消订阅联系人，并且将返回错误。

参数

名称	密钥	类型	说明
电子邮件地址	emailAddress	string	电子邮件地址。
订阅编号	subscriptionId	string	订阅标识符。
法律基础	legalBasis	string	法律依据。
法律基础解释	legalBasisExplanation	string	法律依据解释。

名称	路径	类型	说明
Description	description	string	说明。
ID	id	string	标识符。
Name	name	string	名称。
状态源	sourceOfStatus	string	状态源。
状态	status	string	状态。
品牌 ID	brandId	string	品牌标识符。
首选项组	preferenceGroupName	string	首选项组名称。
法律基础	legalBasis	string	法律依据。
法律基础解释	legalBasisExplanation	string	法律依据解释。

更新营销电子邮件

操作 ID:: UpdateAMarketingEmail

更改市场营销电子邮件的属性。

参数

名称	密钥	必需	类型	说明
已存档	archived		boolean	是否存档。
电子邮件 ID	emailId	True	string	电子邮件标识符。
模板路径	templatePath		string	模板路径。
纯文本版本	plainTextVersion		string	纯文本版本。
来自	fromName		string	名称。
回复	replyTo		string	答复。
自定义答复	customReplyTo		string	自定义答复。
ID	id		string	标识符。
Name	name		string	名称。
发布时发送	sendOnPublish		boolean	是否在发布时发送。
State	state		string	省/市/自治区。
子类别	subcategory		string	子类别。
Subject	subject		string	主题。
包括	include		array of string	include 数组。
排除	exclude		array of string	排除数组。
包括	include		array of string	include 数组。
排除	exclude		array of string	排除数组。
限制发送频率	limitSendFrequency		boolean	是否限制发送频率。
禁止显示灰色邮件	suppressGraymail		boolean	是否取消灰色邮件。
按 ID 创建	createdById		string	按标识符创建的。
类型	type		string	类型。
活动域	activeDomain		string	活动域。
已存档	archived		boolean	是否存档。
文件夹 ID	folderId		string	文件夹标识符。
反馈调查 ID	feedbackSurveyId		string	反馈调查标识符。
测试 ID	testId		string	测试标识符。
等待时间	hoursToWait		integer	要等待的小时数。
AB 成功指标	abSuccessMetric		string	A/B 成功指标。
AB 示例大小默认值	abSampleSizeDefault		string	A/B 样本大小默认值。
AB 状态	abStatus		string	A/B 状态。
AB 测试百分比	abTestPercentage		string	A/B 测试百分比。
AB 采样默认值	abSamplingDefault		string	A/B 采样默认值。
订阅编号	subscriptionId		string	订阅标识符。
首选项组 ID	preferencesGroupId		string	首选项组标识符。
Office 位置 ID	officeLocationId		string	办公室位置标识符。
按 ID 更新	updatedById		string	按标识符更新。
按 ID 发布	publishedById		string	按标识符发布的。
语言	language		string	兰高格
市场活动	campaign		string	竞选活动。
Slug	slug		string	唠叨
域名	domain		string	域。
Title	title		string	标题。
元说明	metaDescription		string	元说明。
重定向到 URL	redirectToUrl		string	重定向到 URL 地址。
重定向到页面 ID	redirectToPageId		string	重定向到页面标识符。
到期时间	expiresAt		string	过期时间。
最大条目数	maxEntries		string	最大条目。
URL	url		string	URL 地址。
HubSpot 博客 ID	hubspotBlogId		string	HubSpot 博客标识符。
博客电子邮件类型	blogEmailType		string	博客电子邮件类型。
博客图像最大宽度	blogImageMaxWidth		string	博客图像最大宽度。
条目模板	rssEntryTemplate		string	条目模板。
使用标题作为主题	useHeadlineAsSubject		boolean	是否使用标题作为主题。
博客布局	blogLayout		string	博客布局。
事务性	isTransactional		boolean	是否是事务性的。
已发布	isPublished		boolean	是否发布。
发布日期	publishDate		string	发布日期。
已更新时间	updatedAt		string	在更新时。
创建时间	createdAt		string	创建时。
已删除 At	deletedAt		string	删除时。
发布时间	publishedAt		string	发布时间。

名称	路径	类型	说明
模板路径	content.templatePath	string	模板路径。
纯文本版本	content.plainTextVersion	string	纯文本版本。
来自	from.fromName	string	名称。
回复	from.replyTo	string	答复。
自定义答复	from.customReplyTo	string	自定义答复。
ID	id	string	标识符。
Name	name	string	名称。
发布时发送	sendOnPublish	boolean	是否在发布时发送。
State	state	string	省/市/自治区。
子类别	subcategory	string	子类别。
Subject	subject	string	主题。
包括	to.contactLists.include	array of string	include 数组。
排除	to.contactLists.exclude	array of string	排除数组。
包括	to.contactIds.include	array of string	include 数组。
排除	to.contactIds.exclude	array of string	排除数组。
限制发送频率	to.limitSendFrequency	boolean	是否限制发送频率。
禁止显示灰色邮件	to.suppressGraymail	boolean	是否取消灰色邮件。
按 ID 创建	createdById	string	按标识符创建的。
类型	type	string	类型。
活动域	activeDomain	string	活动域。
已存档	archived	boolean	是否存档。
文件夹 ID	folderId	string	文件夹标识符。
反馈调查 ID	feedbackSurveyId	string	反馈调查标识符。
测试 ID	testing.testId	string	测试标识符。
等待时间	testing.hoursToWait	integer	要等待的小时数。
AB 成功指标	testing.abSuccessMetric	string	A/B 成功指标。
AB 示例大小默认值	testing.abSampleSizeDefault	string	A/B 样本大小默认值。
AB 状态	testing.abStatus	string	A/B 状态。
AB 测试百分比	testing.abTestPercentage	string	A/B 测试百分比。
AB 采样默认值	testing.abSamplingDefault	string	A/B 采样默认值。
订阅编号	subscriptionDetails.subscriptionId	string	订阅标识符。
首选项组 ID	subscriptionDetails.preferencesGroupId	string	首选项组标识符。
Office 位置 ID	subscriptionDetails.officeLocationId	string	办公室位置标识符。
按 ID 更新	updatedById	string	按标识符更新。
按 ID 发布	publishedById	string	按标识符发布的。
语言	language	string	兰高格
市场活动	campaign	string	竞选活动。
Slug	webversion.slug	string	唠叨
域名	webversion.domain	string	域。
Title	webversion.title	string	标题。
元说明	webversion.metaDescription	string	元说明。
重定向到 URL	webversion.redirectToUrl	string	重定向到 URL 地址。
重定向到页面 ID	webversion.redirectToPageId	string	重定向到页面标识符。
到期时间	webversion.expiresAt	string	过期时间。
最大条目数	rssData.maxEntries	string	最大条目。
URL	rssData.url	string	URL 地址。
HubSpot 博客 ID	rssData.hubspotBlogId	string	HubSpot 博客标识符。
博客电子邮件类型	rssData.blogEmailType	string	博客电子邮件类型。
博客图像最大宽度	rssData.blogImageMaxWidth	string	博客图像最大宽度。
条目模板	rssData.rssEntryTemplate	string	条目模板。
使用标题作为主题	rssData.useHeadlineAsSubject	boolean	是否使用标题作为主题。
博客布局	rssData.blogLayout	string	博客布局。
事务性	isTransactional	boolean	是否是事务性的。
已发布	isPublished	boolean	是否发布。
发布日期	publishDate	string	发布日期。
已更新时间	updatedAt	string	在更新时。
创建时间	createdAt	string	创建时。
已删除 At	deletedAt	string	删除时。
发布时间	publishedAt	string	发布时间。

查询 SMTP 令牌

操作 ID:: QuerySmtpApiTokensByCampaignNameOrAnEmailcampaignid

按市场活动名称查询多个 SMTP 令牌，或通过电子邮件市场活动标识符查询单个令牌。

参数

名称	密钥	类型	说明
市场活动	campaignName	string	市场活动名称。
电子邮件市场活动	emailCampaignId	string	电子邮件市场活动标识符。
之后	after	string	之后。
限度	limit	string	限制。

名称	路径	类型	说明
Results	results	array of object
市场活动名称	results.campaignName	string	市场活动名称。
创建联系人	results.createContact	string	创建联系人。
创建时间	results.createdAt	string	创建时。
创建者	results.createdBy	string	创建者。
电子邮件市场活动 ID	results.emailCampaignId	string	电子邮件市场活动标识符。
ID	results.id	string	标识符。
密码	results.password	string	密码。
之后	paging.next.after	string	后面的链接。
Link	paging.next.link	string	链接。

查询令牌

操作 ID:: QueryASingleTokenById

按标识符查询单个令牌。

参数

名称	密钥	必需	类型	说明
标记	tokenId	True	string	令牌标识符。

名称	路径	类型	说明
市场活动名称	campaignName	string	市场活动名称。
创建联系人	createContact	string	创建联系人。
创建时间	createdAt	string	创建时。
创建者	createdBy	string	创建者。
电子邮件市场活动 ID	emailCampaignId	string	电子邮件市场活动标识符。
ID	id	string	标识符。
密码	password	string	密码。

获取 AB 营销电子邮件变体

操作 ID:: GetTheVariationOfAAnA_bMarketingEmail

检索 A/B 营销电子邮件的变体。如果电子邮件是变体 A（master），它将返回变体 B（变体），反之亦然。

参数

名称	密钥	必需	类型	说明
电子邮件 ID	emailId	True	string	电子邮件标识符。

名称	路径	类型	说明
模板路径	content.templatePath	string	模板路径。
纯文本版本	content.plainTextVersion	string	纯文本版本。
Name	from.fromName	string	名称。
回复	from.replyTo	string	答复。
自定义答复	from.customReplyTo	string	自定义答复。
ID	id	string	标识符。
Name	name	string	名称。
发布时发送	sendOnPublish	boolean	是否在发布时发送。
State	state	string	省/市/自治区。
子类别	subcategory	string	子类别。
Subject	subject	string	主题。
包括	to.contactLists.include	array of string	include 数组。
排除	to.contactLists.exclude	array of string	排除数组。
包括	to.contactIds.include	array of string	include 数组。
排除	to.contactIds.exclude	array of string	排除数组。
限制发送频率	to.limitSendFrequency	boolean	是否限制发送频率。
禁止显示灰色邮件	to.suppressGraymail	boolean	是否取消灰色邮件。
按 ID 创建	createdById	string	按标识符创建的。
类型	type	string	类型。
活动域	activeDomain	string	活动域。
已存档	archived	boolean	是否存档。
文件夹 ID	folderId	string	文件夹标识符。
反馈调查 ID	feedbackSurveyId	string	反馈调查标识符。
测试 ID	testing.testId	string	测试标识符。
等待时间	testing.hoursToWait	integer	要等待的小时数。
AB 成功指标	testing.abSuccessMetric	string	A/B 成功指标。
AB 示例大小默认值	testing.abSampleSizeDefault	string	A/B 样本大小默认值。
AB 状态	testing.abStatus	string	A/B 状态。
AB 测试百分比	testing.abTestPercentage	string	A/B 测试百分比。
AB 采样默认值	testing.abSamplingDefault	string	A/B 采样默认值。
订阅编号	subscriptionDetails.subscriptionId	string	订阅标识符。
首选项组 ID	subscriptionDetails.preferencesGroupId	string	首选项组标识符。
Office 位置 ID	subscriptionDetails.officeLocationId	string	办公室位置标识符。
按 ID 更新	updatedById	string	按标识符更新。
按 ID 发布	publishedById	string	按标识符发布的。
语言	language	string	兰高格
市场活动	campaign	string	竞选活动。
Slug	webversion.slug	string	唠叨
域名	webversion.domain	string	域。
Title	webversion.title	string	标题。
元说明	webversion.metaDescription	string	元说明。
重定向到 URL	webversion.redirectToUrl	string	重定向到 URL 地址。
重定向到页面 ID	webversion.redirectToPageId	string	重定向到页面标识符。
到期时间	webversion.expiresAt	string	过期时间。
最大条目数	rssData.maxEntries	string	最大条目。
URL	rssData.url	string	URL 地址。
HubSpot 博客 ID	rssData.hubspotBlogId	string	HubSpot 博客标识符。
博客电子邮件类型	rssData.blogEmailType	string	博客电子邮件类型。
博客图像最大宽度	rssData.blogImageMaxWidth	string	博客图像最大宽度。
条目模板	rssData.rssEntryTemplate	string	条目模板。
使用标题作为主题	rssData.useHeadlineAsSubject	boolean	是否使用标题作为主题。
博客布局	rssData.blogLayout	string	博客布局。
事务性	isTransactional	boolean	是否是事务性的。
已发布	isPublished	boolean	是否发布。
发布日期	publishDate	string	发布日期。
已更新时间	updatedAt	string	在更新时。
创建时间	createdAt	string	创建时。
已删除 At	deletedAt	string	删除时。
发布时间	publishedAt	string	发布时间。

获取市场营销电子邮件

操作 ID:: GetTheDetailsOfASpecifiedMarketingEmail

检索市场营销电子邮件的详细信息。

参数

名称	密钥	必需	类型	说明
包括统计信息	includeStats		boolean	是否包含统计信息。
包括属性	includedProperties		boolean	是否包含属性。
已存档	archived		boolean	是否存档。
电子邮件 ID	emailId	True	string	电子邮件标识符。

名称	路径	类型	说明
模板路径	content.templatePath	string	模板路径。
纯文本版本	content.plainTextVersion	string	纯文本版本。
来自	from.fromName	string	名称。
回复	from.replyTo	string	答复。
自定义答复	from.customReplyTo	string	自定义答复。
ID	id	string	标识符。
Name	name	string	名称。
发布时发送	sendOnPublish	boolean	是否在发布时发送。
State	state	string	省/市/自治区。
子类别	subcategory	string	子类别。
Subject	subject	string	主题。
包括	to.contactLists.include	array of string	include 数组。
排除	to.contactLists.exclude	array of string	排除数组。
包括	to.contactIds.include	array of string	include 数组。
排除	to.contactIds.exclude	array of string	排除数组。
限制发送频率	to.limitSendFrequency	boolean	是否限制发送频率。
禁止显示灰色邮件	to.suppressGraymail	boolean	是否取消灰色邮件。
按 ID 创建	createdById	string	按标识符创建的。
类型	type	string	类型。
活动域	activeDomain	string	活动域。
已存档	archived	boolean	是否存档。
文件夹 ID	folderId	string	文件夹标识符。
反馈调查 ID	feedbackSurveyId	string	反馈调查标识符。
测试 ID	testing.testId	string	测试标识符。
等待时间	testing.hoursToWait	integer	要等待的小时数。
AB 成功指标	testing.abSuccessMetric	string	A/B 成功指标。
AB 示例大小默认值	testing.abSampleSizeDefault	string	A/B 样本大小默认值。
AB 状态	testing.abStatus	string	A/B 状态。
AB 测试百分比	testing.abTestPercentage	string	A/B 测试百分比。
AB 采样默认值	testing.abSamplingDefault	string	A/B 采样默认值。
订阅编号	subscriptionDetails.subscriptionId	string	订阅标识符。
首选项组 ID	subscriptionDetails.preferencesGroupId	string	首选项组标识符。
Office 位置 ID	subscriptionDetails.officeLocationId	string	办公室位置标识符。
按 ID 更新	updatedById	string	按标识符更新。
按 ID 发布	publishedById	string	按标识符发布的。
语言	language	string	兰高格
市场活动	campaign	string	竞选活动。
Slug	webversion.slug	string	唠叨
域名	webversion.domain	string	域。
Title	webversion.title	string	标题。
元说明	webversion.metaDescription	string	元说明。
重定向到 URL	webversion.redirectToUrl	string	重定向到 URL 地址。
重定向到页面 ID	webversion.redirectToPageId	string	重定向到页面标识符。
到期时间	webversion.expiresAt	string	过期时间。
最大条目数	rssData.maxEntries	string	最大条目。
URL	rssData.url	string	URL 地址。
HubSpot 博客 ID	rssData.hubspotBlogId	string	HubSpot 博客标识符。
博客电子邮件类型	rssData.blogEmailType	string	博客电子邮件类型。
博客图像最大宽度	rssData.blogImageMaxWidth	string	博客图像最大宽度。
条目模板	rssData.rssEntryTemplate	string	条目模板。
使用标题作为主题	rssData.useHeadlineAsSubject	boolean	是否使用标题作为主题。
博客布局	rssData.blogLayout	string	博客布局。
事务性	isTransactional	boolean	是否是事务性的。
已发布	isPublished	boolean	是否发布。
发布日期	publishDate	string	发布日期。
已更新时间	updatedAt	string	在更新时。
创建时间	createdAt	string	创建时。
已删除 At	deletedAt	string	删除时。
发布时间	publishedAt	string	发布时间。

获取市场营销电子邮件修订

操作 ID:: GetRevisionsOfAMarketingEmail

检索营销电子邮件的所有版本的列表，其中包含每个条目，包括该特定版本的完整状态。当前修订的 ID 为 -1。

参数

名称	密钥	必需	类型	说明
之后	after		string	之后。
之前	before		string	前者。
限度	limit		string	限制。
电子邮件 ID	emailId	True	string	电子邮件标识符。

名称	路径	类型	说明
Results	results	array of object
ID	results.id	string	标识符。
AB 小时等待	results.object.abHoursToWait	string	要等待的 A/B 小时。
AB 状态	results.object.abStatus	string	A/B 状态。
AB 测试 ID	results.object.abTestId	string	A/B 测试标识符。
存档的 At	results.object.archivedAt	string	存档时。
在仪表板中存档	results.object.archivedInDashboard	boolean	是否在仪表板中存档。
附加样式表	results.object.attachedStylesheets	array of object	附加的样式表对象。
作者	results.object.authorName	string	作者名称。
博客电子邮件类型	results.object.blogEmailType	string	博客电子邮件类型。
市场活动	results.object.campaign	string	竞选活动。
类别 ID	results.object.categoryId	string	类别标识符。
内容组 ID	results.object.contentGroupId	string	内容组标识符。
内容类型类别	results.object.contentTypeCategory	string	内容类型类别。
创建页面	results.object.createPage	string	创建页面。
已创建	results.object.created	string	创建时。
按 ID 创建	results.object.createdById	string	按标识符创建的。
当前状态	results.object.currentState	string	当前状态。
当前已发布	results.object.currentlyPublished	boolean	当前是否已发布。
自定义答复	results.object.customReplyTo	string	自定义答复。
启用自定义答复	results.object.customReplyToEnabled	boolean	是否启用自定义答复。
域名	results.object.domain	string	域。
动态页面数据源 ID	results.object.dynamicPageDataSourceId	string	动态页面数据源标识符。
动态页面数据源类型	results.object.dynamicPageDataSourceType	string	动态页面数据源类型。
动态页面 HubDb 表 ID	results.object.dynamicPageHubDbTableId	string	动态页 HubDb 表标识符。
电子邮件类型	results.object.emailType	string	电子邮件类型。
启用域样式表	results.object.enableDomainStylesheets	boolean	是否启用域样式表。
启用布局样式表	results.object.enableLayoutStylesheets	boolean	是否启用布局样式表。
特别推荐的图像	results.object.featuredImage	string	特色图像。
特色图像替换文字	results.object.featuredImageAltText	string	特色图像替换文字。
文件夹 ID	results.object.folderId	string	文件夹标识符。
页脚 HTML	results.object.footerHtml	string	页脚 HTML 代码。
来自	results.object.fromName	string	名称。
头 HTML	results.object.headHtml	string	头 HTML 代码。
Html 标题	results.object.htmlTitle	string	HTML 标题。
ID	results.object.id	string	标识符。
包括默认自定义 CSS	results.object.includeDefaultCustomCss	boolean	是否包含默认自定义 CSS。
是否已启用 Graymail 抑制	results.object.isGraymailSuppressionEnabled	boolean	是否启用灰色邮件抑制。
语言	results.object.language	string	语言。
链接 Rel 规范 URL	results.object.linkRelCanonicalUrl	string	链接 rel 规范 URL 地址。
Mab 试验 ID	results.object.mabExperimentId	string	mab 试验标识符。
排除的邮件列表	results.object.mailingListsExcluded	array of string	邮件列表排除的数组。
包含的邮件列表	results.object.mailingListsIncluded	array of string	邮件列表包含数组。
最大 RSS 条目数	results.object.maxRssEntries	integer	最大 RSS 条目数。
元说明	results.object.metaDescription	string	元说明。
Name	results.object.name	string	名称。
页面到期日期	results.object.pageExpiryDate	string	页面到期日期。
已启用页面过期	results.object.pageExpiryEnabled	boolean	是否启用页面到期。
页面过期重定向 ID	results.object.pageExpiryRedirectId	string	页面过期重定向标识符。
页面过期重定向 URL	results.object.pageExpiryRedirectUrl	string	页面过期重定向 URL 地址。
已重定向页面	results.object.pageRedirected	string	重定向的页面。
密码	results.object.password	string	密码。
已启用公共访问规则	results.object.publicAccessRulesEnabled	boolean	是否启用了公共访问规则。
发布日期	results.object.publishDate	string	发布日期。
立即发布	results.object.publishImmediately	boolean	是否立即发布。
回复	results.object.replyTo	string	答复。
RSS 电子邮件作者行模板	results.object.rssEmailAuthorLineTemplate	string	RSS 电子邮件作者行模板。
RSS 电子邮件博客图像最大宽度	results.object.rssEmailBlogImageMaxWidth	string	RSS 电子邮件博客图像最大宽度。
按文本发送 RSS 电子邮件	results.object.rssEmailByText	string	按文本发送的 RSS 电子邮件。
RSS 电子邮件单击文本	results.object.rssEmailClickThroughText	string	RSS 电子邮件单击文本。
RSS 电子邮件注释文本	results.object.rssEmailCommentText	string	RSS 电子邮件注释文本。
RSS 电子邮件输入模板	results.object.rssEmailEntryTemplate	string	RSS 电子邮件条目模板。
已启用 RSS 电子邮件输入模板	results.object.rssEmailEntryTemplateEnabled	string	已启用 RSS 电子邮件条目模板。
RSS 电子邮件 ID	results.object.rssEmailId	string	RSS 电子邮件标识符。
RSS 电子邮件 URL	results.object.rssEmailUrl	string	RSS 电子邮件地址。
Slug	results.object.slug	string	唠叨
State	results.object.state	string	省/市/自治区。
子类别	results.object.subcategory	string	子类别。
Subject	results.object.subject	string	主题。
Subscription	results.object.subscription	string	订阅。
订阅博客 ID	results.object.subscriptionBlogId	string	订阅博客标识符。
Subscription	results.object.subscriptionName	string	订阅名称。
模板路径	results.object.templatePath	string	模板路径。
事务	results.object.transactional	string	事务性。
已从 ID 转换	results.object.translatedFromId	string	从标识符转换的。
Updated	results.object.updated	string	更新时。
按 ID 更新	results.object.updatedById	string	按标识符更新。
URL	results.object.url	string	URL 地址。
使用特色图像	results.object.useFeaturedImage	boolean	是否使用特色图像。
使用 RSS 标题作为主题	results.object.useRssHeadlineAsSubject	boolean	是否使用 RSS 标题作为主题。
排除的 VID	results.object.vidsExcluded	array of string	排除的 VID 数组。
包含的 VID	results.object.vidsIncluded	array of string	VID 包含的数组。
Workflows	results.object.workflowNames	array of string	工作流名称。
是否已启用收件人疲劳抑制	results.object.isRecipientFatigueSuppressionEnabled	boolean	是否启用收件人疲劳抑制。
反馈调查 ID	results.object.feedbackSurveyId	string	反馈调查标识符。
Email	results.user.email	string	电子邮件地址。
完整姓名	results.user.fullName	string	全名。
ID	results.user.id	string	标识符。
已更新时间	results.updatedAt	string	在更新时。
Total	total	integer	总计。
之后	paging.next.after	string	后面的链接。
Link	paging.next.link	string	链接。
之前	paging.prev.before	string	前链接。
Link	paging.prev.link	string	链接。

获取市场营销电子邮件的修订

操作 ID:: GetARevisionOfAMarketingEmail

检索市场营销电子邮件的特定修订。

参数

名称	密钥	必需	类型	说明
电子邮件 ID	emailId	True	string	电子邮件标识符。
修订 ID	revisionId	True	string	修订标识符。

名称	路径	类型	说明
ID	id	string	标识符。
模板路径	object.content.templatePath	string	模板路径。
纯文本版本	object.content.plainTextVersion	string	纯文本版本。
Name	object.from.fromName	string	名称。
回复	object.from.replyTo	string	答复。
自定义答复	object.from.customReplyTo	string	自定义答复。
ID	object.id	string	标识符。
Name	object.name	string	名称。
发布时发送	object.sendOnPublish	boolean	是否在发布时发送。
State	object.state	string	省/市/自治区。
子类别	object.subcategory	string	子类别。
Subject	object.subject	string	主题。
包括	object.to.contactLists.include	array of string	include 数组。
排除	object.to.contactLists.exclude	array of string	排除数组。
包括	object.to.contactIds.include	array of string	include 数组。
排除	object.to.contactIds.exclude	array of string	排除数组。
限制发送频率	object.to.limitSendFrequency	boolean	是否限制发送频率。
禁止显示灰色邮件	object.to.suppressGraymail	boolean	是否取消灰色邮件。
按 ID 创建	object.createdById	string	按标识符创建的。
类型	object.type	string	类型。
活动域	object.activeDomain	string	活动域。
已存档	object.archived	boolean	是否存档。
文件夹 ID	object.folderId	string	文件夹标识符。
反馈调查 ID	object.feedbackSurveyId	string	反馈调查标识符。
测试 ID	object.testing.testId	string	测试标识符。
等待时间	object.testing.hoursToWait	integer	要等待的小时数。
AB 成功指标	object.testing.abSuccessMetric	string	A/B 成功指标。
AB 示例大小默认值	object.testing.abSampleSizeDefault	string	A/B 样本大小默认值。
AB 状态	object.testing.abStatus	string	A/B 状态。
AB 测试百分比	object.testing.abTestPercentage	string	A/B 测试百分比。
AB 采样默认值	object.testing.abSamplingDefault	string	A/B 采样默认值。
ID	object.subscriptionDetails.subscriptionId	string	订阅标识符。
首选项组 ID	object.subscriptionDetails.preferencesGroupId	string	首选项组标识符。
Office 位置 ID	object.subscriptionDetails.officeLocationId	string	办公室位置标识符。
按 ID 更新	object.updatedById	string	按标识符更新。
按 ID 发布	object.publishedById	string	按标识符发布的。
语言	object.language	string	语言。
市场活动	object.campaign	string	竞选活动。
Slug	object.webversion.slug	string	唠叨
域名	object.webversion.domain	string	域。
Title	object.webversion.title	string	标题。
元说明	object.webversion.metaDescription	string	元说明。
重定向到 URL	object.webversion.redirectToUrl	string	重定向到 URL 地址。
重定向到页面 ID	object.webversion.redirectToPageId	string	重定向到页面标识符。
到期时间	object.webversion.expiresAt	string	过期时间。
最大条目数	object.rssData.maxEntries	string	最大条目。
URL	object.rssData.url	string	URL 地址。
HubSpot 博客 ID	object.rssData.hubspotBlogId	string	HubSpot 博客标识符。
博客电子邮件类型	object.rssData.blogEmailType	string	博客电子邮件类型。
博客图像最大宽度	object.rssData.blogImageMaxWidth	string	博客图像最大宽度。
条目模板	object.rssData.rssEntryTemplate	string	条目模板。
使用标题作为主题	object.rssData.useHeadlineAsSubject	boolean	是否使用标题作为主题。
博客布局	object.rssData.blogLayout	string	博客布局。
事务性	object.isTransactional	boolean	是否是事务性的。
已发布	object.isPublished	boolean	是否发布。
发布日期	object.publishDate	string	发布日期。
已更新时间	object.updatedAt	string	在更新时。
创建时间	object.createdAt	string	创建时。
已删除 At	object.deletedAt	string	删除时。
发布时间	object.publishedAt	string	发布时。
已更新时间	updatedAt	string	在更新时。
Email	user.email	string	电子邮件地址。
完整姓名	user.fullName	string	全名。
ID	user.id	string	标识符。

获取联系人订阅状态

操作 ID:: GetSubscriptionStatusesForAContact

返回给定联系人的订阅及其状态的列表。

参数

名称	密钥	必需	类型	说明
电子邮件地址	emailAddress	True	string	电子邮件地址。

名称	路径	类型	说明
Recipient	recipient	string	收件人。
订阅状态	subscriptionStatuses	array of object
Description	subscriptionStatuses.description	string	说明。
ID	subscriptionStatuses.id	string	标识符。
Name	subscriptionStatuses.name	string	名称。
状态源	subscriptionStatuses.sourceOfStatus	string	状态源。
状态	subscriptionStatuses.status	string	状态。
品牌 ID	subscriptionStatuses.brandId	string	品牌标识符。
首选项组	subscriptionStatuses.preferenceGroupName	string	首选项组名称。
法律基础	subscriptionStatuses.legalBasis	string	法律依据。
法律基础解释	subscriptionStatuses.legalBasisExplanation	string	法律依据解释。

获取聚合统计信息

操作 ID:: GetAggregatedStatistics

检索在指定时间跨度内发送的电子邮件的聚合统计信息。它还返回在时间跨度期间发送的电子邮件列表。

参数

名称	密钥	类型	说明
Start	startTimestamp	string	开始时间戳。
结束	endTimestamp	string	结束时间戳。
电子邮件 ID	emailIds	string	电子邮件标识符。
资产	property	string	属性。

名称	路径	类型	说明
电子邮件	emails	array of string	电子邮件地址数组。

获取聚合统计信息间隔

操作 ID:: GetAggregatedStatisticIntervals

按指定时间跨度按间隔检索聚合统计信息。每个间隔都包含在该时间发送的电子邮件的聚合统计信息。

参数

名称	密钥	类型	说明
时间间隔	interval	string	间隔。
Start	startTimestamp	string	开始时间戳。
结束	endTimestamp	string	结束时间戳。
电子邮件 ID	emailIds	string	电子邮件标识符。

名称	路径	类型	说明
Results	results	array of object
结束	results.interval.end	string	结束。
Start	results.interval.start	string	开始。
Total	total	integer	总计。

获取营销电子邮件

操作 ID:: GetAllMarketingEmailsForAHubspotAccount

检索所有市场营销电子邮件的列表。可以筛选结果，以便找到一组特定的电子邮件。

参数

名称	密钥	类型	说明
创建时间	createdAt	string	创建时。
创建后	createdAfter	string	创建后。
在之前创建	createdBefore	string	之前创建的。
已更新时间	updatedAt	string	在更新时。
更新后	updatedAfter	string	更新后。
在之前更新	updatedBefore	string	之前已更新。
排序	sort	string	排序。
之后	after	string	之后。
限度	limit	string	限制。
包括统计信息	includeStats	boolean	是否包含统计信息。
类型	type	string	类型。
已发布	isPublished	boolean	是否发布。
包括属性	includedProperties	boolean	是否包含属性。
已存档	archived	boolean	是否存档。

名称	路径	类型	说明
Results	results	array of object
模板路径	results.content.templatePath	string	模板路径。
纯文本版本	results.content.plainTextVersion	string	纯文本版本。
来自	results.from.fromName	string	名称。
回复	results.from.replyTo	string	答复。
自定义答复	results.from.customReplyTo	string	自定义答复。
ID	results.id	string	标识符。
Name	results.name	string	名称。
发布时发送	results.sendOnPublish	boolean	是否在发布时发送。
State	results.state	string	省/市/自治区。
子类别	results.subcategory	string	子类别。
Subject	results.subject	string	主题。
包括	results.to.contactLists.include	array of string	包括的。
排除	results.to.contactLists.exclude	array of string	已排除。
包括	results.to.contactIds.include	array of string	包括的。
排除	results.to.contactIds.exclude	array of string	已排除。
限制发送频率	results.to.limitSendFrequency	boolean	是否限制发送频率。
禁止显示灰色邮件	results.to.suppressGraymail	boolean	是否取消灰色邮件。
按 ID 创建	results.createdById	string	按标识符创建的。
类型	results.type	string	类型。
活动域	results.activeDomain	string	活动域。
已存档	results.archived	boolean	是否存档。
文件夹 ID	results.folderId	string	文件夹标识符。
反馈调查 ID	results.feedbackSurveyId	string	反馈调查标识符。
测试 ID	results.testing.testId	string	测试标识符。
等待时间	results.testing.hoursToWait	integer	要等待的小时数。
AB 成功指标	results.testing.abSuccessMetric	string	A/B 成功指标。
AB 示例大小默认值	results.testing.abSampleSizeDefault	string	A/B 样本大小默认值。
AB 状态	results.testing.abStatus	string	A/B 状态。
AB 测试百分比	results.testing.abTestPercentage	string	A/B 测试百分比。
AB 采样默认值	results.testing.abSamplingDefault	string	A/B 采样默认值。
订阅编号	results.subscriptionDetails.subscriptionId	string	订阅标识符。
首选项组 ID	results.subscriptionDetails.preferencesGroupId	string	首选项组标识符。
Office 位置 ID	results.subscriptionDetails.officeLocationId	string	办公室位置标识符。
按 ID 更新	results.updatedById	string	按标识符更新。
按 ID 发布	results.publishedById	string	按标识符发布的。
语言	results.language	string	语言。
市场活动	results.campaign	string	竞选活动。
Slug	results.webversion.slug	string	唠叨
域名	results.webversion.domain	string	域。
Title	results.webversion.title	string	标题。
元说明	results.webversion.metaDescription	string	元说明。
重定向到 URL	results.webversion.redirectToUrl	string	重定向到 URL 地址。
重定向到页面 ID	results.webversion.redirectToPageId	string	重定向到页面标识符。
到期时间	results.webversion.expiresAt	string	过期时间。
最大条目数	results.rssData.maxEntries	string	最大条目数
URL	results.rssData.url	string	URL 地址。
HubSpot 博客 ID	results.rssData.hubspotBlogId	string	HubSpot 博客标识符。
博客电子邮件类型	results.rssData.blogEmailType	string	博客电子邮件类型。
博客图像最大宽度	results.rssData.blogImageMaxWidth	string	博客图像最大宽度。
RSS 条目模板	results.rssData.rssEntryTemplate	string	RSS 。
使用标题作为主题	results.rssData.useHeadlineAsSubject	boolean	是否使用标题作为主题。
博客布局	results.rssData.blogLayout	string	博客布局。
事务性	results.isTransactional	boolean	是否是事务性的。
已发布	results.isPublished	boolean	是否发布。
发布日期	results.publishDate	string	发布日期。
已更新时间	results.updatedAt	string	在更新时。
创建时间	results.createdAt	string	创建时。
已删除 At	results.deletedAt	string	删除时。
发布时间	results.publishedAt	string	发布时间。
Total	total	integer	总计。
之后	paging.next.after	string	后面的链接。
Link	paging.next.link	string	链接。

获取营销电子邮件草稿

操作 ID:: GetDraftVersionOfAMarketingEmail

检索电子邮件的草稿版本（如果存在）。如果不存在草稿版本，则返回已发布的电子邮件。

参数

名称	密钥	必需	类型	说明
电子邮件 ID	emailId	True	string	电子邮件标识符。

名称	路径	类型	说明
模板路径	content.templatePath	string	模板路径。
纯文本版本	content.plainTextVersion	string	纯文本版本。
来自	from.fromName	string	名称。
回复	from.replyTo	string	答复。
自定义答复	from.customReplyTo	string	自定义答复。
ID	id	string	标识符。
Name	name	string	名称。
发布时发送	sendOnPublish	boolean	是否在发布时发送。
State	state	string	省/市/自治区。
子类别	subcategory	string	子类别。
Subject	subject	string	主题。
包括	to.contactLists.include	array of string	include 数组。
排除	to.contactLists.exclude	array of string	排除数组。
包括	to.contactIds.include	array of string	include 数组。
排除	to.contactIds.exclude	array of string	排除数组。
限制发送频率	to.limitSendFrequency	boolean	是否限制发送频率。
禁止显示灰色邮件	to.suppressGraymail	boolean	是否取消灰色邮件。
按 ID 创建	createdById	string	按标识符创建的。
类型	type	string	类型。
活动域	activeDomain	string	活动域。
已存档	archived	boolean	是否存档。
文件夹 ID	folderId	string	文件夹标识符。
反馈调查 ID	feedbackSurveyId	string	反馈调查标识符。
测试 ID	testing.testId	string	测试标识符。
等待时间	testing.hoursToWait	integer	要等待的小时数。
AB 成功指标	testing.abSuccessMetric	string	A/B 成功指标。
AB 示例大小默认值	testing.abSampleSizeDefault	string	A/B 样本大小默认值。
AB 状态	testing.abStatus	string	A/B 状态。
AB 测试百分比	testing.abTestPercentage	string	A/B 测试百分比。
AB 采样默认值	testing.abSamplingDefault	string	A/B 采样默认值。
订阅编号	subscriptionDetails.subscriptionId	string	订阅标识符。
首选项组 ID	subscriptionDetails.preferencesGroupId	string	首选项组标识符。
Office 位置 ID	subscriptionDetails.officeLocationId	string	办公室位置标识符。
按 ID 更新	updatedById	string	按标识符更新。
按 ID 发布	publishedById	string	按标识符发布的。
语言	language	string	兰高格
市场活动	campaign	string	竞选活动。
Slug	webversion.slug	string	唠叨
域名	webversion.domain	string	域。
Title	webversion.title	string	标题。
元说明	webversion.metaDescription	string	元说明。
重定向到 URL	webversion.redirectToUrl	string	重定向到 URL 地址。
重定向到页面 ID	webversion.redirectToPageId	string	重定向到页面标识符。
到期时间	webversion.expiresAt	string	过期时间。
最大条目数	rssData.maxEntries	string	最大条目。
URL	rssData.url	string	URL 地址。
HubSpot 博客 ID	rssData.hubspotBlogId	string	HubSpot 博客标识符。
博客电子邮件类型	rssData.blogEmailType	string	博客电子邮件类型。
博客图像最大宽度	rssData.blogImageMaxWidth	string	博客图像最大宽度。
条目模板	rssData.rssEntryTemplate	string	条目模板。
使用标题作为主题	rssData.useHeadlineAsSubject	boolean	是否使用标题作为主题。
博客布局	rssData.blogLayout	string	博客布局。
事务性	isTransactional	boolean	是否是事务性的。
已发布	isPublished	boolean	是否发布。
发布日期	publishDate	string	发布日期。
已更新时间	updatedAt	string	在更新时。
创建时间	createdAt	string	创建时。
已删除 At	deletedAt	string	删除时。
发布时间	publishedAt	string	发布时间。

获取订阅定义

操作 ID:: GetSubscriptionDefinitions

检索门户的所有订阅定义的列表。

名称	路径	类型	说明
订阅定义	subscriptionDefinitions	array of object
创建时间	subscriptionDefinitions.createdAt	string	创建时。
Description	subscriptionDefinitions.description	string	说明。
ID	subscriptionDefinitions.id	string	标识符。
处于活动状态	subscriptionDefinitions.isActive	boolean	是否处于活动状态。
为默认值	subscriptionDefinitions.isDefault	boolean	是否为默认值。
是内部	subscriptionDefinitions.isInternal	boolean	是否为内部。
Name	subscriptionDefinitions.name	string	名称。
已更新时间	subscriptionDefinitions.updatedAt	string	在更新时。
目的	subscriptionDefinitions.purpose	string	用途。
通信方法	subscriptionDefinitions.communicationMethod	string	通信方法。

订阅联系人

操作 ID:: SubscribeAContact

将联系人订阅到给定的订阅类型。此作无效，用于在品牌或门户级别订阅联系人，并且将返回错误。

参数

名称	密钥	类型	说明
电子邮件地址	emailAddress	string	电子邮件地址。
订阅编号	subscriptionId	string	订阅标识符。
法律基础	legalBasis	string	法律依据。
法律基础解释	legalBasisExplanation	string	法律依据解释。

名称	路径	类型	说明
Description	description	string	说明。
ID	id	string	标识符。
Name	name	string	名称。
状态源	sourceOfStatus	string	状态源。
状态	status	string	状态。
品牌 ID	brandId	string	品牌标识符。
首选项组	preferenceGroupName	string	首选项组名称。
法律基础	legalBasis	string	法律依据。
法律基础解释	legalBasisExplanation	string	法律依据解释。

还原市场营销电子邮件修订

操作 ID:: RestoreARevisionOfAMarketingEmail

还原之前对市场营销电子邮件的修订。当前修订会变旧，并且还原的修订提供新的版本号。

参数

名称	密钥	必需	类型	说明
电子邮件 ID	emailId	True	string	电子邮件标识符。
修订 ID	revisionId	True	string	修订标识符。

response: string

还原草稿营销电子邮件

操作 ID:: RestoreARevisionOfAMarketingEmailToDraftState

将营销电子邮件的先前修订还原到 DRAFT 状态。如果该对象的草稿中当前存在某些内容，则会覆盖该对象。

参数

名称	密钥	必需	类型	说明
电子邮件 ID	emailId	True	string	电子邮件标识符。
修订 ID	revisionId	True	string	修订标识符。

名称	路径	类型	说明
模板路径	content.templatePath	string	模板路径。
纯文本版本	content.plainTextVersion	string	纯文本版本。
来自	from.fromName	string	名称。
回复	from.replyTo	string	答复。
自定义答复	from.customReplyTo	string	自定义答复。
ID	id	string	标识符。
Name	name	string	名称。
发布时发送	sendOnPublish	boolean	是否在发布时发送。
State	state	string	省/市/自治区。
子类别	subcategory	string	子类别。
Subject	subject	string	主题。
包括	to.contactLists.include	array of string	include 数组。
排除	to.contactLists.exclude	array of string	排除数组。
包括	to.contactIds.include	array of string	include 数组。
排除	to.contactIds.exclude	array of string	排除数组。
限制发送频率	to.limitSendFrequency	boolean	是否限制发送频率。
禁止显示灰色邮件	to.suppressGraymail	boolean	是否取消灰色邮件。
按 ID 创建	createdById	string	按标识符创建的。
类型	type	string	类型。
活动域	activeDomain	string	活动域。
已存档	archived	boolean	是否存档。
文件夹 ID	folderId	string	文件夹标识符。
反馈调查 ID	feedbackSurveyId	string	反馈调查标识符。
测试 ID	testing.testId	string	测试标识符。
等待时间	testing.hoursToWait	integer	要等待的小时数。
AB 成功指标	testing.abSuccessMetric	string	A/B 成功指标。
AB 示例大小默认值	testing.abSampleSizeDefault	string	A/B 样本大小默认值。
AB 状态	testing.abStatus	string	A/B 状态。
AB 测试百分比	testing.abTestPercentage	string	A/B 测试百分比。
AB 采样默认值	testing.abSamplingDefault	string	A/B 采样默认值。
订阅编号	subscriptionDetails.subscriptionId	string	订阅标识符。
首选项组 ID	subscriptionDetails.preferencesGroupId	string	首选项组标识符。
Office 位置 ID	subscriptionDetails.officeLocationId	string	办公室位置标识符。
按 ID 更新	updatedById	string	按标识符更新。
按 ID 发布	publishedById	string	按标识符发布的。
语言	language	string	兰高格
市场活动	campaign	string	竞选活动。
Slug	webversion.slug	string	唠叨
域名	webversion.domain	string	域。
Title	webversion.title	string	标题。
元说明	webversion.metaDescription	string	元说明。
重定向到 URL	webversion.redirectToUrl	string	重定向到 URL 地址。
重定向到页面 ID	webversion.redirectToPageId	string	重定向到页面标识符。
到期时间	webversion.expiresAt	string	过期时间。
最大条目数	rssData.maxEntries	string	最大条目。
URL	rssData.url	string	URL 地址。
HubSpot 博客 ID	rssData.hubspotBlogId	string	HubSpot 博客标识符。
博客电子邮件类型	rssData.blogEmailType	string	博客电子邮件类型。
博客图像最大宽度	rssData.blogImageMaxWidth	string	博客图像最大宽度。
条目模板	rssData.rssEntryTemplate	string	条目模板。
使用标题作为主题	rssData.useHeadlineAsSubject	boolean	是否使用标题作为主题。
博客布局	rssData.blogLayout	string	博客布局。
事务性	isTransactional	boolean	是否是事务性的。
已发布	isPublished	boolean	是否发布。
发布日期	publishDate	string	发布日期。
已更新时间	updatedAt	string	在更新时。
创建时间	createdAt	string	创建时。
已删除 At	deletedAt	string	删除时。
发布时间	publishedAt	string	发布时间。

重置令牌密码

操作 ID:: ResetThePasswordOfAnExistingToken

允许为给定令牌创建替换密码。成功重置密码后，令牌的旧密码将无效。

参数

名称	密钥	必需	类型	说明
标记	tokenId	True	string	令牌标识符。

名称	路径	类型	说明
市场活动名称	campaignName	string	市场活动名称。
创建联系人	createContact	string	创建联系人。
创建时间	createdAt	string	创建时。
创建者	createdBy	string	创建者。
电子邮件市场活动 ID	emailCampaignId	string	电子邮件市场活动标识符。
ID	id	string	标识符。
密码	password	string	密码。

重置草稿

操作 ID:: ResetDraft

将草稿重置回实时对象的副本。

参数

名称	密钥	必需	类型	说明
电子邮件 ID	emailId	True	string	电子邮件标识符。

response: string

定义

字符串

这是基本数据类型“string”。

通过

HubSpot Marketing V2 （独立发布者） （预览版）

HubSpot Marketing V2

出版商：特洛伊·泰勒，日立解决方案

先决条件

获取凭据

支持的作

发送电子邮件

订阅联系人

取消订阅联系人

获取联系人订阅状态

创建批量通信首选项

获取订阅定义

获取聚合统计信息

获取聚合统计信息间隔

获取 AB 营销电子邮件变体

重置草稿

还原草稿营销电子邮件

获取营销电子邮件草稿

创建或更新草稿电子邮件

获取市场营销电子邮件修订

获取市场营销电子邮件的修订

创建 AB 测试营销电子邮件

获取营销电子邮件

创建市场营销电子邮件

还原市场营销电子邮件修订

克隆市场营销电子邮件

获取市场营销电子邮件

删除市场营销电子邮件

更新营销电子邮件

创建 SMTP 令牌

查询 SMTP 令牌

删除令牌

查询令牌

重置令牌密码

已知问题和限制

正在创建连接

违约

限制

操作

克隆市场营销电子邮件

参数

返回

创建 AB 测试营销电子邮件

参数

返回

创建 SMTP 令牌

参数

返回

创建市场营销电子邮件

参数

返回

创建或更新草稿电子邮件

参数

返回

创建批量通信首选项

参数

删除令牌

参数

返回

删除市场营销电子邮件

参数

返回

发送电子邮件

参数

返回

取消订阅联系人

参数

返回

更新营销电子邮件

参数

返回

查询 SMTP 令牌

参数

返回

查询令牌

参数

返回

获取 AB 营销电子邮件变体

参数

HubSpot Marketing V2 （独立发布者）（预览版）