Marketo MA （预览版）

Marketo Marketing Automation。此 API 提供对 Marketo 对象（如市场活动、计划、潜在顾客、列表（静态和智能）以及文件系统资产（如文件和文件夹）的访问权限。

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

服务	Class	区域
Copilot Studio	标准	除以下各项外的所有 Power Automate 区域： - 美国政府（GCC High） - 由世纪互联运营的中国云 - 美国国防部（DoD）
逻辑应用程序	标准	除以下各项外的所有逻辑应用区域： - Azure 中国区域 - 美国国防部（DoD）
Power Apps	标准	除以下各项外的所有 Power Apps 区域： - 美国政府（GCC High） - 由世纪互联运营的中国云 - 美国国防部（DoD）
Power Automate	标准	除以下各项外的所有 Power Automate 区域： - 美国政府（GCC High） - 由世纪互联运营的中国云 - 美国国防部（DoD）

联系人
Name	Marketo 开发人员关系
URL	http://developers.marketo.com
Email	developerfeedback@marketo.com

连接器元数据
发布者	Microsoft公司
Website	https://www.marketo.com/
隐私策略	https://documents.marketo.com/legal/privacy/
服务条款	https://go.microsoft.com/fwlink/?linkid=2237005
类别	营销;销售和 CRM

正在创建连接

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


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

违约

适用：所有区域

用于创建连接的参数。

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

Name	类型	Description	必选
MunchkinID	字符串	你的 Marketo MunchkinID （请参阅管理页面）	True
客户 ID	字符串	客户 ID	True
客户端密码	securestring	客户端密码	True

限制

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

操作

从列表中删除	从目标静态列表中删除一组给定的人员记录。所需权限：Read-Write 潜在顾客
克隆智能列表	克隆指定的智能列表。所需权限：Read-Write 资产
克隆程序	克隆目标程序。所需权限：Read-Write 资产
列表成员	检查潜在顾客是否是给定静态列表的成员。所需权限：Read-Write 潜在顾客
创建导出潜在顾客作业	为通过“filter”参数定义的搜索条件创建导出作业。请求返回在后续调用批量导出潜在顾客终结点时作为参数传递的“exportId”。使用排队导出潜在顾客作业终结点将导出作业排队进行处理。使用“获取导出潜在顾客作业状态”终结点检索导出作业的状态。所需权限：Read-Only 潜在顾客
创建导出程序成员作业	为通过“filter”参数定义的搜索条件创建导出作业。请求返回在对批量导出程序成员终结点的后续调用中作为参数传递的“exportId”。
创建文件	从包含的有效负载创建新文件。所需权限：Read-Write 资产
创建文件夹	创建新文件夹。所需权限：Read-Write 资产
创建程序	创建新程序。所需权限：Read-Write 资产
创建静态列表	创建新的静态列表。所需权限：Read-Write 资产
删除文件夹	删除指定的文件夹。如果文件夹包含内容，则删除将失败。所需权限：Read-Write 资产
删除智能列表	删除指定的智能列表。所需权限：Read-Write 资产
删除潜在顾客	从目标实例中删除潜在顾客列表。所需权限：Read-Write 潜在顾客
删除程序	删除目标程序。程序可能不包含在程序外部使用的任何资产。所需权限：Read-Write 资产
删除程序标记	删除非必需的程序标记。所需权限：Read-Write 资产
删除计划成员	从目标实例中删除成员列表。所需权限：Read-Write 潜在顾客
删除静态列表	删除指定的静态列表。所需权限：Read-Write 资产
取消导出潜在顾客作业	取消导出作业。所需权限：Read-Only 潜在顾客
取消导出程序成员作业	取消导出作业。所需权限：Read-Only 潜在顾客
取消批准计划	取消应用目标程序。仅适用于已批准的电子邮件程序。所需权限：Read-Write 资产
同步潜在顾客	将潜在顾客列表同步到目标实例。所需权限：Read-Write 潜在顾客
同步程序成员数据	更改目标计划中潜在顾客列表的程序成员数据。只有程序的现有成员才能使用此 API 更改其数据。所需权限：Read-Write 潜在顾客
同步计划成员状态	更改目标计划中潜在顾客列表的程序成员状态。如果成员不是计划的一部分，则成员将添加到该计划。所需权限：Read-Write 潜在顾客
导入潜在顾客	将包含数据记录的文件导入目标实例。所需权限：Read-Write 潜在顾客
导入计划成员	将包含数据记录的文件导入目标实例。所需权限：Read-Write 潜在顾客
将潜在客户推送到 Marketo	向上插入潜在顾客并生成推送潜在顾客到 Marketo 活动。所需权限：Read-Write 潜在顾客
批准计划	批准目标计划。仅适用于未经批准的电子邮件程序。所需权限：Read-Write 资产
按 ID 获取列表	按 ID 返回列表记录。所需权限：Read-Only 潜在顾客，Read-Write 潜在顾客
按 ID 获取市场活动	按 ID 返回市场活动记录。所需权限：Read-Only 市场活动，Read-Write 市场活动注意：此终结点已被取代。请改用 Id 终结点获取智能市场活动。
按 ID 获取文件	返回给定 ID 的文件记录。所需权限：Read-Only 资产，Read-Write 资产
按 ID 获取文件夹	返回具有给定 ID 的文件夹记录。所需权限：Read-Only 资产，Read-Write 资产
按 ID 获取智能列表	按 ID 检索智能列表记录。所需权限：Read-Asset 或 Read-Write 资产
按 ID 获取潜在顾客	通过 Marketo ID 检索单个潜在顾客记录。所需权限：Read-Only 潜在顾客，Read-Write 潜在顾客
按 ID 获取程序	检索给定 ID 的程序记录。所需权限：Read-Only 资产，Read-Write 资产
按 ID 获取静态列表	按 ID 检索静态列表记录。所需权限：Read-Asset 或 Read-Write 资产
按列表 ID 获取潜在顾客	检索属于给定静态列表的成员的人员记录。所需权限：Read-Only 潜在顾客、Read-Write 潜在顾客
按列表 ID 获取潜在顾客	检索属于给定静态列表的成员的人员记录。所需权限：Read-Only 潜在顾客、Read-Write 潜在顾客
按名称获取文件	返回给定名称的文件记录。所需权限：Read-Only 资产、Read-Write 资产
按名称获取文件夹	返回给定名称的文件夹记录。所需权限：Read-Only 资产、Read-Write 资产
按名称获取智能列表	按名称检索智能列表记录。所需权限：Read-Asset 或 Read-Write 资产
按名称获取潜在顾客字段	检索单个潜在顾客字段的元数据。所需权限：Read-Write 架构标准字段、Read-Write 架构自定义字段
按名称获取程序	检索给定名称的程序记录。所需权限：Read-Only 资产、Read-Write 资产
按名称获取程序成员字段	检索单个程序成员字段的元数据。所需权限：Read-Write 架构标准字段、Read-Write 架构自定义字段
按名称获取静态列表	按名称检索静态列表记录。所需权限：Read-Asset 或 Read-Write 资产
按标记获取程序	检索与给定标记类型和标记值匹配的程序的列表。所需权限：Read-Only 资产、Read-Write 资产
按程序 ID 获取智能列表	按电子邮件程序 ID 检索智能列表记录。所需权限：Read-Asset 或 Read-Write 资产
按筛选器类型获取潜在顾客	根据特定字段中的值列表返回最多 300 个潜在顾客的列表。所需权限：Read-Only 潜在顾客、Read-Write 潜在顾客
按计划 ID 获取潜在顾客	检索作为指定程序成员的潜在顾客列表。所需权限：Read-Only 潜在顾客、Read-Write 潜在顾客
排队导出潜在顾客作业	排队导出作业。这会将导出作业置于队列中，并在计算资源可用时启动作业。导出作业必须处于“已创建”状态。使用“获取导出潜在顾客作业状态”终结点检索导出作业的状态。所需权限：Read-Only 潜在顾客
排队导出程序成员作业	排队导出作业。这会将导出作业置于队列中，并在计算资源可用时启动作业。导出作业必须处于“已创建”状态。
描述潜在顾客	返回有关目标实例中潜在顾客对象的元数据，包括可用于通过 API 交互的所有字段的列表。所需权限：Read-Only 潜在顾客、Read-Write 潜在顾客注意：此终结点已被取代。请改用 “描述潜在顾客 2 ”终结点。
描述潜在顾客 2	返回目标实例中潜在顾客对象的可搜索字段列表。所需权限：Read-Only 潜在顾客、Read-Write 潜在顾客
描述计划成员	返回有关目标实例中的程序成员对象的元数据，包括可用于通过 API 交互的所有字段的列表。所需权限：Read-Only 潜在顾客、Read-Write 潜在顾客注意：此终结点已被取代。请改用 “描述计划成员 ”终结点。
描述计划成员	返回有关目标实例中的程序成员对象的元数据，包括可用于通过 API 交互的所有字段的列表。所需权限：Read-Only 潜在顾客、Read-Write 潜在顾客
更新文件内容	将文件的当前内容替换为包含的有效负载。所需权限：Read-Write 资产
更新文件夹元数据	更新给定文件夹的元数据。所需权限：Read-Write 资产
更新潜在顾客字段	更新目标实例中潜在顾客字段的元数据。请参阅此处的更新规则。所需权限：Read-Write 架构标准字段、Read-Write 架构自定义字段
更新程序元数据	更新目标程序的元数据。所需权限：Read-Write 资产
更新程序标记	更新程序标记。所需权限：Read-Write 资产
更新静态列表元数据	更新静态列表资产的元数据。所需权限：Read-Write 资产
添加到列表	将一组给定的人员记录添加到目标静态列表。每个请求的潜在客户 ID 限制为 300 个。所需权限：Read-Write 潜在顾客
获取列表	基于给定的筛选器参数返回一组静态列表记录。所需权限：Read-Only 潜在顾客、Read-Write 潜在顾客
获取导入潜在顾客失败	返回导入批处理作业的失败列表。所需权限：Read-Write 潜在顾客
获取导入潜在顾客状态	返回导入批处理作业的状态。所需权限：Read-Write 潜在顾客
获取导入潜在顾客警告	返回导入批处理作业的警告列表。所需权限：Read-Write 潜在顾客
获取导入程序成员失败	返回导入批处理作业的失败列表。所需权限：Read-Write 潜在顾客
获取导入程序成员警告	返回导入批处理作业的警告列表。所需权限：Read-Write 潜在顾客
获取导入计划成员状态	返回导入批处理作业的状态。所需权限：Read-Write 潜在顾客
获取导出潜在顾客作业	返回在过去 7 天内创建的导出作业的列表。所需权限：Read-Only 潜在顾客
获取导出潜在顾客作业状态	返回导出作业的状态。作业状态在达到“已完成”或“失败”状态后 30 天内可用。所需权限：Read-Only 潜在顾客
获取导出潜在顾客文件	返回导出作业的文件内容。导出作业必须处于“已完成”状态。使用“获取导出潜在顾客作业状态”终结点检索导出作业的状态。所需权限：Read-Only 潜在顾客文件格式是通过调用“创建导出潜在顾客作业”终结点指定的。下面是默认文件格式（“CSV”）的示例。 `firstName,lastName,email` `Marvin,Gaye,marvin.gaye@motown.com`
获取导出程序成员文件	返回导出作业的文件内容。导出作业必须处于“已完成”状态。使用“获取导出计划成员作业状态”终结点检索导出作业的状态。所需权限：Read-Only 潜在顾客文件格式是通过调用“创建导出程序成员作业”终结点指定的。下面是默认文件格式（“CSV”）的示例。 `firstName,lastName,email` `Marvin,Gaye,marvin.gaye@motown.com`
获取导出计划成员作业	返回在过去 7 天内创建的导出作业的列表。所需权限：Read-Only 潜在顾客
获取导出计划成员作业状态	返回导出作业的状态。作业状态在达到“已完成”或“失败”状态后 30 天内可用。所需权限：Read-Only 潜在顾客
获取市场活动	返回市场活动记录的列表。所需权限：Read-Only 市场活动、Read-Write 市场活动注意：此终结点已被取代。请改用 “获取智能市场活动 ”终结点。
获取文件	返回给定文件夹中的文件。所需权限：Read-Only 资产、Read-Write 资产
获取文件夹	从给定根文件夹中检索子文件夹。所需权限：Read-Only 资产、Read-Write 资产
获取文件夹内容	返回给定文件夹内容的记录。所需权限：Read-Only 资产、Read-Write 资产
获取智能列表	检索用户创建的智能列表记录的列表。所需权限：Read-Asset 或 Read-Write 资产
获取程序	从目标实例检索可访问程序的列表。所需权限：Read-Only 资产、Read-Write 资产
获取计划成员	返回特定字段中值列表中最多 300 个程序成员的列表。如果指定作为自定义字段的 filterType，则自定义字段的 dataType 必须是“string”或“integer”。如果指定除“leadId”以外的 filterType，请求最多可以处理 100,000 条程序成员记录。所需权限：Read-Only 潜在顾客、Read-Write 潜在顾客
获取静态列表	检索静态列表记录的列表。所需权限：Read-Asset 或 Read-Write 资产
计划市场活动	远程计划在给定时间运行的批处理市场活动。可以在市场活动的父计划本地重写我的令牌，以便运行自定义内容。使用下面所述的“cloneToProgramName”参数时，此终结点限制为每天 20 次调用。所需权限：执行市场活动
请求市场活动	将一组潜在顾客传递给触发器市场活动，以通过市场活动流运行。指定的市场活动必须请求市场活动：Web 服务 API 触发器，并且必须处于活动状态。可以在市场活动的父计划本地重写我的令牌，以便运行自定义内容。每个呼叫最多允许 100 个潜在顾客。所需权限：执行市场活动
身份	从 Marketo 检索访问令牌。对此终结点的调用不计入 API 调用限制。
身份	从 Marketo 检索访问令牌。对此终结点的调用不计入 API 调用限制。

