zoho-crm-automation

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

Zoho CRM Automation via Rube MCP

通过Rube MCP实现Zoho CRM自动化

Automate Zoho CRM operations through Composio's Zoho toolkit via Rube MCP.

通过Composio的Zoho工具包，借助Rube MCP自动化Zoho CRM的操作。

Prerequisites

前提条件

Rube MCP must be connected (RUBE_SEARCH_TOOLS available)
Active Zoho CRM connection via
```
RUBE_MANAGE_CONNECTIONS
```
with toolkit
```
zoho
```
Always call
```
RUBE_SEARCH_TOOLS
```
first to get current tool schemas

必须已连接Rube MCP（RUBE_SEARCH_TOOLS可用）
通过
```
RUBE_MANAGE_CONNECTIONS
```
并使用工具包
```
zoho
```
完成Zoho CRM的激活连接
请始终先调用
```
RUBE_SEARCH_TOOLS
```
以获取最新的工具架构

Setup

设置步骤

Get Rube MCP: Add

https://rube.app/mcp

as an MCP server in your client configuration. No API keys needed — just add the endpoint and it works.

Verify Rube MCP is available by confirming
```
RUBE_SEARCH_TOOLS
```
responds
Call
```
RUBE_MANAGE_CONNECTIONS
```
with toolkit
```
zoho
```
If connection is not ACTIVE, follow the returned auth link to complete Zoho OAuth
Confirm connection status shows ACTIVE before running any workflows

获取Rube MCP：在客户端配置中添加

https://rube.app/mcp

作为MCP服务器。无需API密钥——只需添加端点即可使用。

通过确认
```
RUBE_SEARCH_TOOLS
```
能正常响应，验证Rube MCP是否可用
调用
```
RUBE_MANAGE_CONNECTIONS
```
并指定工具包
```
zoho
```
如果连接状态未显示为ACTIVE，请按照返回的授权链接完成Zoho OAuth认证
在运行任何工作流之前，确认连接状态为ACTIVE

Core Workflows

核心工作流

1. Search and Retrieve Records

1. 搜索与检索记录

When to use: User wants to find specific CRM records by criteria

Tool sequence:

```
ZOHO_LIST_MODULES
```
- List available CRM modules [Prerequisite]
```
ZOHO_GET_MODULE_FIELDS
```
- Get field definitions for a module [Optional]
```
ZOHO_SEARCH_ZOHO_RECORDS
```
- Search records by criteria [Required]
```
ZOHO_GET_ZOHO_RECORDS
```
- Get records from a module [Alternative]

Key parameters:

```
module
```
: Module name (e.g., 'Leads', 'Contacts', 'Deals', 'Accounts')
```
criteria
```
: Search criteria string (e.g., 'Email:equals:john@example.com')
```
fields
```
: Comma-separated list of fields to return
```
per_page
```
: Number of records per page
```
page
```
: Page number for pagination

Pitfalls:

Module names are case-sensitive (e.g., 'Leads' not 'leads')
Search criteria uses specific syntax: 'Field:operator:value'
Supported operators: equals, starts_with, contains, not_equal, greater_than, less_than
Complex criteria use parentheses and AND/OR: '(Email:equals:john@example.com)AND(Last_Name:equals:Doe)'
GET_ZOHO_RECORDS returns all records with optional filtering; SEARCH is for targeted lookups

适用场景：用户希望根据条件查找特定的CRM记录

工具执行顺序:

```
ZOHO_LIST_MODULES
```
- 列出所有可用的CRM模块 [前提步骤]
```
ZOHO_GET_MODULE_FIELDS
```
- 获取指定模块的字段定义 [可选]
```
ZOHO_SEARCH_ZOHO_RECORDS
```
- 根据条件搜索记录 [必需]
```
ZOHO_GET_ZOHO_RECORDS
```
- 从模块中获取记录 [替代方案]

关键参数:

