API和参考资料
元数据APIs
字段、模块、布局、相关列表等的元数据。
定制
模块
对您的组织的模块执行CRUD操作。
字段
对各种模块的字段执行CRUD操作。
布局
获取各种布局的详细信息,并对自定义布局执行CRUD操作。
相关列表
获取特定模块中相关列表的详细信息。
- 获取相关列表元数据 - 获取特定模块中相关列表的详细信息。
自定义视图
获取为模块创建的自定义视图的详细信息。
- 获取自定义视图元数据 - 获取特定模块的自定义视图的元数据。
- 更改自定义视图的排序顺序 - 更改自定义视图中记录的排序顺序。
模板
获取为您的组织创建的库存和电子邮件模板的详细信息。
重复检查选项
使用唯一字段设置标准,以管理Zoho CRM中的潜在客户模块(包括转化的潜在客户和联系人)的重复项。
标签
在Zoho CRM中对标签执行CRUD和其他操作。
向导
向导将长表单分割成多个屏幕,减少了数据输入过程中出错的可能性,因为这些屏幕可以部分保存为草稿,稍后再提交。
- 获取向导 - 获取模块中向导的详细信息。
记录锁定配置
设置需要手动或自动锁定模块中的记录的配置,当满足某些条件时。
映射依赖性
在一个模块中,有些字段的值依赖于另一个字段的值。这可以被定义为父子关系。使用这些API根据父字段的值定义适用于子字段的值。
全球选项列表
全局集或全局下拉列表用于管理跨模块的常见下拉列表值。使用这些API对全局下拉列表执行CRUD操作以及更多操作。
- 获取全局选项列表 - 检索在您的Zoho CRM账户中配置的全局选项列表的详细信息。
- 创建全局选项列表 - 创建一个全局集或全局选项列表。
- 更新全局选项列表 - 更新全局选项列表或全局集合。
- 删除全局选项列表 - 删除在您的Zoho CRM账户中配置的全局选项列表。
- 替换全局PickList值 - 用全局picklist的另一个现有选项,替换所有使用过的地方的picklist值。
- 获取全局选项列表选项替换任务状态 - 通过替换选项列表值API启动的计划选项列表选项替换任务的状态。
- 获取全局选项列表特性关联 - 获取全局选项列表中特定选项关联的特性详情,如工作流或蓝图。
- 获取全局拾取列表字段关联 - 检索全局拾取列表关联的字段、模块和布局的信息
取消订阅链接
通过创建取消订阅链接并将其嵌入到电子邮件或托管在网页上,允许客户取消订阅您的电子邮件通信。您可以使用系统定义的默认链接或创建自定义链接。默认的取消订阅链接将对所有用户可用,且无法进行自定义。使用以下API来实现这一点。
呼叫偏好设置
启用/禁用"来电号码"和"去电号码"偏好设置,以在呼叫模块中添加"来电号码"和/或删除"去电号码"字段。使用以下API来检索和更新您的Zoho CRM组织中呼叫模块的呼叫偏好设置详细信息。
流程自动化
蓝图
蓝图在软件中捕获您整个离线过程的每一个细节。它促进了自动化、验证和团队协作,从而使您的过程更加高效,避免了漏洞。使用这些API来获取和更新蓝图的详细信息。
管道
在交易模块的管道上执行CRUD操作。
分配规则
获取为您的组织配置的分配规则的详细信息。
- 获取分配规则 - 获取您的组织中的分配规则。
相关列表
获取特定模块中相关列表的详细信息。
- 获取相关列表元数据 - 获取特定模块中相关列表的详细信息。
节奏
Zoho CRM中的节奏可以自动化并简化客户跟进流程。它使您能够根据客户的互动和行为,创建有针对性的、顺序的通信,如电子邮件、电话或任务。使用这些API,获取节奏的详细信息,注册和取消注册节奏记录。
- 获取节奏 - 获取在您的组织中配置的节奏的详细信息。
- 在节奏中注册记录 - 手动将模块的记录注册到节奏中。
- 从节奏中取消注册记录 - 手动将模块的记录从节奏中取消注册。
评分规则
Zoho CRM提供了一个系统,用于根据您根据特定需求定义的规则对模块中的不同记录进行排名。记录的分数是根据规则计算出的值。有了这个功能,系统可以帮助您找到最有价值的记录。使用这些API对评分规则执行CRUD操作和更多操作。
安全控制
角色
角色,如经理、销售代表、主管、产品管理人员等,表示公司中的不同级别的员工。使用这些API来对Zoho CRM中的各种角色执行CRUD操作。
配置文件
在Zoho CRM中,管理员为每个用户分配一个配置文件,该配置文件决定了用户对Zoho CRM数据的访问级别。使用这些API来对您的组织中的配置文件执行CRUD操作。
- 获取配置文件 - 检索您的组织的配置文件数据。
- 创建配置文件 - 通过克隆现有的配置文件并对其进行更改来创建一个配置文件。
- 更新配置文件权限 - 更新配置文件的权限。
- 转移用户并删除配置文件 - 将用户转移到新的配置文件并删除旧的配置文件。
领土
领域管理可帮助您根据客户属性(如地理位置、公司规模或行业)对您的Zoho CRM记录进行划分。它还允许您自动将账户、联系人和交易与领域关联,以最大化收入。使用这些API来对您组织中的领域执行CRUD操作和更多操作。
- 获取领土 - 获取为您的组织启用的领土列表。
- 添加领土 - 向您的组织添加新的领土。
- 更新领土 - 更新您的组织中现有领土的详细信息。
- 删除领土 - 从您的组织中删除领土。
- 转移和删除领土 - 删除带有子领土的领土,并将子领土转移到另一个父领土。
- 获取子领域 - 检索您领域的子领域的详细信息。
- 获取记录的领土 - 获取分配给记录的领土的详细信息。
- 领土的关联用户数量 - 检索您的组织中领土下的用户数量。
- 检索与领土相关的用户详细信息 - 检索已添加到您组织领土的用户的详细信息。
- 将用户与领土关联 - 在您的组织中将用户与领土关联。
- 移除记录的领土 - 移除分配给多个记录或单个记录的领土。
- 为记录分配领土 - 为多个记录或单个记录分配领土。
- 解除用户与领土的关联 - 在您的组织中解除用户与领土的关联。
导出审计日志
审计日志提供了Zoho CRM中用户执行操作的时间顺序。使用这些API来安排导出,获取作业的详细信息,并下载结果。
- 创建导出审计日志 - 从您的Zoho CRM导出审计日志数据。
- 获取导出审计日志作业的状态 - 检索导出审计日志作业的详细信息。
- 下载导出审计日志结果 - 下载导出审计日志作业的结果。
门户网站
CRM中的门户允许管理员将CRM访问权限扩展到他们的联系人、供应商或合作伙伴。门户用户可以访问他们被授权访问的模块和一些相关数据,如CRM中的产品、发票和笔记。他们还可以查看、编辑、创建记录,添加笔记和附件。使用这些API来对门户和用户类型执行CRUD操作等更多操作。
- 创建门户 - 为您的组织创建一个门户。
- 更新门户 - 在您的组织中更新门户的名称。
- 获取门户 - 获取您的组织中可用门户的详细信息。
- 创建用户类型 - 在门户中创建用户类型。
- 获取门户用户类型 - 获取您的组织门户中可用的用户类型。
- 更新用户类型 - 在门户中更新用户类型的详细信息。
- 删除用户类型 - 从门户中删除用户类型。
- 邀请用户访问门户网站 - 邀请用户访问门户网站。
- 批量邀请用户至门户 - 批量邀请用户至门户。
- 批量邀请工作状态 - 获取邀请用户批量加入门户的工作状态。
- 转移用户类型的用户 - 在门户中将一种用户类型的用户转移到另一种用户类型。
- 获取某用户类型的用户 - 获取门户中某用户类型的所有用户列表。
- 更改用户状态(门户) - 更改门户中用户的状态。
- 从门户删除用户 - 从门户删除用户。
数据共享
Zoho CRM中的数据共享为您提供了一种选项,可以扩展对CRM记录的访问权限,以便其他角色和组的用户。默认情况下,组织权限被设置为私有,只有记录所有者及其经理可以查看和访问CRM数据。使用这些API在数据共享规则上执行CRUD操作等更多操作。
公司设置
营业时间
营业时间定义了一个组织的工作时间,通常基于公司的位置。对您的组织设定的营业时间执行CRUD操作。
班次时间
班次时间允许您根据员工的工作时间或时区分配班次,并使您能够根据用户的可用性分配活动。对您的组织设定的班次时间执行CRUD操作。
财政年度
在Zoho CRM中,财政年度设置帮助组织根据所选的开始月份或结束月份配置他们的财政周期。对您的组织设定的财政年度执行API操作。
假期
每个企业都有自己的假期,包括国家假期和特定于企业或地区的假期。使用这些API对您的组织的假期进行cRUD操作。
- 获取假期列表 - 获取为您的组织设置的假期的详细信息。
- 获取导出审计日志工作的状态 - 检索导出审计日志工作的详细信息。
- 添加假期 - 向您的组织添加假期。
- 更新假期 - 更新为您的组织设置的假期。
- 删除假期 - 删除为您的组织设置的假期。
用户组
您可以创建不同类型的组(用户集)来管理一组公共记录。每个组可以包含基于用户、角色、角色和下属、领土和子领土进行分组的成员。这些组合允许您通过数据共享规则共享公共记录。使用这些API来对您的组织的用户类型执行CRUD操作和更多操作。
用户的不可用性
使用这些API获取用户不可用的详细信息,标记自己为不可用,更新并获取你的不可用性的详细信息。
货币
使用这些API对您的组织的货币执行CRUD操作,并启用多货币。
变量
CRM变量可以拥有唯一的值集合,并可以广泛用作电子邮件模板、邮件合并模板和库存模板中的合并字段。您也可以将它们用作API中的可重用认证参数。
齐亚
Zia,Zoho CRM的AI驱动助手,可以帮助您确保CRM数据的完整性和更新性。基于网站、公司名称等少量信息,Zia会爬取网页并检索额外信息,如公司的地址、电话、员工数量、CEO的社交媒体账号和其他公开信息。这被称为数据丰富化。请参考这篇文章以获取更多详情。当您启用数据丰富化时,您可以将互联网上的数据与Zoho CRM中的字段进行映射。系统定义的字段默认进行数据映射,但您也可以与自定义字段进行映射。这种映射被称为配置。
组织丰富化
- 数据丰富化 - 组织级别 - 初始化或触发组织级别的数据丰富化。
- 获取数据丰富化配置 - 获取数据丰富化配置的详细信息。
- 获取数据丰富化配置 - 获取您的组织丰富化数据的详细信息。
人员丰富化
核心APIs
对记录进行CRUD操作,批量操作,子表单,链接模块等。
记录
对记录执行CRUD操作。
- 获取记录 - 从一个模块中每次API调用最多获取200条记录。
- 插入记录 - 在一个模块中每次API调用最多可插入100条记录。
- 更新记录 - 在模块中更新最多100条现有记录。
- 删除记录 - 从模块中删除最多100条记录。
- 插入或更新记录(Upsert Records) - 插入或更新一条记录。系统会根据重复检查字段的值检查重复记录。现有的记录会被更新,而新的记录会被插入。
- 搜索记录 - 检索符合您搜索条件的记录。
- 记录克隆 - 在模块中克隆一条记录。
- 获取富文本字段 - 获取富文本字段。
- 记录的时间线 - 获取记录的时间线,例如对其任何字段和相关记录所做的所有更新的历史。
- 获取已删除的记录 - 获取已删除记录的列表。
- 模块记录数 - 获取模块中的记录总数或符合条件的记录数。
- 记录锁定 - 记录锁定信息API允许您锁定和解锁记录,查看锁定信息并编辑锁定记录的锁定信息。
- GET 记录锁定信息 - 检索锁定记录的锁定信息详情。
- 锁定记录 - 锁定模块的一条记录。
- 更新记录锁定信息 - 修改不同模块中锁定记录的锁定信息。
- 解锁记录 - 移除锁定记录的锁定。
- 联系人角色 - When multiple contacts are associated with a deal/opportunity, the contacts' details are stored in the Contact Roles related list.
- 获取联系人角色 - 获取联系人角色列表。
- 插入联系人角色 - 添加新的联系人角色。
- 更新联系人角色 - 更新联系人角色的详细信息。
- 删除联系人角色 - 删除联系人角色。
- 获取特定交易的联系人角色 - 获取与特定交易相关联的联系人角色的详细信息。
- 向特定交易添加联系人角色 - 向特定交易添加联系人角色。
- 从特定交易中移除联系人角色 - 从特定交易中移除联系人角色。
- 附件 - 文件和附件API允许您获取附件列表,以及上传或下载照片或文件。
- 照片
- 更改所有者
- 更改所有者 - 更改记录或多个记录的所有者。
- 转换潜在客户 - 获取潜在客户转换选项,以识别现有记录(如果有的话),在将潜在客户转换为交易、账户和联系人之前。
- 获取潜在客户转换选项 - 从账户、联系人和交易中获取匹配的记录,以正确地映射数据,并在转换潜在客户时避免任何重复。
- 转换潜在客户 - 将潜在客户转换为账户、联系人或交易。
- 转换库存记录 - 将报价转换为销售订单或发票,以及将销售订单转换为发票。
- 转换库存记录 - 转换库存记录。
合并记录
将多达三个重复的记录合并为一个,删除重复项。
分享记录
通过这些API与组织中的其他用户共享记录。
邮件合并
使用邮件合并模板向其他用户发送个性化的电子邮件、信件等,无需为每个用户手动输入信息。
- 使用合并模板发送邮件 - 使用邮件合并模板向用户发送电子邮件
- 签署邮件合并 - 发送邮件合并文档以供签署和批准。
- 下载邮件合并 - 使用下载邮件合并API下载使用您的邮件合并模板创建的合并文档。
服务
使用这些API,根据各种业务需求创建新服务,检索或搜索服务记录,更新服务详细信息,删除现有服务,并配置服务偏好设置。
预约
根据各种业务需求,使用这些API来获取、创建、更新、删除预约,并设置预约偏好。
预约重新安排历史记录
使用预约重新安排历史记录API来获取、创建、更新和删除重新安排历史记录中的记录。
- 获取预约重新安排历史记录 - 获取预约重新安排的历史数据。
- 添加预约重新安排历史记录 - 在预约重新安排的历史记录中添加新记录。
- 更新预约重新安排历史记录 - 更新预约的重新安排详情。
- 删除预约重新安排历史记录 - 从预约重新安排的历史记录中删除一条记录。
字段的附件
- 下载字段附件 - 从模块的文件上传和图像上传字段下载附件。
取消会议
- 取消会议 - 取消会议并向参与者发送有关会议取消的电子邮件。
笔记
对模块的笔记执行CRUD操作。
批量操作
对模块的记录执行批量操作,如更改所有者,批量更新和删除,批量转换潜在客户等。
- 批量更新 - 通过记录ID更新最多50,000条记录的特定字段,或在自定义视图/领域中更新最多500条记录。
- 批量删除 - 在自定义视图中删除多达50,000条记录,或使用其记录ID删除多达500条记录。
- 批量更改所有者 - 在API调用中更改自定义视图中多达50,000条记录的所有者。
- 批量转换潜在客户 - 在单次API调用中最多可转换50个潜在客户,无论是否创建交易。
- 批量转换潜在客户 - 在单次API调用中最多可转换50个潜在客户。
- 潜在客户批量转换状态 - 获取之前安排的批量转换潜在客户任务的状态。
- 批量转换库存记录 - 在单个API调用中最多可以转换50个库存记录。
- 批量转换库存记录 - 批量转换库存记录。您可以将记录从报价单转换为销售订单或发票,或者从销售订单转换为发票。
- 批量库存转换状态API - 获取计划进行库存记录批量转换的任务状态。
相关记录
对模块的相关记录(如附件、产品、交易、联系人等)执行CRUD操作。
- 获取相关记录 - 获取记录的相关列表记录。
- 获取记录的相关记录数量 - 获取模块中记录的相关记录数量。
- 更新相关记录 - 更新记录之间的关系。
- 解除相关记录的链接 - 删除模块之间的关联。
- 获取已删除记录的相关记录 - 获取已删除记录的相关列表记录。
外部ID
当您集成第三方应用程序时,您可能希望在Zoho CRM的记录中存储第三方参考ID。外部ID字段有助于满足在Zoho CRM内部存储外部值的需求。
- 使用外部ID的记录API - Perform CRUD operation the records of a module using their external IDs.
- 使用外部ID获取记录 - 使用外部ID获取模块中的记录。
- 使用外部ID插入记录 - 使用外部ID向模块添加新实体。
- 使用外部ID更新记录 - 通过外部字段在模块中更新现有记录。
- 使用外部ID删除记录 - 使用外部ID在模块中删除记录。
- 使用外部ID更新或插入记录 - 通过外部字段在模块中更新现有记录或插入新记录。
- 使用外部ID搜索记录 - 使用外部字段检索与您的搜索条件匹配的记录。
- 使用外部ID的相关记录APIs - 使用它们的外部ID对模块的相关记录执行CRUD操作。
- 使用外部ID获取相关记录 - 使用外部ID获取相关列表记录。
- 使用外部ID更新相关记录 - 使用外部ID更新相关列表记录。
- 使用外部ID删除相关记录 - 使用外部ID删除相关列表记录。
- 使用外部ID的记录API - Perform CRUD operation the records of a module using their external IDs.
电子邮件
- 将电子邮件与记录关联 - 将电子邮件与记录实体关联。
- 下载电子邮件附件 - 下载电子邮件的附件。
- 下载电子邮件的内联图片 - 从电子邮件下载内联图片。
- 获取电子邮件共享详情 - 获取您可以与之共享记录电子邮件的用户和类型的详细信息。
- 获取记录的电子邮件 - 获取从记录发送的电子邮件的详细信息。
- 获取发件人地址列表 - 获取您可以发送电子邮件的电子邮件地址列表。
- 发送邮件 - 向Zoho CRM中其他记录的电子邮件ID发送邮件。
- 解锁电子邮件地址 - 解锁软退回的电子邮件。
电子邮件草稿
电子邮件草稿存储在相应记录的电子邮件相关列表中。使用这些API来对电子邮件草稿执行CRUD操作。
子表单
使用这些API来处理子表单数据。
其他
其他用于对用户、组织、回收站等进行操作的API。
- 组织 - 对您的组织数据执行操作,例如获取详细信息,上传,下载和删除您的组织的照片。
- 用户 - Perform CRUD, territory-based operations, and transfer user operations.
- 获取用户 - 检索在API请求中指定的用户数据。您可以指定需要检索的用户类型。
- 添加用户 - 向您的组织添加用户。
- 更新用户 - 更新您的组织中的用户详细信息。
- 删除用户 - 从您的组织中删除一个用户。
- 获取用户数量 - 获取您的组织中的用户数量。您可以获取用户的总数,或按用户类型获取数量。
- 获取用户领域 - 获取与用户相关的领域。
- 添加或更新用户的领土 - 添加或更新与用户相关的领土。
- 从用户中移除领土 - 从用户中移除特定领土。
- 转移记录并删除用户 - 从CRM中删除用户并将记录转移到新用户。
- 转移记录和删除用户的状态 - 获取之前安排的“转移记录和删除用户”任务的状态。
- 特性 - 获取您的组织及其限制中的特性信息。这些限制因您的组织版本而异。
- 可用API列表 - 检索当前API版本中支持的API列表,可根据它们的请求方法、OAuth范围和信用限制来过滤API。
- 回收站
- 文件 - 使用这些API来上传文件并获取存储在Zoho的文件系统(ZFS)上的文件。
批量APIs
使用Bulk Read,Bulk Write和Data Backup APIs对大量数据进行操作。
批量读取
使用此异步API,可以从模块中每次API调用导出最多200,000条记录(以CSV文件形式),或者从事件模块中导出最多25,000条记录(以ICS形式)。
- 创建批量读取任务(批量导出) - 创建一个批量读取任务以导出记录。
- 获取批量读取任务的状态 - 获取之前安排的批量读取任务的详细信息。
- 下载批量读取结果 - 以zip格式下载批量读取任务。
批量写入
使用此异步API,一次API调用最多可以导入(插入,更新或插入)25,000条记录。
- 批量写入上传文件 - 以ZIP格式上传CSV文件以供批量写入API使用。
- 创建批量写入任务 - 安排批量写入任务以导入CRM中的记录。
- 获取批量写入任务详情 - 获取以前安排的批量写入任务的详细信息。
- 下载批量写入结果 - 以CSV文件的形式下载批量写入任务的结果。
数据备份
管理员可以通过这个API备份他们的CRM数据,包括附件。
复合API
使用此API,可以将多达五个API请求合并到一个API中,从而减少往返时间,节省积分,并在失败时回滚。
- 复合API - 执行一个复合API调用,包含多达五个子请求。
查询API
使用CRM的对象查询语言(COQL)获取符合您条件的记录,该语言使用类似SQL的语法。
- 通过 COQL 查询获取记录 - 通过 COQL 查询从模块中获取记录。
- COQL中的连接 - 您可以使用查找字段(通过.(点)运算符将一个模块与另一个模块关联起来)来建立连接或关系。
- 在COQL中的子查询 - 使用COQL查询中的嵌套/子查询从模块获取记录。
通知APIs
使用通知API,您可以在接近实时的情况下获取有关记录操作(如插入、更新或删除)的通知。