从列表中删除

操作 ID:: removeLeadsFromListUsingDELETE

从目标静态列表中删除一组给定的人员记录。所需权限：Read-Write 潜在顾客

参数

名称	密钥	必需	类型	说明
要从中删除潜在顾客的静态列表的 ID	listId	True	integer	要从中删除潜在顾客的静态列表的 ID
id	id	True	integer	潜在顾客记录的唯一整数 ID
id	id	True	array	id

Body: ResponseOfListOperationOutputData

克隆智能列表

操作 ID:: cloneSmartListUsingPOST

克隆指定的智能列表。所需权限：Read-Write 资产

参数

名称	密钥	必需	类型	说明
要克隆的智能列表的 ID	id	True	integer	要克隆的智能列表的 ID
姓名	name	True	string	克隆智能列表的名称
id	id	True	integer	文件夹的 ID
类型	type	True	string	文件夹的类型
描述	description		string	克隆智能列表的说明

Body: ResponseOfSmartListResponse

克隆程序

操作 ID:: cloneProgramUsingPOST

克隆目标程序。所需权限：Read-Write 资产

参数

名称	密钥	必需	类型	说明
程序 ID	id	True	integer	id
描述	description		string
id	id	True	integer	文件夹的 ID
类型	type	True	string	文件夹的类型
姓名	name	True	string	程序的名称。最多 255 个字符

Body: ResponseOfProgramResponse

列表成员

操作 ID:: areLeadsMemberOfListUsingGET

检查潜在顾客是否是给定静态列表的成员。所需权限：Read-Write 潜在顾客

参数

名称	密钥	必需	类型	说明
要检查的静态列表的 ID	listId	True	integer	要检查的静态列表的 ID
id	id	True	integer	潜在顾客记录的唯一整数 ID
要检查的潜在顾客 ID 的逗号分隔列表	id		array	要检查的潜在顾客 ID 的逗号分隔列表

Body: ResponseOfListOperationOutputData

创建导出潜在顾客作业

操作 ID:: createExportLeadsUsingPOST

为通过“filter”参数定义的搜索条件创建导出作业。请求返回在后续调用批量导出潜在顾客终结点时作为参数传递的“exportId”。使用排队导出潜在顾客作业终结点将导出作业排队进行处理。使用“获取导出潜在顾客作业状态”终结点检索导出作业的状态。所需权限：Read-Only 潜在顾客

参数

名称	密钥	必需	类型	说明
姓名	name	True	string	标头字段的 REST API 名称
value	value	True	string	标头字段的值
fields	fields	True	array of string	要包含在文件中的字段的逗号分隔列表
endAt	endAt		string	日期范围筛选器的结束时间（ISO 8601 格式）
startAt	startAt		string	日期范围筛选器（ISO-8601 格式）
smartListId	smartListId	True	integer	要从中检索潜在顾客的智能列表的 ID
smartListName	smartListName	True	string	要从中检索潜在顾客的智能列表的名称
staticListId	staticListId	True	integer	要从中检索潜在顾客的静态列表的 ID
staticListName	staticListName	True	string	要从中检索潜在顾客的静态列表的名称
格式	format		string	要创建的文件格式（“CSV”、“TSV”、“SSV”）。默认值为“CSV”

Body: ResponseOfExportResponse

创建导出程序成员作业

操作 ID:: createExportProgramMembersUsingPOST

为通过“filter”参数定义的搜索条件创建导出作业。请求返回在对批量导出程序成员终结点的后续调用中作为参数传递的“exportId”。

参数

名称	密钥	必需	类型	说明
姓名	name	True	string	标头字段的 REST API 名称
value	value	True	string	标头字段的值
fields	fields	True	array of string	要包含在文件中的字段的逗号分隔列表
programId	programId	True	integer	要从中检索成员的程序的 ID。不能与“programIds”筛选器结合使用
programIds	programIds	True	array of integer	要从中检索成员的程序 ID 数组。不能与“programId”筛选器结合使用
isExhausted	isExhausted		boolean	筛选已耗尽内容的人员的程序成员身份记录
nurtureCadence	nurtureCadence		string	筛选给定培养节奏的计划成员身份记录
statusNames	statusNames		array of string	程序成员状态名称的数组。可以是默认值和/或用户定义的。多个状态名称一起为 ORed。
endAt	endAt		string	日期范围筛选器的结束时间（ISO 8601 格式）
startAt	startAt		string	日期范围筛选器（ISO-8601 格式）
格式	format		string	要创建的文件格式（“CSV”、“TSV”、“SSV”）。默认值为“CSV”

Body: ResponseOfExportResponse

创建文件

操作 ID:: createFileUsingPOST

从包含的有效负载创建新文件。所需权限：Read-Write 资产

参数

名称	密钥	必需	类型	说明
描述	description		string	资产说明
文件	file	True	string	多部分文件。文件的内容。
id	id	True	integer	文件夹的 ID
类型	type	True	string	文件夹的类型
insertOnly	insertOnly		boolean	如果已有具有相同名称的现有文件，调用是否失败
姓名	name	True	string	文件的名称

Body: ResponseOfFileResponse

创建文件夹

操作 ID:: createFolderUsingPOST

创建新文件夹。所需权限：Read-Write 资产

参数

名称	密钥	必需	类型	说明
描述	description		string	资产说明
姓名	name	True	string	文件夹的名称
id	id	True	integer	文件夹的 ID
类型	type	True	string	文件夹的类型

Body: ResponseOfFolderResponse

创建程序

操作 ID:: createProgramUsingPOST

创建新程序。所需权限：Read-Write 资产

参数

名称	密钥	必需	类型	说明
通道	channel	True	string	程序的频道
成本	cost	True	integer	成本金额
注意	note		string	成本说明
startDate	startDate	True	date-time	周期成本的开始日期
描述	description		string
id	id	True	integer	文件夹的 ID
类型	type	True	string	文件夹的类型
姓名	name	True	string	程序的名称
tagType	tagType		string	程序标记的类型
标签值	tagValue		string	标记的值
类型	type	True	string	程序的类型

Body: ResponseOfProgramResponse

创建静态列表

操作 ID:: createStaticListUsingPOST

创建新的静态列表。所需权限：Read-Write 资产

参数

名称	密钥	必需	类型	说明
描述	description		string	静态列表的说明
姓名	name	True	string	静态列表的名称
id	id	True	integer	文件夹的 ID
类型	type	True	string	文件夹的类型

Body: ResponseOfStaticListResponse

删除文件夹

操作 ID:: deleteFolderUsingPOST

删除指定的文件夹。如果文件夹包含内容，则删除将失败。所需权限：Read-Write 资产

参数

名称	密钥	必需	类型	说明
要删除的文件夹的 ID	id	True	integer	要删除的文件夹的 ID
文件夹的类型	type	True	string	类型

Body: ResponseOfIdResponse

删除智能列表

操作 ID:: deleteSmartListByIdUsingPOST

删除指定的智能列表。所需权限：Read-Write 资产

参数

名称	密钥	必需	类型	说明
要删除的智能列表的 ID	id	True	integer	要删除的智能列表的 ID

Body: ResponseOfIdResponse

删除潜在顾客

操作 ID:: deleteLeadsUsingPOST

从目标实例中删除潜在顾客列表。所需权限：Read-Write 潜在顾客

参数

名称	密钥	必需	类型	说明
id	id	True	integer	潜在顾客记录的唯一整数 ID
如果请求正文为空，则可以指定参数。	id		array	如果请求正文为空，则可以指定参数。可以指定多个潜在顾客 ID。例如 id=1,2,3,2342

Body: ResponseOfLead

删除程序

操作 ID:: deleteProgramUsingPOST

删除目标程序。程序可能不包含在程序外部使用的任何资产。所需权限：Read-Write 资产

参数

名称	密钥	必需	类型	说明
程序 ID	id	True	integer	id

Body: ResponseOfIdResponse

删除程序标记

操作 ID:: deleteProgramTagUsingPOST

删除非必需的程序标记。所需权限：Read-Write 资产

参数

名称	密钥	必需	类型	说明
程序 ID	id	True	integer	id
程序标记的类型	tagType	True	string	程序标记的类型

Body: ResponseOfIdResponse

删除计划成员

操作 ID:: deleteProgramMemberUsingPOST

从目标实例中删除成员列表。所需权限：Read-Write 潜在顾客

参数

名称	密钥	必需	类型	说明
目标程序的 ID。	programId	True	integer	目标程序的 ID。
leadId	leadId	True	integer	潜在顾客记录的唯一整数 ID

Body: ResponseOfProgramMemberDelete

删除静态列表

操作 ID:: deleteStaticListByIdUsingPOST

删除指定的静态列表。所需权限：Read-Write 资产

参数

名称	密钥	必需	类型	说明
要删除的静态列表的 ID	id	True	integer	要删除的静态列表的 ID

Body: ResponseOfIdResponse

取消导出潜在顾客作业

操作 ID:: cancelExportLeadsUsingPOST

取消导出作业。所需权限：Read-Only 潜在顾客

参数

名称	密钥	必需	类型	说明
导出批处理作业的 ID。	exportId	True	string	导出批处理作业的 ID。

Body: ResponseOfExportResponse

取消导出程序成员作业

操作 ID:: cancelExportProgramMembersUsingPOST

取消导出作业。所需权限：Read-Only 潜在顾客

参数