```
module
```
: 模块名称（例如：'Leads'、'Contacts'、'Deals'、'Accounts'）
```
criteria
```
: 搜索条件字符串（例如：'Email:equals:john@example.com'）
```
fields
```
: 要返回的字段列表，以逗号分隔
```
per_page
```
: 每页显示的记录数量
```
page
```
: 分页页码

注意事项:

模块名称区分大小写（例如：'Leads'而非'leads'）
搜索条件使用特定语法：'字段:操作符:值'
支持的操作符：equals、starts_with、contains、not_equal、greater_than、less_than
复杂条件需使用括号和AND/OR：'(Email:equals:john@example.com)AND(Last_Name:equals:Doe)'
GET_ZOHO_RECORDS会返回所有记录并支持可选过滤；SEARCH用于精准查找

2. Create Records

2. 创建记录

When to use: User wants to add new leads, contacts, deals, or other CRM records

Tool sequence:

```
ZOHO_GET_MODULE_FIELDS
```
- Get required fields for the module [Prerequisite]
```
ZOHO_CREATE_ZOHO_RECORD
```
- Create a new record [Required]

Key parameters:

```
module
```
: Target module name (e.g., 'Leads', 'Contacts')
```
data
```
: Record data object with field-value pairs
Required fields vary by module (e.g., Last_Name for Contacts)

Pitfalls:

Each module has mandatory fields; use GET_MODULE_FIELDS to identify them
Field names use underscores (e.g., 'Last_Name', 'Email', 'Phone')
Lookup fields require the related record ID, not the name
Date fields must use 'yyyy-MM-dd' format
Creating duplicates is allowed unless duplicate check rules are configured

适用场景：用户希望添加新的销售线索、联系人、交易或其他CRM记录

工具执行顺序:

```
ZOHO_GET_MODULE_FIELDS
```
- 获取目标模块的必填字段 [前提步骤]
```
ZOHO_CREATE_ZOHO_RECORD
```
- 创建新记录 [必需]

关键参数:

```
module
```
: 目标模块名称（例如：'Leads'、'Contacts'）
```
data
```
: 包含字段-值对的记录数据对象
必填字段因模块而异（例如：Contacts模块的Last_Name）

注意事项:

每个模块都有必填字段；请使用GET_MODULE_FIELDS确认这些字段
字段名称使用下划线格式（例如：'Last_Name'、'Email'、'Phone'）
关联字段需要相关记录的ID，而非名称
日期字段必须使用'yyyy-MM-dd'格式
除非配置了重复检查规则，否则允许创建重复记录

3. Update Records

3. 更新记录

When to use: User wants to modify existing CRM records

Tool sequence:

```
ZOHO_SEARCH_ZOHO_RECORDS
```
- Find the record to update [Prerequisite]
```
ZOHO_UPDATE_ZOHO_RECORD
```
- Update the record [Required]

Key parameters:

```
module
```
: Module name
```
record_id
```
: ID of the record to update
```
data
```
: Object with fields to update (only changed fields needed)

Pitfalls:

record_id must be the Zoho record ID (numeric string)
Only provide fields that need to change; other fields are preserved
Read-only and system fields cannot be updated
Lookup field updates require the related record ID

适用场景：用户希望修改现有的CRM记录

工具执行顺序:

```
ZOHO_SEARCH_ZOHO_RECORDS
```
- 找到需要更新的记录 [前提步骤]
```
ZOHO_UPDATE_ZOHO_RECORD
```
- 更新记录 [必需]

关键参数:

```
module
```
: 模块名称
```
record_id
```
: 要更新的记录ID
```
data
```
: 包含需要更新字段的对象（只需提供变更的字段）

注意事项:

record_id必须是Zoho记录的ID（数字字符串）
仅提供需要变更的字段；其他字段将保持不变
只读字段和系统字段无法更新
关联字段的更新需要相关记录的ID

4. Convert Leads

4. 转换销售线索

When to use: User wants to convert a lead into a contact, account, and/or deal

Tool sequence:

```
ZOHO_SEARCH_ZOHO_RECORDS
```
- Find the lead to convert [Prerequisite]
```
ZOHO_CONVERT_ZOHO_LEAD
```
- Convert the lead [Required]