名称	密钥	必需	类型	说明
导出批处理作业的 ID。	exportId	True	string	导出批处理作业的 ID。

Body: ResponseOfExportResponse

取消批准计划

操作 ID:: unapproveProgramUsingPOST

取消应用目标程序。仅适用于已批准的电子邮件程序。所需权限：Read-Write 资产

参数

名称	密钥	必需	类型	说明
程序 ID	id	True	integer	id

Body: ResponseOfIdResponse

同步潜在顾客

操作 ID:: syncLeadUsingPOST

将潜在顾客列表同步到目标实例。所需权限：Read-Write 潜在顾客

参数

名称	密钥	必需	类型	说明
操作	action		string	要执行的同步作的类型。如果未设置，则默认值为 createOrUpdate
asyncProcessing	asyncProcessing		boolean	如果设置为 true，则调用将立即返回
id	id		integer	潜在顾客记录的唯一整数 ID
acquiredBy	acquiredBy		boolean	潜在顾客是否由父计划获取
isExhausted	isExhausted		boolean	潜在客户当前是否在流中耗尽（如果适用）
membershipDate	membershipDate	True	string	潜在客户首次成为该计划的成员的日期
nurtureCadence	nurtureCadence		string	父流的节奏（如果适用）
progressionStatus	progressionStatus	True	string	父程序中潜在顾客的计划状态
reachedSuccess	reachedSuccess		boolean	潜在顾客是否处于父计划的成功状态
数据流	stream		string	如果父计划是参与计划的成员，则流式传输潜在顾客是参与计划的成员
代码	code	True	string	原因的整数代码
消息	message	True	string	描述作状态原因的消息
状态	status		string	对记录执行的作的状态
lookupField	lookupField		string	要删除重复数据的字段。该字段必须存在于输入的每个潜在顾客记录中。如果未设置，则默认为电子邮件
partitionName	partitionName		string	要作的分区的名称（如果适用）。在与启用了分区的实例交互时，应尽可能设置。

Body: ResponseOfLead

同步程序成员数据

操作 ID:: syncProgramMemberDataUsingPOST

更改目标计划中潜在顾客列表的程序成员数据。只有程序的现有成员才能使用此 API 更改其数据。所需权限：Read-Write 潜在顾客

参数

名称	密钥	必需	类型	说明
目标程序的 ID。	programId	True	integer	目标程序的 ID。
leadId	leadId	True	integer	潜在顾客记录的唯一整数 ID
{fieldApiName}	{fieldApiName}	True	string	要更新的字段的 API 名称。必须可更新，如描述计划成员终结点所述。
{fieldApiName2}	{fieldApiName2}		string	要更新的另一个字段的 API 名称（等等）。必须可更新，如描述计划成员终结点所述。

Body: ResponseOfProgramMemberData

同步计划成员状态

操作 ID:: syncProgramMemberStatusUsingPOST

更改目标计划中潜在顾客列表的程序成员状态。如果成员不是计划的一部分，则成员将添加到该计划。所需权限：Read-Write 潜在顾客

参数

名称	密钥	必需	类型	说明
目标程序的 ID。	programId	True	integer	目标程序的 ID。
statusName	statusName	True	string	计划成员状态
leadId	leadId	True	integer	潜在顾客记录的唯一整数 ID

Body: ResponseOfProgramMemberStatus

导入潜在顾客

操作 ID:: importLeadUsingPOST

将包含数据记录的文件导入目标实例。所需权限：Read-Write 潜在顾客

参数

名称	密钥	必需	类型	说明
导入文件格式。	format	True	string	导入文件格式。
用于重复数据删除的字段。自定义字段（字符串、电子邮件、整数）	lookupField		string	用于重复数据删除的字段。支持自定义字段（字符串、电子邮件、整数）和以下字段类型：id、cookie、email、twitterId、facebookId、linkedInId、sfdcAccountId、sfdcContactId、sfdcLeadId、sfdcLeadOwnerId、sfdcOpptyId。默认值为电子邮件。注意：可以将 ID 用于仅更新作。
要导入到的潜在顾客分区的名称。	partitionName		string	要导入到的潜在顾客分区的名称。
要导入到的静态列表的 ID。	listId		integer	要导入到的静态列表的 ID。
包含要导入的数据记录的文件。	file	True	file	包含要导入的数据记录的文件。

Body: ResponseOfImportLeadResponse

导入计划成员

操作 ID:: importProgramMemberUsingPOST

将包含数据记录的文件导入目标实例。所需权限：Read-Write 潜在顾客

参数

名称	密钥	必需	类型	说明
要向其添加成员的程序的 ID。	programId	True	string	要向其添加成员的程序的 ID。
正在添加的成员的程序成员状态。	programMemberStatus	True	string	正在添加的成员的程序成员状态。
导入文件格式。	format	True	string	导入文件格式。
包含要导入的数据记录的文件。	file	True	file	包含要导入的数据记录的文件。

Body: ResponseOfImportProgramMemberResponse

将潜在客户推送到 Marketo

操作 ID:: pushToMarketoUsingPOST

向上插入潜在顾客并生成推送潜在顾客到 Marketo 活动。所需权限：Read-Write 潜在顾客

参数

名称	密钥	必需	类型	说明
id	id		integer	潜在顾客记录的唯一整数 ID
代码	code	True	string	原因的整数代码
消息	message	True	string	描述作状态原因的消息
状态	status		string	对记录执行的作的状态
lookupField	lookupField		string
partitionName	partitionName		string
programName	programName		string
programStatus	programStatus		string
原因	reason		string
源	source		string

Body: ResponseOfPushLeadToMarketo

批准计划

操作 ID:: approveProgramUsingPOST

批准目标计划。仅适用于未经批准的电子邮件程序。所需权限：Read-Write 资产

参数

名称	密钥	必需	类型	说明
程序 ID	id	True	integer	id

Body: ResponseOfIdResponse

按 ID 获取列表

操作 ID:: getListByIdUsingGET

按 ID 返回列表记录。所需权限：Read-Only 潜在顾客，Read-Write 潜在顾客

参数

名称	密钥	必需	类型	说明
要从中检索记录的静态列表的 ID	listId	True	integer	要从中检索记录的静态列表的 ID

Body: ResponseOfStaticList

按 ID 获取市场活动

操作 ID:: getCampaignByIdUsingGET

按 ID 返回市场活动记录。所需权限：Read-Only 市场活动，Read-Write 市场活动

注意：此终结点已被取代。 请改用 Id 终结点获取智能市场活动。

参数

名称	密钥	必需	类型	说明
campaignId	campaignId	True	integer	campaignId

Body: ResponseOfCampaign

按 ID 获取文件

操作 ID:: getFileByIdUsingGET

返回给定 ID 的文件记录。所需权限：Read-Only 资产，Read-Write 资产

参数

名称	密钥	必需	类型	说明
文件的 ID	id	True	integer	数据库中文件的 ID

Body: ResponseOfFileResponse

按 ID 获取文件夹

操作 ID:: getFolderByIdUsingGET

返回具有给定 ID 的文件夹记录。所需权限：Read-Only 资产，Read-Write 资产

参数

名称	密钥	必需	类型	说明
要检索的文件夹的 ID	id	True	integer	要检索的文件夹的 ID
文件夹的类型（程序或文件夹）	type	True	string	文件夹的类型。 “Folder”或“Program”

Body: ResponseOfFolderResponse

按 ID 获取智能列表

操作 ID:: getSmartListByIdUsingGET

按 ID 检索智能列表记录。所需权限：Read-Asset 或 Read-Write 资产

参数

名称	密钥	必需	类型	说明
要检索的智能列表的 ID	id	True	integer	要检索的智能列表的 ID
设置为 true 以填充智能列表规则。默认 false	includeRules		boolean	设置为 true 以填充智能列表规则。默认 false

Body: ResponseOfSmartListResponseWithRules

按 ID 获取潜在顾客

操作 ID:: getLeadByIdUsingGET

通过 Marketo ID 检索单个潜在顾客记录。所需权限：Read-Only 潜在顾客，Read-Write 潜在顾客

参数

名称	密钥	必需	类型	说明
Marketo 潜在顾客 ID	leadId	True	integer	Marketo 潜在顾客 ID
字段名称的逗号分隔列表。	fields		array	字段名称的逗号分隔列表。如果省略，将返回以下默认字段：电子邮件、updatedAt、createdAt、lastName、firstName 和 id。

Body: ResponseOfLead

按 ID 获取程序

操作 ID:: getProgramByIdUsingGET

检索给定 ID 的程序记录。所需权限：Read-Only 资产，Read-Write 资产

参数

名称	密钥	必需	类型	说明
程序 ID	id	True	integer	id

Body: ResponseOfProgramResponse

按 ID 获取静态列表

操作 ID:: getStaticListByIdUsingGET

按 ID 检索静态列表记录。所需权限：Read-Asset 或 Read-Write 资产

参数

名称	密钥	必需	类型	说明
要检索的静态列表的 ID	id	True	integer	要检索的静态列表的 ID

Body: ResponseOfStaticListResponse

按列表 ID 获取潜在顾客

操作 ID:: getLeadsByListIdUsingGET_1

检索属于给定静态列表的成员的人员记录。所需权限：Read-Only 潜在顾客、Read-Write 潜在顾客

参数

名称	密钥	必需	类型	说明
要从中检索记录的静态列表的 ID	listId	True	integer	要从中检索记录的静态列表的 ID
要为每个记录返回的潜在客户字段的逗号分隔列表。	fields		array	要为每个记录返回的潜在客户字段的逗号分隔列表。如果取消设置将返回电子邮件、updatedAt、createdAt、lastName、firstName 和 id
要返回的批大小。最大值和默认值为 300。	batchSize		integer	要返回的批大小。最大值和默认值为 300。
此终结点将返回令牌。有关详细信息，请参阅分页令牌。	nextPageToken		string	如果结果集大于批大小，并且可以通过此参数在后续调用中传递令牌，则此终结点将返回令牌。有关详细信息，请参阅分页令牌。

Body: ResponseOfLead

按列表 ID 获取潜在顾客

操作 ID:: getLeadsByListIdUsingGET

检索属于给定静态列表的成员的人员记录。所需权限：Read-Only 潜在顾客、Read-Write 潜在顾客

参数

名称	密钥	必需	类型	说明
要从中检索记录的静态列表的 ID	listId	True	integer	要从中检索记录的静态列表的 ID
要为每个记录返回的潜在客户字段的逗号分隔列表。	fields		array	要为每个记录返回的潜在客户字段的逗号分隔列表。如果取消设置将返回电子邮件、updatedAt、createdAt、lastName、firstName 和 id
要返回的批大小。最大值和默认值为 300。	batchSize		integer	要返回的批大小。最大值和默认值为 300。
此终结点将返回令牌。有关详细信息，请参阅分页令牌。	nextPageToken		string	如果结果集大于批大小，并且可以通过此参数在后续调用中传递令牌，则此终结点将返回令牌。有关详细信息，请参阅分页令牌。

Body: ResponseOfLeadByListId

按名称获取文件

操作 ID:: getFileByNameUsingGET

返回给定名称的文件记录。所需权限：Read-Only 资产、Read-Write 资产

参数

名称	密钥	必需	类型	说明
文件名称	name	True	string	文件的名称

Body: ResponseOfFileResponse

按名称获取文件夹

操作 ID:: getFolderByNameUsingGET

返回给定名称的文件夹记录。所需权限：Read-Only 资产、Read-Write 资产

参数

名称	密钥	必需	类型	说明
文件夹的名称	name	True	string	文件夹的名称。不适用于程序
文件夹的类型（程序或文件夹）	type		string	文件夹的类型。 “Folder”或“Program”
父文件夹引用	root		string	父文件夹引用
工作区的名称	workSpace		string	工作区的名称

Body: ResponseOfFolderResponse

按名称获取智能列表

操作 ID:: getSmartListByNameUsingGET

按名称检索智能列表记录。所需权限：Read-Asset 或 Read-Write 资产

参数

名称	密钥	必需	类型	说明
要检索的智能列表的名称	name	True	string	要检索的智能列表的名称

Body: ResponseOfSmartListResponse

按名称获取潜在顾客字段

操作 ID:: getLeadFieldByNameUsingGET

检索单个潜在顾客字段的元数据。所需权限：Read-Write 架构标准字段、Read-Write 架构自定义字段

参数

名称	密钥	必需	类型	说明
潜在顾客字段的 API 名称	fieldApiName	True	string	潜在顾客字段的 API 名称

Body: ResponseOfLeadField

按名称获取程序

操作 ID:: getProgramByNameUsingGET

检索给定名称的程序记录。所需权限：Read-Only 资产、Read-Write 资产

参数

名称	密钥	必需	类型	说明
程序的名称	name	True	string	程序的名称
设置为 true 以填充程序标记	includeTags		boolean	设置为 true 以填充程序标记
设置为 true 以填充计划成本	includeCosts		boolean	设置为 true 以填充计划成本

Body: ResponseOfProgramResponse

按名称获取程序成员字段

操作 ID:: getProgramMemberFieldByNameUsingGET

检索单个程序成员字段的元数据。所需权限：Read-Write 架构标准字段、Read-Write 架构自定义字段

参数

名称	密钥	必需	类型	说明
程序成员字段的 API 名称	fieldApiName	True	string	程序成员字段的 API 名称

Body: ResponseOfLeadField

按名称获取静态列表

操作 ID:: getStaticListByNameUsingGET

按名称检索静态列表记录。所需权限：Read-Asset 或 Read-Write 资产

参数

名称	密钥	必需	类型	说明
要检索的静态列表的名称	name	True	string	要检索的静态列表的名称

Body: ResponseOfStaticListResponse

按标记获取程序

操作 ID:: getProgramListByTagUsingGET

检索与给定标记类型和标记值匹配的程序的列表。所需权限：Read-Only 资产、Read-Write 资产

参数

名称	密钥	必需	类型	说明
程序标记的类型	tagType	True	string	程序标记的类型
标记的值	tagValue	True	string	标记的值
要返回的最大通道数。最大 200，默认值 20	maxReturn		integer	要返回的最大通道数。最大 200，默认值 20
分页的整数偏移量	offset		integer	分页的整数偏移量

Body: ResponseOfProgramResponse

按程序 ID 获取智能列表

操作 ID:: getSmartListByProgramIdUsingGET

按电子邮件程序 ID 检索智能列表记录。所需权限：Read-Asset 或 Read-Write 资产

参数

名称	密钥	必需	类型	说明
包含要检索的智能列表的电子邮件程序的 ID	programId	True	integer	包含要检索的智能列表的电子邮件程序的 ID
设置为 true 以填充智能列表规则。默认 false	includeRules		boolean	设置为 true 以填充智能列表规则。默认 false

Body: ResponseOfSmartListResponseWithRules

按筛选器类型获取潜在顾客

操作 ID:: getLeadsByFilterUsingGET

根据特定字段中的值列表返回最多 300 个潜在顾客的列表。所需权限：Read-Only 潜在顾客、Read-Write 潜在顾客

参数

名称	密钥	必需	类型	说明
要筛选的潜在客户字段。	filterType	True	string	要筛选的潜在客户字段。支持任何自定义字段（仅字符串、电子邮件或整数类型），以及以下任何字段：cookie、email、facebookId、id、leadPartitionId、linkedInId、sfdcAccountId、sfdcContactId、sfdcLeadId、sfdcLeadOwnerId、sfdcLeadOwnerId、sfdcOpptyId、twitterId。可以通过 Describe Lead2 终结点获取字段的综合列表。
要筛选在指定字段中的值的逗号分隔列表。	filterValues	True	array	要筛选在指定字段中的值的逗号分隔列表。
要为每个记录返回的潜在客户字段的逗号分隔列表	fields		array	要为每个记录返回的潜在客户字段的逗号分隔列表
要返回的批大小。最大值和默认值为 300。	batchSize		integer	要返回的批大小。最大值和默认值为 300。
此终结点将返回令牌。有关详细信息，请参阅分页令牌。	nextPageToken		string	如果结果集大于批大小，并且可以通过此参数在后续调用中传递令牌，则此终结点将返回令牌。有关详细信息，请参阅分页令牌。

Body: ResponseOfLead

按计划 ID 获取潜在顾客

操作 ID:: getLeadsByProgramIdUsingGET

检索作为指定程序成员的潜在顾客列表。所需权限：Read-Only 潜在顾客、Read-Write 潜在顾客

参数

名称	密钥	必需	类型	说明
要从中检索的程序的 ID	programId	True	integer	要从中检索的程序的 ID
要为每个记录返回的字段的逗号分隔列表	fields		array	要为每个记录返回的字段的逗号分隔列表
要返回的批大小。最大值和默认值为 300。	batchSize		integer	要返回的批大小。最大值和默认值为 300。
此终结点将返回令牌。有关详细信息，请参阅分页令牌。	nextPageToken		string	如果结果集大于批大小，并且可以通过此参数在后续调用中传递令牌，则此终结点将返回令牌。有关详细信息，请参阅分页令牌。

Body: ResponseOfLead

排队导出潜在顾客作业

操作 ID:: enqueueExportLeadsUsingPOST

排队导出作业。这会将导出作业置于队列中，并在计算资源可用时启动作业。导出作业必须处于“已创建”状态。使用“获取导出潜在顾客作业状态”终结点检索导出作业的状态。所需权限：Read-Only 潜在顾客

参数

名称	密钥	必需	类型	说明
导出批处理作业的 ID。	exportId	True	string	导出批处理作业的 ID。

Body: ResponseOfExportResponse

排队导出程序成员作业

操作 ID:: enqueueExportProgramMembersUsingPOST

排队导出作业。这会将导出作业置于队列中，并在计算资源可用时启动作业。导出作业必须处于“已创建”状态。

参数

名称	密钥	必需	类型	说明
批处理作业的 ID。	exportId	True	string	导出批处理作业的 ID。

Body: ResponseOfExportResponse

描述潜在顾客

操作 ID:: describeUsingGET_2

返回有关目标实例中潜在顾客对象的元数据，包括可用于通过 API 交互的所有字段的列表。所需权限：Read-Only 潜在顾客、Read-Write 潜在顾客

注意：此终结点已被取代。 请改用 “描述潜在顾客 2 ”终结点。

Body: ResponseOfLeadAttribute

描述潜在顾客 2

操作 ID:: describeUsingGET_6

返回目标实例中潜在顾客对象的可搜索字段列表。所需权限：Read-Only 潜在顾客、Read-Write 潜在顾客

Body: ResponseOfLeadAttribute2

描述计划成员

操作 ID:: describeProgramMemberUsingGET

返回有关目标实例中的程序成员对象的元数据，包括可用于通过 API 交互的所有字段的列表。所需权限：Read-Only 潜在顾客、Read-Write 潜在顾客

注意：此终结点已被取代。 请改用 “描述计划成员 ”终结点。

Body: ResponseOfProgramMemberAttributes

描述计划成员

操作 ID:: describeProgramMemberUsingGET2

返回有关目标实例中的程序成员对象的元数据，包括可用于通过 API 交互的所有字段的列表。所需权限：Read-Only 潜在顾客、Read-Write 潜在顾客

Body: ResponseOfProgramMemberAttributes2

更新文件内容

操作 ID:: updateContentUsingPOST

将文件的当前内容替换为包含的有效负载。所需权限：Read-Write 资产

参数

名称	密钥	必需	类型	说明
文件的 ID	id	True	integer	数据库中文件的 ID
文件	file	True	string	多部分文件。文件的内容。
id	id	True	integer	文件的 ID

Body: ResponseOfFileResponse

更新文件夹元数据

操作 ID:: updateFolderUsingPOST

更新给定文件夹的元数据。所需权限：Read-Write 资产

参数

名称	密钥	必需	类型	说明
要更新的文件夹的 ID	id	True	integer	要更新的文件夹的 ID
描述	description		string	资产说明
isArchive	isArchive		boolean	文件夹是否存档。切换此值将更改文件夹的存档状态
姓名	name		string	文件夹的名称
类型	type	True	string	文件夹的类型。 “Folder”或“Program”

Body: ResponseOfFolderResponse

更新潜在顾客字段

操作 ID:: updateLeadFieldUsingPOST

更新目标实例中潜在顾客字段的元数据。请参阅此处的更新规则。所需权限：Read-Write 架构标准字段、Read-Write 架构自定义字段

参数

名称	密钥	必需	类型	说明
潜在顾客字段的 API 名称	fieldApiName	True	string	潜在顾客字段的 API 名称
displayName	displayName		string	字段的 UI 显示名称
描述	description		string	字段的说明
isHidden	isHidden		boolean	如果设置为 true，则隐藏该字段。默认值为 false
isHtmlEncodingInEmail	isHtmlEncodingInEmail		boolean	如果设置为 true，则字段在电子邮件中编码为 HTML。默认值为 true
isSensitive	isSensitive		boolean	如果设置为 true，则字段标记为敏感。默认值为 false

Body: ResponseOfUpdateLeadField

更新程序元数据

操作 ID:: updateProgramUsingPOST

更新目标程序的元数据。所需权限：Read-Write 资产

参数

名称	密钥	必需	类型	说明
程序 ID	id	True	integer	id
成本	cost	True	integer	成本金额
注意	note		string	成本说明
startDate	startDate	True	date-time	周期成本的开始日期
costsDestructiveUpdate	costsDestructiveUpdate		boolean	设置为 true 以销毁现有成本，并将其替换为指定的成本
描述	description		string	更新了程序的说明
结束日期	endDate		string	程序的结束日期。适用于活动、电子邮件和网络研讨会类型程序
姓名	name		string	程序的名称
startDate	startDate		string	程序的开始日期。适用于活动、电子邮件和网络研讨会类型程序
tagType	tagType		string	程序标记的类型
标签值	tagValue		string	标记的值

Body: ResponseOfProgramResponse

更新程序标记

操作 ID:: updateProgramTagUsingPOST

更新程序标记。所需权限：Read-Write 资产

参数

名称	密钥	必需	类型	说明
程序 ID	id	True	integer	id
程序标记的类型	tagType	True	string	程序标记的类型
程序标记的值	tagValue	True	string	程序标记的值

Body: ResponseOfIdResponse

更新静态列表元数据

操作 ID:: updateStaticListUsingPOST

更新静态列表资产的元数据。所需权限：Read-Write 资产

参数

名称	密钥	必需	类型	说明
要更新的静态列表的 ID	id	True	integer	要更新的静态列表的 ID
描述	description		string	静态列表的说明
姓名	name		string	静态列表的名称

Body: ResponseOfStaticListResponse

添加到列表

操作 ID:: addLeadsToListUsingPOST

将一组给定的人员记录添加到目标静态列表。每个请求的潜在客户 ID 限制为 300 个。所需权限：Read-Write 潜在顾客

参数

名称	密钥	必需	类型	说明
目标列表的 ID	listId	True	integer	目标列表的 ID
id	id	True	integer	潜在顾客记录的唯一整数 ID
要添加到列表中的潜在顾客 ID 的逗号分隔列表	id		array	要添加到列表中的潜在顾客 ID 的逗号分隔列表