Key parameters:

```
lead_id
```
: ID of the lead to convert
```
deal
```
: Deal details if creating a deal during conversion
```
account
```
: Account details for the conversion
```
contact
```
: Contact details for the conversion

Pitfalls:

Lead conversion is irreversible; the lead record is removed from the Leads module
Conversion can create up to three records: Contact, Account, and Deal
Existing account matching may occur based on company name
Custom field mappings between Lead and Contact/Account/Deal modules affect the outcome

适用场景：用户希望将销售线索转换为联系人、客户账户和/或交易

工具执行顺序:

```
ZOHO_SEARCH_ZOHO_RECORDS
```
- 找到需要转换的销售线索 [前提步骤]
```
ZOHO_CONVERT_ZOHO_LEAD
```
- 转换销售线索 [必需]

关键参数:

```
lead_id
```
: 要转换的销售线索ID
```
deal
```
: 转换时创建交易的详细信息
```
account
```
: 转换对应的客户账户详细信息
```
contact
```
: 转换对应的联系人详细信息

注意事项:

销售线索转换不可逆；转换后线索记录将从Leads模块中移除
转换最多可创建三条记录：联系人、客户账户和交易
系统可能会根据公司名称匹配现有的客户账户
销售线索与联系人/客户账户/交易模块之间的自定义字段映射会影响转换结果

5. Manage Tags and Related Records

5. 管理标签与关联记录

When to use: User wants to tag records or manage relationships between records

Tool sequence:

```
ZOHO_CREATE_ZOHO_TAG
```
- Create a new tag [Optional]
```
ZOHO_UPDATE_RELATED_RECORDS
```
- Update related/linked records [Optional]

Key parameters:

```
module
```
: Module for the tag
```
tag_name
```
: Name of the tag
```
record_id
```
: Parent record ID (for related records)
```
related_module
```
: Module of the related record
```
data
```
: Related record data to update

Pitfalls:

Tags are module-specific; a tag created for Leads is not available in Contacts
Related records require both the parent record ID and the related module
Tag names must be unique within a module
Bulk tag operations may hit rate limits

适用场景：用户希望为记录添加标签或管理记录之间的关联关系

工具执行顺序:

```
ZOHO_CREATE_ZOHO_TAG
```
- 创建新标签 [可选]
```
ZOHO_UPDATE_RELATED_RECORDS
```
- 更新关联/链接的记录 [可选]

关键参数:

```
module
```
: 标签所属的模块
```
tag_name
```
: 标签名称
```
record_id
```
: 父记录ID（用于关联记录）
```
related_module
```
: 关联记录所属的模块
```
data
```
: 要更新的关联记录数据

注意事项:

标签是模块专属的；为Leads创建的标签无法在Contacts中使用
关联记录需要同时提供父记录ID和关联模块
标签名称在模块内必须唯一
批量标签操作可能会触发速率限制

Common Patterns

常见模式

Module and Field Discovery

模块与字段发现

1. Call ZOHO_LIST_MODULES to get all available modules
2. Call ZOHO_GET_MODULE_FIELDS with module name
3. Identify required fields, field types, and picklist values
4. Use field API names (not display labels) in data objects

1. 调用ZOHO_LIST_MODULES获取所有可用模块
2. 传入模块名称调用ZOHO_GET_MODULE_FIELDS
3. 确认必填字段、字段类型和下拉选项值
4. 在数据对象中使用字段的API名称（而非显示标签）

Search Criteria Syntax

搜索条件语法

Simple search:

criteria: '(Email:equals:john@example.com)'

Combined criteria:

criteria: '((Last_Name:equals:Doe)AND(Email:contains:example.com))'

Supported operators:

```
equals
```
,
```
not_equal
```
```
starts_with
```
,
```
contains
```

greater_than

less_than

greater_equal

less_equal

```
between
```
(for dates/numbers)

简单搜索:

criteria: '(Email:equals:john@example.com)'

组合条件:

criteria: '((Last_Name:equals:Doe)AND(Email:contains:example.com))'

支持的操作符:

```
equals
```
,
```
not_equal
```
```
starts_with
```
,
```
contains
```

greater_than

less_than

greater_equal

less_equal

```
between
```
（用于日期/数字）

Pagination

分页处理

Set
```
per_page
```
(max 200) and
```
page
```
starting at 1
Check response
```
info.more_records
```
flag
Increment page until more_records is false
Total count available in response info

设置
```
per_page
```
（最大200）和起始页码
```
page
```
为1
检查响应中的
```
info.more_records
```
标志
逐页递增页码直到more_records为false
总记录数可在响应的info中获取

Known Pitfalls

常见注意事项

Field Names:

Use API names, not display labels (e.g., 'Last_Name' not 'Last Name')
Custom fields have API names like 'Custom_Field1' or user-defined names
Picklist values must match exactly (case-sensitive)

Rate Limits:

API call limits depend on your Zoho CRM plan
Free plan: 5000 API calls/day; Enterprise: 25000+/day
Implement delays between bulk operations
Monitor 429 responses and respect rate limit headers

Data Formats:

Dates: 'yyyy-MM-dd' format
DateTime: 'yyyy-MM-ddTHH:mm:ss+HH:mm' format
Currency: Numeric values without formatting
Phone: String values (no specific format enforced)

Module Access:

Access depends on user role and profile permissions
Some modules may be hidden or restricted in your CRM setup
Custom modules have custom API names

字段名称:

使用API名称而非显示标签（例如：'Last_Name'而非'姓氏'）
自定义字段的API名称格式为'Custom_Field1'或用户自定义名称
下拉选项值必须完全匹配（区分大小写）

速率限制:

API调用限制取决于你的Zoho CRM套餐
免费套餐：每日5000次API调用；企业套餐：每日25000+次
在批量操作之间设置延迟
监控429响应并遵循速率限制头部信息

数据格式:

日期：'yyyy-MM-dd'格式
日期时间：'yyyy-MM-ddTHH:mm:ss+HH:mm'格式
货币：无格式的数值
电话：字符串格式（无强制要求）

模块权限:

访问权限取决于用户角色和配置文件权限
部分模块可能在你的CRM设置中被隐藏或限制
自定义模块有自定义的API名称

Quick Reference

快速参考

Task	Tool Slug	Key Params
List modules	ZOHO_LIST_MODULES	(none)
Get module fields	ZOHO_GET_MODULE_FIELDS	module
Search records	ZOHO_SEARCH_ZOHO_RECORDS	module, criteria
Get records	ZOHO_GET_ZOHO_RECORDS	module, fields, per_page, page
Create record	ZOHO_CREATE_ZOHO_RECORD	module, data
Update record	ZOHO_UPDATE_ZOHO_RECORD	module, record_id, data
Convert lead	ZOHO_CONVERT_ZOHO_LEAD	lead_id, deal, account, contact
Create tag	ZOHO_CREATE_ZOHO_TAG	module, tag_name
Update related records	ZOHO_UPDATE_RELATED_RECORDS	module, record_id, related_module, data

任务	工具标识	关键参数
列出模块	ZOHO_LIST_MODULES	无
获取模块字段	ZOHO_GET_MODULE_FIELDS	module
搜索记录	ZOHO_SEARCH_ZOHO_RECORDS	module, criteria
获取记录	ZOHO_GET_ZOHO_RECORDS	module, fields, per_page, page
创建记录	ZOHO_CREATE_ZOHO_RECORD	module, data
更新记录	ZOHO_UPDATE_ZOHO_RECORD	module, record_id, data
转换销售线索	ZOHO_CONVERT_ZOHO_LEAD	lead_id, deal, account, contact
创建标签	ZOHO_CREATE_ZOHO_TAG	module, tag_name
更新关联记录	ZOHO_UPDATE_RELATED_RECORDS	module, record_id, related_module, data