Body: ResponseOfListOperationOutputData

获取列表

操作 ID:: getListsUsingGET

基于给定的筛选器参数返回一组静态列表记录。所需权限：Read-Only 潜在顾客、Read-Write 潜在顾客

参数

名称	密钥	类型	说明
要返回的静态列表 ID 的逗号分隔列表	id	array	要返回的静态列表 ID 的逗号分隔列表
要返回的静态列表名称的逗号分隔列表	name	array	要返回的静态列表名称的逗号分隔列表
以逗号分隔的程序名称列表。	programName	array	以逗号分隔的程序名称列表。如果 set 将返回属于给定程序子级的所有静态列表
以逗号分隔的工作区名称列表。	workspaceName	array	以逗号分隔的工作区名称列表。如果设置将返回属于给定工作区子级的所有静态列表
要返回的批大小。最大值和默认值为 300。	batchSize	integer	要返回的批大小。最大值和默认值为 300。
此终结点将返回令牌。有关详细信息，请参阅分页令牌。	nextPageToken	string	如果结果集大于批大小，并且可以通过此参数在后续调用中传递令牌，则此终结点将返回令牌。有关详细信息，请参阅分页令牌。

Body: ResponseOfStaticList

获取导入潜在顾客失败

操作 ID:: getImportLeadFailuresUsingGET

返回导入批处理作业的失败列表。所需权限：Read-Write 潜在顾客

参数

名称	密钥	必需	类型	说明
导入批处理作业的 ID。	batchId	True	integer	导入批处理作业的 ID。

response: object

获取导入潜在顾客状态

操作 ID:: getImportLeadStatusUsingGET

返回导入批处理作业的状态。所需权限：Read-Write 潜在顾客

参数

名称	密钥	必需	类型	说明
导入批处理作业的 ID。	batchId	True	integer	导入批处理作业的 ID。

Body: ResponseOfImportLeadResponse

获取导入潜在顾客警告

操作 ID:: getImportLeadWarningsUsingGET

返回导入批处理作业的警告列表。所需权限：Read-Write 潜在顾客

参数

名称	密钥	必需	类型	说明
导入批处理作业的 ID。	batchId	True	integer	导入批处理作业的 ID。

response: object

获取导入程序成员失败

操作 ID:: getImportProgramMemberFailuresUsingGET

返回导入批处理作业的失败列表。所需权限：Read-Write 潜在顾客

参数

名称	密钥	必需	类型	说明
导入批处理作业的 ID。	batchId	True	integer	导入批处理作业的 ID。

response: object

获取导入程序成员警告

操作 ID:: getImportProgramMemberWarningsUsingGET

返回导入批处理作业的警告列表。所需权限：Read-Write 潜在顾客

参数

名称	密钥	必需	类型	说明
导入批处理作业的 ID。	batchId	True	integer	导入批处理作业的 ID。

response: object

获取导入计划成员状态

操作 ID:: getImportProgramMemberStatusUsingGET

返回导入批处理作业的状态。所需权限：Read-Write 潜在顾客

参数

名称	密钥	必需	类型	说明
导入批处理作业的 ID。	batchId	True	integer	导入批处理作业的 ID。

Body: ResponseOfImportProgramMemberResponse

获取导出潜在顾客作业

操作 ID:: getExportLeadsUsingGET

返回在过去 7 天内创建的导出作业的列表。所需权限：Read-Only 潜在顾客

参数

名称	密钥	类型	说明
要筛选的状态的逗号分隔列表。	status	array	要筛选的状态的逗号分隔列表。
要返回的批大小。最大值和默认值为 300。	batchSize	integer	要返回的批大小。最大值和默认值为 300。
下一页令牌	nextPageToken	string	如果结果集大于批大小，并且可以通过此参数在后续调用中传递令牌，则此终结点将返回令牌。有关详细信息，请参阅分页令牌。

Body: ResponseOfExportResponseWithToken

获取导出潜在顾客作业状态

操作 ID:: getExportLeadsStatusUsingGET

返回导出作业的状态。作业状态在达到“已完成”或“失败”状态后 30 天内可用。所需权限：Read-Only 潜在顾客

参数

名称	密钥	必需	类型	说明
导出批处理作业的 ID。	exportId	True	string	导出批处理作业的 ID。

Body: ResponseOfExportResponse

获取导出潜在顾客文件

操作 ID:: getExportLeadsFileUsingGET

返回导出作业的文件内容。导出作业必须处于“已完成”状态。使用“获取导出潜在顾客作业状态”终结点检索导出作业的状态。所需权限：Read-Only 潜在顾客

文件格式是通过调用“创建导出潜在顾客作业”终结点指定的。下面是默认文件格式（“CSV”）的示例。

firstName,lastName,email
Marvin,Gaye,marvin.gaye@motown.com

参数

名称	密钥	必需	类型	说明
导出批处理作业的 ID。	exportId	True	string	导出批处理作业的 ID。
支持部分检索提取的数据	Range		string	为了支持部分检索提取的数据，可以指定类型为“bytes”的 HTTP 标头“Range”。有关详细信息，请参阅 RFC 2616“范围检索请求”。如果未设置标头，将返回整个内容。

response: object

获取导出程序成员文件

操作 ID:: getExportProgramMembersFileUsingGET

返回导出作业的文件内容。导出作业必须处于“已完成”状态。使用“获取导出计划成员作业状态”终结点检索导出作业的状态。所需权限：Read-Only 潜在顾客

文件格式是通过调用“创建导出程序成员作业”终结点指定的。下面是默认文件格式（“CSV”）的示例。

firstName,lastName,email
Marvin,Gaye,marvin.gaye@motown.com

参数

名称	密钥	必需	类型	说明
导出批处理作业的 ID。	exportId	True	string	导出批处理作业的 ID。
支持部分检索提取的数据。	Range		string	为了支持部分检索提取的数据，可以指定类型为“bytes”的 HTTP 标头“Range”。有关详细信息，请参阅 RFC 2616“范围检索请求”。如果未设置标头，将返回整个内容。

response: object

获取导出计划成员作业

操作 ID:: getExportProgramMembersUsingGET

返回在过去 7 天内创建的导出作业的列表。所需权限：Read-Only 潜在顾客

参数

名称	密钥	类型	说明
要筛选的状态的逗号分隔列表。	status	array	要筛选的状态的逗号分隔列表。
要返回的批大小。最大值和默认值为 300。	batchSize	integer	要返回的批大小。最大值和默认值为 300。
如果结果集大于批大小，则此终结点将返回此终结点。	nextPageToken	string	如果结果集大于批大小，并且可以通过此参数在后续调用中传递令牌，则此终结点将返回令牌。有关详细信息，请参阅分页令牌。

Body: ResponseOfExportResponseWithToken

获取导出计划成员作业状态

操作 ID:: getExportProgramMembersStatusUsingGET

返回导出作业的状态。作业状态在达到“已完成”或“失败”状态后 30 天内可用。所需权限：Read-Only 潜在顾客

参数

名称	密钥	必需	类型	说明
导出批处理作业的 ID。	exportId	True	string	导出批处理作业的 ID。

Body: ResponseOfExportResponse

获取市场活动

操作 ID:: getCampaignsUsingGET

返回市场活动记录的列表。所需权限：Read-Only 市场活动、Read-Write 市场活动

注意：此终结点已被取代。 请改用 “获取智能市场活动 ”终结点。

参数

名称	密钥	类型	说明
要返回记录的以逗号分隔的市场活动 ID 列表	id	array	要返回记录的以逗号分隔的市场活动 ID 列表
要筛选的名称的逗号分隔列表	name	array	要筛选的名称的逗号分隔列表
要筛选的程序名称的逗号分隔列表。	programName	array	要筛选的程序名称的逗号分隔列表。如果已设置，将筛选为仅作为指定计划的子级的市场活动。
要筛选的工作区名称的逗号分隔列表。	workspaceName	array	要筛选的工作区名称的逗号分隔列表。如果已设置，则只会返回给定工作区中的市场活动。
要返回的最大记录数。最大值和默认值为 300。	batchSize	integer	要返回的最大记录数。最大值和默认值为 300。
此终结点将返回令牌。有关详细信息，请参阅分页令牌。	nextPageToken	string	如果结果集大于批大小，并且可以通过此参数在后续调用中传递令牌，则此终结点将返回令牌。有关详细信息，请参阅分页令牌。
如果请求了触发器，并且源是 Web 服务 API，则为	isTriggerable	boolean	设置为 true 以返回具有“请求市场活动”触发器且源为 Web 服务 API 的活动市场活动

Body: ResponseOfCampaign

获取文件

操作 ID:: getFilesUsingGET

返回给定文件夹中的文件。所需权限：Read-Only 资产、Read-Write 资产

参数

名称	密钥	必需	类型	说明
id	id	True	integer	文件夹的 ID
类型	type	True	string	文件夹的类型
最大返回	maxReturn		integer	要返回的最大通道数。最大 200，默认值 20
偏移	offset		integer	分页的整数偏移量
放置文件的文件夹	folder		string	父文件夹的 JSON 表示形式，成员为“id”和“type”，可以是“Folder”或“Program”

Body: ResponseOfFileResponse

获取文件夹

操作 ID:: getFolderUsingGET

从给定根文件夹中检索子文件夹。所需权限：Read-Only 资产、Read-Write 资产

参数

名称	密钥	类型	说明
父文件夹引用	root	string	父文件夹引用
要遍历的最大文件夹深度，默认值 2	maxDepth	integer	要遍历的最大文件夹深度，默认值 2
要返回的最大文件夹数。默认值 20，最大为 200	maxReturn	integer	要返回的最大文件夹数。默认值 20，最大为 200
分页的整数偏移量。默认 0	offset	integer	分页的整数偏移量。默认 0
工作区的名称	workSpace	string	工作区的名称

Body: ResponseOfFolderResponse

获取文件夹内容

操作 ID:: getFolderContentUsingGET

返回给定文件夹内容的记录。所需权限：Read-Only 资产、Read-Write 资产

参数

名称	密钥	必需	类型	说明
要检索的文件夹的 ID	id	True	integer	要检索的文件夹的 ID
要返回的最大通道数。最大 200，默认值 20	maxReturn		integer	要返回的最大通道数。最大 200，默认值 20
分页的整数偏移量	offset		integer	分页的整数偏移量
文件夹的类型。 “Folder”或“Program”。默认值为“Folder”	type	True	string	文件夹的类型。 “Folder”或“Program”。默认值为“Folder”

Body: ResponseOfFolderContentResponse

获取智能列表

操作 ID:: getSmartListsUsingGET

检索用户创建的智能列表记录的列表。所需权限：Read-Asset 或 Read-Write 资产

参数

名称	密钥	类型	说明
父文件夹的 JSON 表示形式	folder	string	父文件夹的 JSON 表示形式，成员为“id”和“type”，可以是“Folder”或“Program”
分页的整数偏移量	offset	integer	分页的整数偏移量
要返回的最大智能列表数。最大 200，默认值 20。	maxReturn	integer	要返回的最大智能列表数。最大 200，默认值 20。
排除此日期之前的智能列表。请参阅 Datetime 字段类型说明。	earliestUpdatedAt	string	排除此日期之前的智能列表。必须是有效的 ISO-8601 字符串。请参阅 Datetime 字段类型说明。
排除此日期之后的智能列表。请参阅 Datetime 字段类型说明。	latestUpdatedAt	string	排除此日期之后的智能列表。必须是有效的 ISO-8601 字符串。请参阅 Datetime 字段类型说明。

Body: ResponseOfSmartListResponse

获取程序

操作 ID:: browseProgramsUsingGET

从目标实例检索可访问程序的列表。所需权限：Read-Only 资产、Read-Write 资产

参数

名称	密钥	类型	说明
要返回的最大通道数。最大 200，默认值 20	maxReturn	integer	要返回的最大通道数。最大 200，默认值 20
分页的整数偏移量	offset	integer	分页的整数偏移量
可选筛选器。需要 filterValues	filterType	string	可选筛选器。需要 filterValues
排除此日期之前的程序。请参阅 Datetime 字段类型说明。	earliestUpdatedAt	string	排除此日期之前的程序。必须是有效的 ISO-8601 字符串。请参阅 Datetime 字段类型说明。
排除此日期之后的程序。请参阅 Datetime 字段类型说明。	latestUpdatedAt	string	排除此日期之后的程序。必须是有效的 ISO-8601 字符串。请参阅 Datetime 字段类型说明。

Body: ResponseOfBrowseAllPrograms

获取计划成员

操作 ID:: getProgramMembersUsingGET

返回特定字段中值列表中最多 300 个程序成员的列表。如果指定作为自定义字段的 filterType，则自定义字段的 dataType 必须是“string”或“integer”。如果指定除“leadId”以外的 filterType，请求最多可以处理 100,000 条程序成员记录。所需权限：Read-Only 潜在顾客、Read-Write 潜在顾客

参数

名称	密钥	必需	类型	说明
目标程序的 ID。	programId	True	integer	目标程序的 ID。
要筛选的程序成员字段。	filterType	True	string	要筛选的程序成员字段。任何自定义字段（仅字符串或整数类型）、“updatedAt”或任何可搜索字段。可通过描述计划成员终结点获取可搜索字段。
要筛选在指定字段中的值的逗号分隔列表。	filterValues	True	array	要筛选在指定字段中的值的逗号分隔列表。
使用 filterType=updatedAt 时，日期范围筛选器的开始日期	startAt		string	使用 filterType=updatedAt 时，日期范围筛选器（ISO 8601 格式）
使用 filterType=updatedAt 时，日期范围筛选器的结束时间	endAt		string	使用 filterType=updatedAt 时，日期范围筛选器的结束时间（ISO 8601 格式）
要为每个记录返回的潜在客户字段的逗号分隔列表。	fields		array	要为每个记录返回的潜在客户字段的逗号分隔列表。
要返回的批大小。最大值和默认值为 300。	batchSize		integer	要返回的批大小。最大值和默认值为 300。
如果结果集大于批大小，将返回令牌。	nextPageToken		string	如果结果集大于批大小，并且可以通过此参数在后续调用中传递令牌，则此终结点将返回令牌。有关详细信息，请参阅分页令牌。

Body: ResponseOfProgramMember

获取静态列表

操作 ID:: getStaticListsUsingGET

检索静态列表记录的列表。所需权限：Read-Asset 或 Read-Write 资产

参数

名称	密钥	类型	说明
父文件夹的 JSON 表示形式	folder	string	父文件夹的 JSON 表示形式，成员为“id”和“type”，可以是“Folder”或“Program”
分页的整数偏移量	offset	integer	分页的整数偏移量
要返回的最大静态列表数。最大 200，默认值 20。	maxReturn	integer	要返回的最大静态列表数。最大 200，默认值 20。
排除此日期之前的静态列表。请参阅 Datetime 字段类型说明。	earliestUpdatedAt	string	排除此日期之前的静态列表。必须是有效的 ISO-8601 字符串。请参阅 Datetime 字段类型说明。
排除此日期之后的静态列表。请参阅 Datetime 字段类型说明。	latestUpdatedAt	string	排除此日期之后的静态列表。必须是有效的 ISO-8601 字符串。请参阅 Datetime 字段类型说明。

Body: ResponseOfStaticListResponse

计划市场活动

操作 ID:: scheduleCampaignUsingPOST

远程计划在给定时间运行的批处理市场活动。可以在市场活动的父计划本地重写我的令牌，以便运行自定义内容。使用下面所述的“cloneToProgramName”参数时，此终结点限制为每天 20 次调用。所需权限：执行市场活动

参数

名称	密钥	必需	类型	说明
要计划的批处理活动的 ID。	campaignId	True	integer	要计划的批处理活动的 ID。
cloneToProgramName	cloneToProgramName		string	生成的程序的名称。设置后，此属性将导致使用生成的新名称创建市场活动、父计划及其所有资产。将克隆父计划，并计划新创建的市场活动。生成的程序在父级下创建。使用代码片段、推送通知、应用内消息、静态列表、报表和社交资产的程序可能无法以这种方式克隆
runAt	runAt		date-time	运行活动的日期时间。如果未设置，将在通话后 5 分钟运行市场活动
姓名	name	True	string	令牌的名称。应格式化为“{{my.name}}”
value	value	True	string	令牌的值

Body: ResponseOfCampaign

请求市场活动

操作 ID:: triggerCampaignUsingPOST

将一组潜在顾客传递给触发器市场活动，以通过市场活动流运行。指定的市场活动必须请求市场活动：Web 服务 API 触发器，并且必须处于活动状态。可以在市场活动的父计划本地重写我的令牌，以便运行自定义内容。每个呼叫最多允许 100 个潜在顾客。所需权限：执行市场活动

参数

名称	密钥	必需	类型	说明
要触发的运动的 ID	campaignId	True	integer	要触发的运动的 ID
id	id	True	integer	潜在顾客记录的唯一整数 ID
姓名	name	True	string	令牌的名称。应格式化为“{{my.name}}”
value	value	True	string	令牌的值

Body: ResponseOfCampaign

身份

操作 ID:: identityUsingGET

从 Marketo 检索访问令牌。对此终结点的调用不计入 API 调用限制。

参数

名称	密钥	必需	类型	说明
Marketo REST API 的 clientID	client_id	True	string	管理员 > 集成 > 启动点菜单中的客户端 ID。
Marketo REST API 的客户端密码	client_secret	True	string	管理员 > 集成 > 启动点菜单中的客户端密码。
授权的类型。我们的案例客户端凭据	grant_type	True	string	授予类型。

Body: ResponseOfIdentity

身份

操作 ID:: identityUsingPOST

从 Marketo 检索访问令牌。对此终结点的调用不计入 API 调用限制。

参数

名称	密钥	必需	类型	说明
Marketo REST API 的 clientID	client_id	True	string	管理员 > 集成 > 启动点菜单中的客户端 ID。
Marketo REST API 的客户端密码	client_secret	True	string	管理员 > 集成 > 启动点菜单中的客户端密码。
授权的类型。我们的案例客户端凭据	grant_type	True	string	授予类型。

Body: ResponseOfIdentity

定义

ResponseOfIdentity

名称	路径	类型	说明
access_token	access_token	string	使用后续调用传递的令牌，以使用目标实例进行身份验证
作用域	scope	string	用于进行身份验证的自定义服务的仅拥有 API 用户
expires_in	expires_in	integer	当前令牌的剩余寿命（以秒为单位）
token_type	token_type	string	OAuth 身份验证方法

ResponseOfStaticList

名称	路径	类型	说明
错误	errors	array of Error	如果请求失败，则发生的错误的数组
nextPageToken	nextPageToken	string	如果结果集超出允许的批大小，则给定的分页令牌
requestId	requestId	string	发出的请求的 ID
结果	result	array of StaticList	作中单个记录的结果数组可能为空
success	success	boolean	请求是否成功
警告	warnings	array of Warning	为作给定的警告数组

潜在顾客

潜在顾客记录。始终包含 ID，但可能具有任意数量的其他字段，具体取决于目标实例中可用的字段。

名称	路径	类型	说明
id	id	integer	潜在顾客记录的唯一整数 ID
成员资格	membership	ProgramMembership
原因	reason	Reason
状态	status	string	对记录执行的作的状态

LeadField

潜在顾客字段记录

名称	路径	类型	说明
displayName	displayName	string	字段的 UI 显示名称
姓名	name	string	字段的 API 名称
描述	description	string	字段的说明
数据类型	dataType	string	字段的数据类型
length	length	integer	字段的最大长度。仅适用于文本、字符串和文本区域。
isHidden	isHidden	boolean	如果设置为 true，则隐藏字段
isHtmlEncodingInEmail	isHtmlEncodingInEmail	boolean	如果设置为 true，则字段在电子邮件中编码为 HTML
isSensitive	isSensitive	boolean	如果设置为 true，则字段标记为敏感
isCustom	isCustom	boolean	如果设置为 true，则字段为自定义字段
isApiCreated	isApiCreated	boolean	如果设置为 true，则使用 REST API 创建字段

LeadFieldStatus

潜在顾客字段更新状态

名称	路径	类型	说明
姓名	name	string	字段的 API 名称
状态	status	string	对记录执行的作的状态

ListOperationOutputData

名称	路径	类型	说明
id	id	integer	潜在顾客记录的唯一整数 ID
原因	reasons	array of Reason	作失败的原因列表。原因仅在 API 响应中存在，不应提交
状态	status	string	对记录执行的作的状态

LeadAttribute

名称	路径	类型	说明
数据类型	dataType	string	字段的数据类型
displayName	displayName	string	字段的 UI 显示名称
id	id	integer	字段的唯一整数 ID
length	length	integer	字段的最大长度。仅适用于文本、字符串和文本区域。
休息	rest	LeadMapAttribute
肥皂	soap	LeadMapAttribute

LeadAttribute2

名称	路径	类型	说明
姓名	name	string	“API 潜在顾客”
searchableFields	searchableFields	array of LeadAttribute2SearchableFields	可搜索字段列表
fields	fields	array of LeadAttribute2Fields	可搜索字段的说明

LeadAttribute2SearchableFields

可搜索字段列表

名称	路径	类型	说明
物品		string	可搜索字段

LeadAttribute2Fields

名称	路径	类型	说明
姓名	name	string	字段的 REST API 名称
displayName	displayName	string	字段的显示名称（友好名称）
数据类型	dataType	string	字段的数据类型
length	length	integer	字段长度
updateable	updateable	boolean	字段可更新
crmManaged	crmManaged	boolean	是否由 CRM 管理字段

LeadAttribute2Fields2

名称	路径	类型	说明
姓名	name	string	字段的 REST API 名称
displayName	displayName	string	字段的显示名称（友好名称）
数据类型	dataType	string	字段的数据类型
length	length	integer	字段长度
updateable	updateable	boolean	字段可更新
crmManaged	crmManaged	boolean	是否由 CRM 管理字段

ProgramMemberAttribute

名称	路径	类型	说明
姓名	name	string	“API 计划成员”
fields	fields	array of LeadAttribute2Fields	可搜索字段的说明

ProgramMemberAttribute2

名称	路径	类型	说明
姓名	name	string	“API 计划成员”
描述	description	string	“API 程序成员映射”
createdAt	createdAt	string	创建日期/时间
updatedAt	updatedAt	string	Datetime 已更新
dedupeFields	dedupeFields	array of string	dedupe 字段列表
searchableFields	searchableFields	array of LeadAttribute2SearchableFields	可搜索字段列表
fields	fields	array of LeadAttribute2Fields2	可搜索字段的说明

ResponseOfImportLeadResponse

名称	路径	类型	说明
错误	errors	array of Error	如果请求失败，则发生的错误的数组
moreResult	moreResult	boolean	指示后续页面中是否有更多结果的布尔值
nextPageToken	nextPageToken	string	如果结果集超出允许的批大小，则给定的分页令牌
requestId	requestId	string	发出的请求的 ID
结果	result	array of ImportLeadResponse	作中单个记录的结果数组可能为空
success	success	boolean	请求是否成功
警告	warnings	array of Warning	为作给定的警告数组

ImportProgramMemberResponse

包含导入状态信息的响应

名称	路径	类型	说明
batchId	batchId	integer	导入作业的唯一整数 ID
importId	importId	string	导入作业的唯一整数 ID
状态	status	string	导入作业的状态

ResponseOfImportProgramMemberResponse

名称	路径	类型	说明
错误	errors	array of Error	如果请求失败，则发生的错误的数组
requestId	requestId	string	发出的请求的 ID
结果	result	array of ImportProgramMemberResponse	作中单个记录的结果数组可能为空
success	success	boolean	请求是否成功
警告	warnings	array of Warning	为作给定的警告数组

ResponseOfCampaign

名称	路径	类型	说明
错误	errors	array of Error	如果请求失败，则发生的错误的数组
nextPageToken	nextPageToken	string	如果结果集超出允许的批大小，则给定的分页令牌
requestId	requestId	string	发出的请求的 ID
结果	result	array of Campaign	作中单个记录的结果数组可能为空
success	success	boolean	请求是否成功
警告	warnings	array of Warning	为作给定的警告数组

ResponseOfListOperationOutputData

名称	路径	类型	说明
错误	errors	array of Error	如果请求失败，则发生的错误的数组
moreResult	moreResult	boolean	指示后续页面中是否有更多结果的布尔值
nextPageToken	nextPageToken	string	如果结果集超出允许的批大小，则给定的分页令牌
requestId	requestId	string	发出的请求的 ID
结果	result	array of ListOperationOutputData	作中单个记录的结果数组可能为空
success	success	boolean	请求是否成功
警告	warnings	array of Warning	为作给定的警告数组

市场活动

Marketo 智能市场活动记录

名称	路径	类型	说明
活跃	active	boolean	活动是否处于活动状态。仅适用于触发市场活动
createdAt	createdAt	string	创建市场活动时的日期/时间
描述	description	string	智能市场活动的说明
id	id	integer	智能市场活动的唯一整数 ID
姓名	name	string	智能市场活动的名称
programId	programId	integer	父程序的 ID（如果适用）
programName	programName	string	父程序的名称（如果适用）
类型	type	string	智能市场活动的类型
updatedAt	updatedAt	string	最近更新市场活动时的日期/时间
workspaceName （工作区名称）	workspaceName	string	父工作区的名称（如果适用）

ResponseOfLead

名称	路径	类型	说明
错误	errors	array of Error	如果请求失败，则发生的错误的数组
moreResult	moreResult	boolean	指示后续页面中是否有更多结果的布尔值
nextPageToken	nextPageToken	string	如果结果集超出允许的批大小，则给定的分页令牌
requestId	requestId	string	发出的请求的 ID
结果	result	array of Lead	作中单个记录的结果数组可能为空
success	success	boolean	请求是否成功
警告	warnings	array of Warning	为作给定的警告数组

ResponseOfLeadByListId

名称	路径	类型	说明
错误	errors	array of Error	如果请求失败，则发生的错误的数组
nextPageToken	nextPageToken	string	如果结果集超出允许的批大小，则给定的分页令牌
requestId	requestId	string	发出的请求的 ID
结果	result	array of Lead	作中单个记录的结果数组可能为空
success	success	boolean	请求是否成功
警告	warnings	array of Warning	为作给定的警告数组

ResponseOfLeadField

名称	路径	类型	说明
错误	errors	array of Error	如果请求失败，则发生的错误的数组
moreResult	moreResult	boolean	指示后续页面中是否有更多结果的布尔值
nextPageToken	nextPageToken	string	如果结果集超出允许的批大小，则给定的分页令牌
requestId	requestId	string	发出的请求的 ID
结果	result	array of LeadField	作中单个记录的结果数组可能为空
success	success	boolean	请求是否成功
警告	warnings	array of Warning	为作给定的警告数组

ResponseOfUpdateLeadField

名称	路径	类型	说明
错误	errors	array of Error	如果请求失败，则发生的错误的数组
moreResult	moreResult	boolean	指示后续页面中是否有更多结果的布尔值
nextPageToken	nextPageToken	string	如果结果集超出允许的批大小，则给定的分页令牌
requestId	requestId	string	发出的请求的 ID
结果	result	array of LeadFieldStatus	作中单个记录的结果数组可能为空
success	success	boolean	请求是否成功
警告	warnings	array of Warning	为作给定的警告数组

ResponseOfPushLeadToMarketo

名称	路径	类型	说明
错误	errors	array of Error	如果请求失败，则发生的错误的数组
requestId	requestId	string	发出的请求的 ID
结果	result	array of Lead	作中单个记录的结果数组可能为空
success	success	boolean	请求是否成功
警告	warnings	array of Warning	为作给定的警告数组

ResponseOfLeadAttribute

名称	路径	类型	说明
错误	errors	array of Error	如果请求失败，则发生的错误的数组
moreResult	moreResult	boolean	指示后续页面中是否有更多结果的布尔值
nextPageToken	nextPageToken	string	如果结果集超出允许的批大小，则给定的分页令牌
requestId	requestId	string	发出的请求的 ID
结果	result	array of LeadAttribute	作中单个记录的结果数组可能为空
success	success	boolean	请求是否成功
警告	warnings	array of Warning	为作给定的警告数组

ResponseOfLeadAttribute2

名称	路径	类型	说明
错误	errors	array of Error	如果请求失败，则发生的错误的数组
moreResult	moreResult	boolean	指示后续页面中是否有更多结果的布尔值
nextPageToken	nextPageToken	string	如果结果集超出允许的批大小，则给定的分页令牌
requestId	requestId	string	发出的请求的 ID
结果	result	array of LeadAttribute2	作中单个记录的结果数组可能为空
success	success	boolean	请求是否成功
警告	warnings	array of Warning	为作给定的警告数组

ResponseOfProgramMemberAttributes

名称	路径	类型	说明
错误	errors	array of Error	如果请求失败，则发生的错误的数组
moreResult	moreResult	boolean	指示后续页面中是否有更多结果的布尔值
nextPageToken	nextPageToken	string	如果结果集超出允许的批大小，则给定的分页令牌
requestId	requestId	string	发出的请求的 ID
结果	result	array of ProgramMemberAttribute	作中单个记录的结果数组可能为空
success	success	boolean	请求是否成功
警告	warnings	array of Warning	为作给定的警告数组

ResponseOfProgramMemberAttributes2

名称	路径	类型	说明
错误	errors	array of Error	如果请求失败，则发生的错误的数组
moreResult	moreResult	boolean	指示后续页面中是否有更多结果的布尔值
nextPageToken	nextPageToken	string	如果结果集超出允许的批大小，则给定的分页令牌
requestId	requestId	string	发出的请求的 ID
结果	result	array of ProgramMemberAttribute2	作中单个记录的结果数组可能为空
success	success	boolean	请求是否成功
警告	warnings	array of Warning	为作给定的警告数组

警告

名称	路径	类型	说明
代码	code	integer	警告的整数代码
消息	message	string	描述警告的消息

ResponseOfExportResponse

名称	路径	类型	说明
错误	errors	array of Error	如果请求失败，则发生的错误的数组
requestId	requestId	string	发出的请求的 ID
结果	result	array of ExportResponse	作中单个记录的结果数组可能为空
success	success	boolean	请求是否成功
警告	warnings	array of Warning	为作给定的警告数组

ResponseOfExportResponseWithToken

名称	路径	类型	说明
错误	errors	array of Error	如果请求失败，则发生的错误的数组
nextPageToken	nextPageToken	string	如果结果集超出允许的批大小，则给定的分页令牌
requestId	requestId	string	发出的请求的 ID
结果	result	array of ExportResponse	作中单个记录的结果数组可能为空
success	success	boolean	请求是否成功
警告	warnings	array of Warning	为作给定的警告数组

ResponseOfProgramMember

名称	路径	类型	说明
错误	errors	array of Error	如果请求失败，则发生的错误的数组
moreResult	moreResult	boolean	指示后续页面中是否有更多结果的布尔值
nextPageToken	nextPageToken	string	如果结果集超出允许的批大小，则给定的分页令牌
requestId	requestId	string	发出的请求的 ID
结果	result	array of ProgramMember	作中单个记录的结果数组可能为空
success	success	boolean	请求是否成功
警告	warnings	array of Warning	为作给定的警告数组

ProgramMember

程序成员记录。始终包含潜在顾客 ID，但可能具有任意数量的其他字段，具体取决于目标实例中可用的字段。

名称	路径	类型	说明
seq	seq	integer	指示响应中记录序列的整数。此值与请求输入中包含的记录的顺序相关。 Seq 应仅是响应的一部分，不应提交。
leadId	leadId	integer	潜在顾客记录的唯一整数 ID
reachedSuccess	reachedSuccess	boolean	指示程序成员是否已达到程序成功条件的布尔值
programId	programId	integer	程序的唯一整数 ID
acquiredBy	acquiredBy	boolean	指示程序成员是否被程序获取的布尔值
membershipDate	membershipDate	string	潜在客户首次成为该计划的成员的日期

ResponseOfProgramMemberStatus

名称	路径	类型	说明
错误	errors	array of Error	如果请求失败，则发生的错误的数组
moreResult	moreResult	boolean	指示后续页面中是否有更多结果的布尔值
nextPageToken	nextPageToken	string	如果结果集超出允许的批大小，则给定的分页令牌
requestId	requestId	string	发出的请求的 ID
结果	result	array of ProgramMemberStatusResponse	作中单个记录的结果数组可能为空
success	success	boolean	请求是否成功
警告	warnings	array of Warning	为作给定的警告数组

ResponseOfProgramMemberData

名称	路径	类型	说明
错误	errors	array of Error	如果请求失败，则发生的错误的数组
moreResult	moreResult	boolean	指示后续页面中是否有更多结果的布尔值
nextPageToken	nextPageToken	string	如果结果集超出允许的批大小，则给定的分页令牌
requestId	requestId	string	发出的请求的 ID
结果	result	array of ProgramMemberStatusResponse	作中单个记录的结果数组可能为空
success	success	boolean	请求是否成功
警告	warnings	array of Warning	为作给定的警告数组

ResponseOfProgramMemberDelete

名称	路径	类型	说明
错误	errors	array of Error	如果请求失败，则发生的错误的数组
moreResult	moreResult	boolean	指示后续页面中是否有更多结果的布尔值
nextPageToken	nextPageToken	string	如果结果集超出允许的批大小，则给定的分页令牌
requestId	requestId	string	发出的请求的 ID
结果	result	array of ProgramMemberDeleteResponse	作中单个记录的结果数组可能为空
success	success	boolean	请求是否成功
警告	warnings	array of Warning	为作给定的警告数组

ImportLeadResponse

包含导入状态信息的响应

名称	路径	类型	说明
batchId	batchId	integer	导入批处理的唯一整数 ID
importId	importId	string
消息	message	string
numOfLeadsProcessed	numOfLeadsProcessed	integer	到目前为止已处理的行数
numOfRowsFailed	numOfRowsFailed	integer	到目前为止失败的行数
numOfRowsWithWarning	numOfRowsWithWarning	integer	到目前为止，包含警告的行数
状态	status	string	批处理的状态

ProgramMembership

名称	路径	类型	说明
acquiredBy	acquiredBy	boolean	潜在顾客是否由父计划获取
isExhausted	isExhausted	boolean	潜在客户当前是否在流中耗尽（如果适用）
membershipDate	membershipDate	string	潜在客户首次成为该计划的成员的日期
nurtureCadence	nurtureCadence	string	父流的节奏（如果适用）
progressionStatus	progressionStatus	string	父程序中潜在顾客的计划状态
reachedSuccess	reachedSuccess	boolean	潜在顾客是否处于父计划的成功状态
数据流	stream	string	如果父计划是参与计划的成员，则流式传输潜在顾客是参与计划的成员

ExportResponse

包含导出作业状态信息的响应

名称	路径	类型	说明
createdAt	createdAt	date-time	创建导出请求的日期
errorMsg	errorMsg	string	出现“失败”状态时出现错误消息
exportId	exportId	string	导出作业的唯一 ID
文件大小	fileSize	integer	导出的文件的大小（以字节为单位）。仅当状态为“Completed”时，此值才会有一个值，否则为 null
fileChecksum	fileChecksum	string	导出文件的 SHA-256 哈希。仅当状态为“Completed”时，此值才会有一个值，否则为 null
finishedAt	finishedAt	date-time	完成导出作业的时间。仅当状态为“Completed”或“Failed”时，此值才会有值，否则为 null
格式	format	string	请求中给定的文件格式（“CSV”、“TSV”、“SSV”）
numberOfRecords	numberOfRecords	integer	导出文件中的记录数。仅当状态为“Completed”时，此值才会有值，否则为 null
queuedAt	queuedAt	date-time	导出作业的队列时间。当达到“已排队”状态时（在该 null 之前）时，此值将具有值
startedAt	startedAt	date-time	导出作业的开始时间。当达到“处理”状态时，在该 null 之前，此值将具有值
状态	status	string	导出作业的状态（“已创建”、“已排队”、“处理”、“已取消”、“已完成”、“失败”）

原因

名称	路径	类型	说明
代码	code	string	原因的整数代码
消息	message	string	描述作状态原因的消息

LeadMapAttribute

名称	路径	类型	说明
姓名	name	string	属性名称
只读	readOnly	boolean	属性是否为只读

错误

名称	路径	类型	说明
代码	code	string	错误的错误代码。在此处查看错误代码的完整列表
消息	message	string	描述错误原因的消息

ProgramMemberStatusResponse

名称	路径	类型	说明
状态	status	string	对记录执行的作的状态
原因	reasons	array of Reason	作失败的原因列表。原因仅在 API 响应中存在，不应提交
leadId	leadId	integer	与程序成员关联的潜在顾客 ID
seq	seq	integer	指示响应中记录序列的整数。此值与请求输入中包含的记录的顺序相关。 Seq 应仅是响应的一部分，不应提交。

ProgramMemberDeleteResponse

名称	路径	类型	说明
状态	status	string	对记录执行的作的状态
原因	reasons	array of Reason	作失败的原因列表。原因仅在 API 响应中存在，不应提交
leadId	leadId	integer	与程序成员关联的潜在顾客 ID
seq	seq	integer	指示响应中记录序列的整数。此值与请求输入中包含的记录的顺序相关。 Seq 应仅是响应的一部分，不应提交。

StaticList

名称	路径	类型	说明
createdAt	createdAt	string	创建列表时的日期/时间
描述	description	string	静态列表的说明
id	id	integer	静态列表的唯一整数 ID
姓名	name	string	静态列表的名称
programName	programName	string	程序的名称
updatedAt	updatedAt	string	最近更新列表的日期/时间
workspaceName （工作区名称）	workspaceName	string	父工作区的名称（如果适用）

BrowseAllPrograms

名称	路径	类型	说明
通道	channel	string	程序的频道
createdAt	createdAt	date-time	创建资产的日期/时间
描述	description	string	资产说明
文件夹	folder	Folder	文件夹的 JSON 表示形式
id	id	integer	资产的 ID
姓名	name	string	资产的名称
sfdcId	sfdcId	string	如果链接到 SFDC 市场活动，则程序的 SFDC ID
sfdcName	sfdcName	string	链接的 SFDC 市场活动的名称（如果适用）
状态	status	string	程序的状态。仅适用于电子邮件和参与计划类型。
类型	type	string	程序的类型
updatedAt	updatedAt	date-time	最近更新资产的日期/时间
网址	url	string	Marketo UI 中资产的 URL
工作区	workspace	string	工作区的名称

FolderContentResponse

名称	路径	类型	说明
id	id	integer
类型	type	string

FileFolder

名称	路径	类型
id	id	integer
姓名	name	string
类型	type	string

ResponseOfProgramResponse

名称	路径	类型
错误	errors	array of Error
requestId	requestId	string
结果	result	array of ProgramResponse
success	success	boolean
警告	warnings	array of string

ResponseOfSmartListResponse

名称	路径	类型
错误	errors	array of Error
requestId	requestId	string
结果	result	array of SmartListResponse
success	success	boolean
警告	warnings	array of string

ResponseOfSmartListResponseWithRules

名称	路径	类型
错误	errors	array of Error
requestId	requestId	string
结果	result	array of SmartListResponseWithRules
success	success	boolean
警告	warnings	array of string

SmartListResponse

名称	路径	类型	说明
id	id	integer	智能列表的 ID
姓名	name	string	智能列表的名称
描述	description	string	智能列表的说明
createdAt	createdAt	date-time	创建智能列表的日期/时间
updatedAt	updatedAt	date-time	最近更新智能列表的日期/时间
网址	url	string	Marketo UI 中智能列表的 URL
文件夹	folder	Folder	文件夹的 JSON 表示形式
工作区	workspace	string	工作区的名称

SmartListResponseWithRules

名称	路径	类型	说明
id	id	integer	智能列表的 ID
姓名	name	string	智能列表的名称
描述	description	string	智能列表的说明
createdAt	createdAt	date-time	创建智能列表的日期/时间
updatedAt	updatedAt	date-time	最近更新智能列表的日期/时间
网址	url	string	Marketo UI 中智能列表的 URL
文件夹	folder	Folder	文件夹的 JSON 表示形式
工作区	workspace	string	工作区的名称
规则	rules	SmartListRules	智能列表规则的 JSON 表示形式

ResponseOfStaticListResponse

名称	路径	类型
错误	errors	array of Error
requestId	requestId	string
结果	result	array of StaticListResponse
success	success	boolean
警告	warnings	array of string

StaticListResponse

名称	路径	类型	说明
id	id	integer	静态列表的 ID
姓名	name	string	静态列表的名称
描述	description	string	静态列表的说明
createdAt	createdAt	date-time	创建静态列表的日期/时间
updatedAt	updatedAt	date-time	最近更新静态列表的日期/时间
网址	url	string	Marketo UI 中静态列表的 URL
文件夹	folder	Folder	文件夹的 JSON 表示形式
工作区	workspace	string	工作区的名称
computedUrl	computedUrl	string

ProgramResponse

名称	路径	类型	说明
通道	channel	string	程序的频道
costs	costs	array of Costs	关联的周期成本列表
createdAt	createdAt	date-time	创建资产的日期/时间
描述	description	string	资产说明
结束日期	endDate	date-time	程序的结束日期。适用于活动、电子邮件和网络研讨会类型程序
文件夹	folder	ProgramFolder
id	id	integer	资产的 ID
姓名	name	string	资产的名称
sfdcId	sfdcId	string	如果链接到 SFDC 市场活动，则程序的 SFDC ID
sfdcName	sfdcName	string	链接的 SFDC 市场活动的名称（如果适用）
startDate	startDate	date-time	程序的开始日期。适用于活动、电子邮件和网络研讨会类型程序
状态	status	string	程序的状态。仅适用于电子邮件和参与计划类型。
tags	tags	array of Tags	关联的程序标记列表
类型	type	string	程序的类型
updatedAt	updatedAt	date-time	最近更新资产的日期/时间
网址	url	string	Marketo UI 中资产的 URL
工作区	workspace	string	工作区的名称
marketingProgramProgressionId	marketingProgramProgressionId	integer
headStart	headStart	boolean	是否为程序启用了“头启动”函数

FileResponse

名称	路径	类型	说明
createdAt	createdAt	date-time	创建文件的日期/时间
描述	description	string	文件的说明
文件夹	folder	FileFolder
id	id	integer	文件的 ID
MIME类型	mimeType	string	文件的 MIME 类型
姓名	name	string	文件的名称
size	size	integer	文件的大小（以字节为单位）
updatedAt	updatedAt	date-time	最近更新文件的日期/时间
网址	url	string	文件的可公开访问 URL

ResponseOfFileResponse

名称	路径	类型
错误	errors	array of Error
requestId	requestId	string
结果	result	array of FileResponse
success	success	boolean
警告	warnings	array of string

FolderResponse

名称	路径	类型	说明
accessZoneId	accessZoneId	integer
createdAt	createdAt	date-time	创建文件夹的日期/时间
描述	description	string	文件夹的说明
folderId	folderId	Folder	文件夹的 JSON 表示形式
folderType	folderType	string	文件夹的类型
id	id	integer	文件夹的 ID
isArchive	isArchive	boolean	文件夹的存档状态
isSystem	isSystem	boolean	文件夹是否由系统管理
姓名	name	string	文件夹的名称。不适用于程序
父级	parent	Folder	文件夹的 JSON 表示形式
路径	path	string	文件夹的路径
updatedAt	updatedAt	date-time	上次更新文件夹的日期/时间
网址	url	string	文件夹的 URL
工作区	workspace	string	工作区的名称

ResponseOfIdResponse

名称	路径	类型
错误	errors	array of Error
requestId	requestId	string
结果	result	array of IdResponse
success	success	boolean
警告	warnings	array of string

标记

名称	路径	类型	说明
tagType	tagType	string	标记的名称
标签值	tagValue	string	标记的值

ResponseOfBrowseAllPrograms

名称	路径	类型
错误	errors	array of Error
requestId	requestId	string
结果	result	array of BrowseAllPrograms
success	success	boolean
警告	warnings	array of string

ResponseOfFolderResponse

名称	路径	类型
错误	errors	array of Error
requestId	requestId	string
结果	result	array of FolderResponse
success	success	boolean
警告	warnings	array of string

ResponseOfFolderContentResponse

名称	路径	类型
错误	errors	array of Error
requestId	requestId	string
结果	result	array of FolderContentResponse
success	success	boolean
警告	warnings	array of string

IdResponse

名称	路径	类型	说明
id	id	integer	资产的 ID

成本

名称	路径	类型	说明
成本	cost	integer	成本金额
注意	note	string	成本说明
startDate	startDate	date-time	周期成本的开始日期

ProgramFolder

名称	路径	类型	说明
类型	type	string	程序文件夹的类型
value	value	integer	程序文件夹的 ID
folderName	folderName	string	程序文件夹的名称

文件夹

文件夹的 JSON 表示形式

名称	路径	类型	说明
id	id	integer	文件夹的 ID
类型	type	string	文件夹的类型

SmartListRules

智能列表规则的 JSON 表示形式

名称	路径	类型	说明
filterMatchType	filterMatchType	string	智能列表筛选器匹配类型（规则逻辑）
触发器	triggers	array of string	智能列表触发器列表
filters	filters	array of SmartListFilters	智能列表筛选器列表

SmartListFilters

智能列表筛选器的 JSON 表示形式

名称	路径	类型	说明
id	id	integer	筛选器的 ID
姓名	name	string	筛选器的名称
ruleTypeId	ruleTypeId	integer	规则类型的 ID
ruleType	ruleType	string	规则类型的名称
操作员	operator	string	运算符的名称
conditions	conditions	array of SmartListConditions	智能列表条件列表

SmartListConditions

智能列表条件的 JSON 表示形式

名称	路径	类型	说明
activityAttributeId	activityAttributeId	integer	活动属性的 ID
activityAttributeName	activityAttributeName	string	活动属性的名称
操作员	operator	string	运算符的值
values	values	array of string	值列表
isPrimary	isPrimary	boolean	条件是否为主（智能列表的第一个条件）

对象

这是类型“object”。