插入记录
目的
要在模块中添加新实体或记录。您可以在一次 API 调用中插入最多 100 条记录。
端点
- POST /{module_api_name}
{module_api_name} : 您想要添加记录的模块的 API 名称。
请求详情
请求 URL
{api-domain}/crm/{version}/{module_api_name}
支持的模块
潜在客户,Account,联系人,交易,活动,任务,案例,会议,电话,解决方案,产品,Vendors,价格表,报价单,Sales Orders,采购Orders,Invoices,预约,重新安排的预约历史,服务和自定义
标题
授权: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
范围
scope=ZohoCRM.modules.ALL
(或)
scope=ZohoCRM.modules.{module_name}.{operation_type}
可能的模块名称
线索、账户、联系人、交易、活动、任务、案例、事件、电话、解决方案、产品、供应商、价格表、报价单、销售订单、采购订单、发票、自定义、预约、预约重新安排历史、服务和备注
可能的操作类型
全部 - 完全访问记录
写入 - Edit 模块中的记录
创建 - 在模块中创建记录
注意
- 要插入单条记录,只需在输入中发送一个JSON对象,并包含必要的键和值。
- 如果字段值长度超过该字段的最大定义长度,将抛出 'INVALID_DATA' 错误。
- 如果在函数内部使用API,并且字段值超过允许的长度,函数将从API接收到错误响应。
- 例如,如果一个文本字段的最大长度为10,API不能接受像"12345678901"这样的值,因为它的长度为11个字符,超过了限制。
- 每次插入记录的 API 调用都会基于唯一字段检查重复项。
- 每次 API 调用最多可以插入 100 条记录。
- 您必须仅在输入中使用字段 API Name。您可以从以下位置获取字段 API Name:
- 字段元数据 API(每个字段的键“api_Name”的值)。(或者)
- 设置 > 开发者中心 > API 和 SDK > API Name > {{模块}}。从“筛选条件”下拉菜单中选择“字段”。
- 触发器输入可以是工作流、审批、蓝图、探路者或编排(用于Journey Builder功能)。如果未提及触发器,则将执行与API相关的自动化操作。输入触发器值为[]以不执行工作流。
- 带有子表单详细信息的记录也可以使用记录API插入到CRM中。请参阅子表单API,了解如何在记录中添加子表单信息。有关子表单的详细信息,请参阅我们的Kaizen帖子:使用Zoho CRM API操作子表单。
- $approved 键用于在审批模式下创建记录。它主要用于从网络表单获取的线索和联系人。将值指定为false以在审批模式下创建记录。
- 如果依赖记录被锁定,多选查找关联将受到限制,系统将抛出RECORD_LOCKED错误。
- 在通话模块中,呼入或呼出通话的通话时长不能为零。
- 对于任何模块,在创建记录时请指定所有必填字段。请参阅必填字段部分,了解不同模块的系统定义必填字段。
示例请求
Copiedcurl "https://www.zohoapis.com/crm/v8/Leads"
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
-d "@newlead.json"
-X POST每个模块的系统定义必填字段
在插入记录时,有一些系统定义的必填字段需要提及。要成功在Zoho CRM中插入记录,请确保也输入用户定义的必填字段。
- 潜在客户
"Last_Name" - 单行
- 联系人
"Last_Name" - 单行
- Accounts
"Account_Name" - 单行
- 交易
"交易_Name" - 单行
"阶段" - 下拉列表
"管道" - 单行(启用管道时为必填项) - 任务
"主题" - 多行
- 通话
"主题" - 多行
"通话类型" - 下拉列表
"通话开始时间" - 日期/时间
"通话时长" - 单行 - 事件
"事件标题" - 单行
"开始时间" - 日期/时间
"提醒时间" - 单行 "结束时间" - 日期/时间 - 产品
"Product_Name" - 单行
- 引用
"主题" - 单行
"引用_Items" - 行项目子表单 - Invoices
"主题"- 单行
"Invoiced_Items" - 行项目子表单 - 活动
"活动_Name" - 单行
- Vendors
"供应商_Name"- 单行
- 价格表
"价格表_Name"- 单行
"定价详情"- JSON 数组,包含 "from_range", "to_range", "discount" - 案件
"案件来源" - 下拉列表
"Status"- 下拉列表
"主题" - 单行文本 - 解决方案
"解决方案标题" - 单行
- Purchase Orders
"主题"- 单行
"供应商_Name"- 查找
"购买的_Items" - 行项目子表单 - Sales Orders
"主题" - 单行
"Order的_Items" - 行项目子表单
示例Attributes
下表为您提供了Zoho CRM中每种字段类型的具体细节及其限制。字段类型的JSON类型和数据类型是从字段元数据API中提取的。
- 单行字符串
接受最多255个字符,包括字母数字和特殊字符。
示例:"Last_Name": "Mike O'Leary" - 多行字符串
小 - 接受最多2000个字符。
大 - 接受最多32000个字符。
您将无法使用此字段创建自定义视图、报告或其他过滤器。接受字母数字和特殊字符。
示例:"Multi_Line_1": "这是第一行 \n 现在是第二行" - Email字符串
接受有效的Email ID。
示例:"Email_1": "p.boyle@zylker.com"。Zoho CRM中用于验证Email字段的正则表达式是:
"^[\\+\\-\\p{L}\\p{M}\\p{N}_]([\\p{L}\\p{M}\\p{N}!#$%&'*+\\-\\/=?^_`{|}~.]*)@(?=.{4,256}$)(([\\p{L}\\p{N}\\p{M}]+)(([\\-_]*[\\p{L}\\p{M}\\p{N}])*)[.])+[\\p{L}\\p{M}]{2,22}$” - 电话字符串
接受最多30个字符。此限制可能会根据UI中字段属性弹出窗口中配置的“允许字符数”值而有所不同。
Zoho CRM中用于验证此字段值的正则表达式模式是^([+]?)(?![.-])(?>(?>[.-]?[ ]?[\da-zA-Z]+)+|([ ]?((?![.-])(?>[ .-]?[\da-zA-Z]+)+)(?![.])([ -]?[\da-zA-Z]+)?)+)+(?>(?>([,]+)?[;]?[\da-zA-Z]+)+(([#][\da-zA-Z]+)+)?)?[#;]?$
示例:"Phone_1": "9900000000"
"Phone_1":"91(987)654321" - 选择列表字符串
您可以传递现有的选择列表值或添加一个新的。选择列表值接受所有字母数字和特殊字符。
示例:"行业": "汽车" - 多选下拉列表JSON 数组
您可以传递现有的下拉列表值或添加新的值。下拉列表值接受所有字母数字和特殊字符。。
示例:"Courses_Opted": [
"Analytics",
"Big data"
] - 日期字符串
接受 yyyy-MM-dd 格式的日期。
示例: "Date_1": "2017-08-16" - 日期/时间字符串
接受 yyyy-MM-ddTHH:mm:ss±HH:mm 格式的日期和时间。
示例: "Date_Time": "2017-08-16T14:32:23+05:30".
Date_Time 是 ISO8601 格式,时区为当前用户的时区。 - 数字整数
接受最多9位数的数字。此限制可能会根据UI中字段属性弹出窗口中配置的“允许的最大位数”值而有所不同。仅接受数字值。
- 货币双精度
小数点前 - 接受最多16位数字。此限制可能会根据UI中字段属性弹出窗口中配置的“允许的最大位数”值而有所不同。
小数点后 - 接受最多9位精度。此限制可能会根据UI中字段属性弹出窗口中配置的“小数位数”值而有所不同。仅接受数字值。
示例:"Annual_Revenue": 250000.90 - Decimaldouble
小数点前 - 接受最多16位的数字。此限制可能会根据UI中字段属性弹出窗口中配置的“允许的最大位数”值而有所不同。
小数点后 - 接受最多9位的精度。此限制可能会根据UI中字段属性弹出窗口中配置的“小数位数”值而有所不同。
仅接受数字值。
示例:"Decimal_1": 250000.50 - 百分比双精度
接受最多5位数且仅限数值。
示例:"百分比": 25 - 长整数字符串
接受最多18位的数字。此限制可能会根据UI中字段属性弹出窗口中配置的“允许的最大位数”值而有所不同。仅接受数字值。
示例:"EAN_Code":"0012345600012" - 复选框布尔值
仅接受布尔值(true,false)
示例:"Email_Opt_Out": true - URLstring
接受有效的URL。Zoho CRM中用于验证此字段值的正则表达式模式是^(http:\\/\\/www.|https:\\/\\/www.|ftp:\\/\\/www.|www.|http:\\/\\/|https:\\/\\/|ftp:\\/\\/|){1}[^\\x00-\\x19\\x22-\\x27\\x2A-\\x2C\\x2E-\\x2F\\x3A-\\x3F\\x5B-\\x5E\\x60\\x7B\\x7D-\\x7F]+(\\.[^\\x00-\\x19\\x22\\x24-\\x2C\\x2E-\\x2F\\x3C\\x3E\\x40\\x5B-\\x5E\\x60\\x7B\\x7D-\\x7F]+)+([\\/\\?].*)*$
示例:"URL": "https://www.zylker.com" - 查找JSON 对象
接受记录的唯一ID,您可以通过 获取记录 API 获取该ID。
示例:"查找" : {
"id" : "425248000000104001"
} - 用户JSON 对象
这是 Zoho CRM 中用户的默认查找字段。
示例:"用户":
{
"name":"Patricia Boyle",
"id":"4150868000000623001"
} - lar_idstring
您希望在插入记录时触发的分配规则的唯一ID。使用获取分配规则API来获取lar_id。此键必须与键data并行提供。
注意:lar_id键支持所有适用分配规则的模块,例如潜在客户、联系人、交易、Account、任务、案例和自定义模块。 - 布局JSON 对象
ID 代表布局的唯一 ID。您可以从 元数据布局 API 获取您的布局 ID。
注意
如果您想要
- 在 API 级别的强制检查中包含布局特定的必填字段
- 仅包含在您的布局中定义的字段进行 API 级别处理并忽略其余字段
您必须提供布局 ID 字段
- $wizard_connection_pathJSON 数组
在创建记录时,向导中指示屏幕遍历的连接ID。使用 获取向导 响应中 "containers" 数组的 "connections" 键中的ID。
- Wizardstring
要创建记录的向导的ID。使用获取向导 API来获取向导的ID。
- apply_feature_executionJSON array
使用此数组在创建记录时应用现有的布局规则。布局规则允许您显示一个部分、某些字段、设置必填字段或显示子表单。然而,您只能通过API触发“设置必填字段”选项。
指定name键的值为layout_rules,以将布局规则应用于记录。请注意,您必须与“data”并行提供此键。
确保输入主体包含满足布局规则条件所需的所有键。否则,系统会抛出错误。例如,如果布局规则在Lead_Source为Employee Referral时触发,并且您已将Company字段设为必填字段,那么如果您在输入中未提供Company键,系统将抛出MANDATORY_NOT_FOUND错误。 - skip_feature_executionJSON array
默认情况下,如果为模块配置了Cadence,则在通过API创建记录时将自动执行。此键允许您在记录创建期间跳过Cadences功能的执行。
指定"cadences"作为"name"键的值以跳过记录的Cadences执行。确保在请求中包含此键以及"data"键。"name"键支持的值是"cadences"。
示例输入
Copied{
"data": [
{
"Layout": {
"id": "554023000002734009"
},
"Lead_Source": "Employee Referral",
"Company": "ABC",
"Last_Name": "Daly",
"First_Name": "Paul",
"Email": "p.daly@zylker.com",
"State": "Texas"
},
{
"Layout": {
"id": "554023000002734009"
},
"Lead_Source": "Employee Referral",
"Company": "ABC"
"Last_Name": "Dolan",
"First_Name": "Brian",
"Email": "brian@villa.com",
"State": "Texas"
}
],
"apply_feature_execution": [
{
"name": "layout_rules"
}
],
"skip_feature_execution": [
{
"name": "cadences"
}
],
"trigger": [
"approval",
"workflow",
"blueprint",
"pathfinder",
"orchestration"
]
}示例响应
Copied{
"data": [
{
"code": "SUCCESS",
"details": {
"Modified_Time": "2023-05-10T01:10:47-07:00",
"Modified_By": {
"name": "Patricia Boyle",
"id": "5725767000000411001"
},
"Created_Time": "2023-05-10T01:10:47-07:00",
"id": "5725767000000524157",
"Created_By": {
"name": "Patricia Boyle",
"id": "5725767000000411001"
},
"$approval_state": "approved"
},
"message": "record added",
"status": "success"
}
{
"code": "SUCCESS",
"details": {
"Modified_Time": "2023-05-10T01:10:47-07:00",
"Modified_By": {
"name": "Patricia Boyle",
"id": "5725767000000411001"
},
"Created_Time": "2023-05-10T01:10:47-07:00",
"id": "5725767000000524157",
"Created_By": {
"name": "Patricia Boyle",
"id": "5725767000000424162"
},
"$approval_state": "approved"
},
"message": "record added",
"status": "success"
}
]
}本节解释了在交易模块中用于管道、图片上传、文件上传、多选查找和多用户查找字段的输入JSON。
- Pipelinestring
您希望将记录分配到的Pipeline名称。请注意,当Deals模块启用了Pipeline时,此键是必需的。此外,必须输入交易记录的Stage。使用获取Pipelines API来获取Pipeline的名称。
在布局元数据API中,maps键内的pick_list_values表示Pipeline中可用的阶段。您只能将此列表中可用的阶段添加到该Pipeline的交易中。否则系统会抛出错误。
- Image_UploadJSON Array
模块中图像上传字段的 API 名称。
- File_Id__s string,mandatory
您在通过 文件 API 添加图像时收到的 File_Id。
在插入记录时,您可以向图像上传字段添加多个图像。请参阅右侧窗格中的示例以了解 JSON 结构。
- File_Upload JSON Array
模块中文件上传字段的 API 名称。
- File_Id__s string,mandatory
您在通过 文件 API 添加文件时收到的文件 ID。
在插入记录时,您可以向文件上传字段添加多个文件。请参阅右侧窗格中的示例以了解 JSON 结构。
- 多选查找
当您在父模块中创建一个多选查找字段以关联子模块中的多个记录时,会在父模块和子模块之间创建一个链接模块。在链接模块中,这些数据被安排为两个不同的查找字段,分别对应父模块和子模块。要向父模块中的多选查找字段添加值,您必须包含子模块查找字段的API名称,并指定您要与父模块关联的子模块记录的ID。
有关多选查找字段(MxN)的详细信息,请参阅我们的Kaizen帖子:使用Zoho CRM API操作多选查找字段(MxN)。
在此示例中,Listings是交易模块(父模块)中的一个多选查找字段,用于关联Listings模块(子模块)中的记录。Interested_Listings是链接模块中的查找字段。请参阅右侧窗格中的示例以了解JSON结构。
- 列表JSON 数组感兴趣的列表JSON 对象
链接模块中查找字段的 API 名称。
- id String
您想要与父模块关联的子模块中记录的唯一ID。
- 多用户查找
多用户查找字段的API名称。接受用户的ID作为单独的JSON对象。请参阅JSON结构的示例。
- 多用户JSON数组多用户JSON对象
多用户查找字段的API名称。
- id String
要与多用户查找字段关联的用户的唯一ID。
示例请求
Copiedcurl "https://www.zohoapis.com/crm/v8/Deals"
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
-d "@newquote.json"
-X POST示例输入
Copied{
"data": [
{
"Deal_Name": "Insert",
"Stage": "Qualification",
"Pipeline": "Standard (Standard)",
"Image_Upload": [
{
"File_Id__s": "2cxxxxxxxxxxxx2fa"
},
{
"File_Id__s": "2cxxxxxxxxxxxx4fa"
}
],
"File_Upload": [
{
"File_Id__s": "2cxxxxxxxxxxxx4fc"
},
{
"File_Id__s": "2cxxxxxxxxxxxx8gs"
}
]
"Listings": [
{
"Interested_Listings": {
"id": "3652397000001978005"
}
},
{
"Interested_Listings": {
"id": "3652397000001978016"
}
}
],
"Multi_user": [
{
"Multi_user": {
"name": "Patricia Boyle",
"id": "3652397000000186017"
}
},
{
"Multi_user": {
"name": "J Smith",
"id": "3652397000000281001"
}
}
]
}
]
}示例响应
Copied{
"data": [
{
"code": "SUCCESS",
"details": {
"Modified_Time": "2021-10-10T10:30:15+05:30",
"Modified_By": {
"name": "Patricia Boyle",
"id": "3652397000000186017"
},
"Created_Time": "2021-10-10T10:30:15+05:30",
"id": "3652397000006064046",
"Created_By": {
"name": "Patricia Boyle",
"id": "3652397000000186017"
},
"$approval_state": "approved"
},
"message": "record added",
"status": "success"
},
{
"code": "SUCCESS",
"details": {
"Modified_Time": "2021-10-10T10:30:15+05:30",
"Modified_By": {
"name": "Patricia Boyle",
"id": "3652397000000186017"
},
"Created_Time": "2021-10-10T10:30:15+05:30",
"id": "3652397000006064047",
"Created_By": {
"name": "Patricia Boyle",
"id": "3652397000000186017"
},
"$approval_state": "approved"
},
"message": "record added",
"status": "success"
}
]
}Inventory模块的示例输入
本节解释了在任何库存模块(报价,Sales Orders,采购Orders,Invoices)中插入记录时输入主体中的各种键。
行项目详细信息以子表单的形式给出。报价,Sales Orders,采购Orders和Invoices的此子表单的父键分别为Quoted_Items,Order_Items,Purchased_Items和Invoice_Items。此子表单的所有其他键在所有库存模块中都是通用的。
在插入任何这些库存模块中的记录时,此子表单是必填项。
除了这个子表单,您还必须在输入主体中提供该模块中的其他必填键。
我们提供了一个插入报价的示例。
- 主题字符串,必填
接受最多255个字符,并且字母数字和特殊字符。
- Quoted_ItemsJSON数组,必填
报价的详细信息,例如产品名称、价格表名称、各种税费、折扣、数量等。
使用字段元数据API获取这些键的API名称和数据类型。
示例请求
Copiedcurl "https://www.zohoapis.com/crm/v8/Quotes"
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
-d "@newquote.json"
-X POST示例输入
Copied{
"data": [
{
"Subject": "quote v6",
"$line_tax": [
{
"percentage": 1.5,
"name": "Common Tax"
}
],
"Quoted_Items": [
{
"Product_Name": {
"name": "ZCRM_Product",
"id": "3652397000000416001"
},
"Quantity": 100,
"Discount": 0,
"Price_Book_Name": {
"id": "3652397000000491235",
"name": "Price Book 1"
},
"Description": "description",
"Line_Tax": [
{
"percentage": 10,
"name": "Sales Tax"
},
{
"percentage": 1,
"name": "Vat"
}
]
}
]
}
]
}插入一个呼叫的示例输入
您可以插入一条记录,用于计划的、已完成的和未接的电话。
- 主题字符串,必填
接受最多255个字符,包括字母数字和特殊字符。
- Call_Type字符串,必填
通话类型。可能的值是呼入、呼出或未接。
- Who_IdJSON 对象,计划通话时必填
您想要关联通话的联系人的姓名和ID。
- What_IdJSON 对象,计划呼叫时必填
您希望将呼叫关联到的记录(联系人除外)的名称和ID。
- $se_module字符串,当提供 What_Id 时为必填项
在 What_Id 中指定的记录模块的 API 名称。
- Call_Start_TimeISO8601格式的日期时间,计划和已完成的通话必填
通话开始的日期和时间。对于计划的通话,此时间必须大于当前时间。
- 通话时长字符串,已完成通话时为必填项
通话持续的时间,格式为 HH:mm。
- Call_Purposestring, optional
通话目的。请使用字段元数据 API获取此字段的可能值。
- Outbound_Call_Statusstring, optional
外呼电话的Status。可能的值是已安排或已完成。
示例输入以插入一个调用
Copied{
"data": [
{
"Who_Id": {
"name": "Patricia Boyle",
"id": "3652397000000649013"
},
"Description": "Discussion ZCRM",
"Call_Start_Time": "2021-02-23T13:30:00+05:30",
"Subject": "Discussion",
"Call_Type": "Outbound",
"Outbound_Call_Status": "Completed",
"Call_Duration": "10:00",
"Call_Purpose": "Administrative"
}
]
}插入一个重复事件的示例输入
- Event_Title字符串,必填
表示事件的名称,接受字母数字和特殊字符。
- All_day布尔值,可选
表示事件是否持续一整天。
可能的值:
True: 事件持续一整天或超过一天。
False: 事件持续时间少于一天。 - Start_DateTimeDateTime,必填
表示事件的开始日期和时间。该值应以ISO8601格式给出。
- End_DateTimeDateTime,必填
提供事件的结束日期和时间。该值应以ISO8601格式给出。
- 参与者JSON 对象,可选
包含事件参与者的姓名、参与者和类型。
类型:表示您CRM中参与者记录的模块。您还可以在此键中指定Email,以使用参与者的Email ID 并将其添加到事件中。可能的值:潜在客户、联系人、用户和Email。
参与者:此键保存参与者的记录 ID。
Email:当"类型":"Email"时,使用此键指定参与者的Email ID。 - What_IdJSON 对象,可选
包含与事件相关的记录的名称和ID。
- $se_module字符串,What_ID 必填
表示在 What_ID 中指定的记录的模块 API 名称。
可能的值:Account,Deals,Products,Quotes,Sales_Orders,Purchase_Orders,Invoices,Campaigns,Vendors,和 Cases。 - Who_IdJSON 对象,可选
包含与 What_ID 相关的参与者的姓名和 ID,该参与者也与事件相关联。
- Remind_AtJSON 数组,定期会议必填
表示您希望为事件设置提醒的时间。提醒应以字符串"单位 时间段"的格式给出。例如,15 分钟和2 小时。
可能的值:
单位:0 到 60 之间的数字
时间段:分钟、小时、天、周。 - Recurring_ActivityJSON object, optional
包含创建重复会议的RRULE。您可以在FREQ、INTERVAL和UNTIL键中分别设置会议的频率、间隔以及重复到哪个日期和时间。
示例输入
Copied{
"data": [
{
"Event_Title": "New Meeting",
"All_day": false,
"Start_DateTime": "2023-05-20T09:00:00+05:30",
"End_DateTime": "2023-05-20T10:00:00+05:30",
"Participants": [
{
"name": "John",
"type": "contact",
"participant": "5545974000002858122"
},
{
"type": "email",
"Email": "patricia.boyle@zylker.com"
}
],
"Who_Id": {
"name": "Christopher",
"id": "5545974000002755004"
},
"What_Id": {
"name": "Mega Deal",
"id": "5545974000002755007"
},
"$se_module": "Deals",
"Remind_At": [
{
"unit": 15,
"period": "minutes"
},
{
"unit": 5,
"period": "minutes"
},
{
"unit": 1,
"period": "days",
"time": "10.30"
}
],
"Recurring_Activity": {
"RRULE": "FREQ=DAILY;INTERVAL=1;DTSTART=2023-05-20;UNTIL=2023-05-28"
}
}
]
}示例响应
Copied{
"data": [
{
"code": "SUCCESS",
"details": {
"Modified_Time": "2022-11-02T18:57:39+05:30",
"Modified_By": {
"name": "Patricia Boyle",
"id": "3652397000000186017"
},
"Created_Time": "2022-11-02T18:57:39+05:30",
"id": "3652397000010183179",
"Created_By": {
"name": "Patricia Boyle",
"id": "3652397000000186017"
},
"$approval_state": "approved"
},
"message": "record added",
"status": "success"
},
{
"code": "SUCCESS",
"details": {
"Modified_Time": "2022-11-02T18:57:39+05:30",
"Modified_By": {
"name": "Patricia Boyle",
"id": "3652397000000186017"
},
"Created_Time": "2022-11-02T18:57:39+05:30",
"id": "3652397000010183181",
"Created_By": {
"name": "Patricia Boyle",
"id": "3652397000000186017"
},
"$approval_state": "approved"
},
"message": "record added",
"status": "success"
},
{
"code": "SUCCESS",
"details": {
"Modified_Time": "2022-11-02T18:57:39+05:30",
"Modified_By": {
"name": "Patricia Boyle",
"id": "3652397000000186017"
},
"Created_Time": "2022-11-02T18:57:39+05:30",
"id": "3652397000010183183",
"Created_By": {
"name": "Patricia Boyle",
"id": "3652397000000186017"
},
"$approval_state": "approved"
},
"message": "record added",
"status": "success"
}
]
}插入一个重复任务的示例输入
- 主题字符串,必填
接受最多255个字符,包括字母数字和特殊字符。
- 重复活动JSON 对象,适用于重复任务
定义任务的频率、间隔、开始日期和结束日期的 RRULE。
- Remind_AtJSON 对象,提醒时必填
您要为任务设置的提醒详细信息。
此数组中的每个 JSON 对象包含以下键:
ACTION - 必填。表示您希望提醒通过电子邮件还是弹出窗口。值为 EMAIL 和 POPUP。
TRIGGER - 必填。提醒触发的日期和时间,采用 ISO8601 格式。您还可以指定 -P1D、-P2D、-P3D、-P4D、-P5D、-P6D、-P1W、-P2W、-P3W 以在 "n" 天或 "m" 周之前触发提醒。-PnD 和 -PmW 仅可用于重复任务。对于非重复任务,仅指定日期时间。
TRIGGER_TIME - 使用 -PnD 和 -PmW 时必填。您希望提醒的时间,采用 24 小时格式。
可能的错误
- INVALID_MODULEHTTP 400
给定的模块名称似乎无效
解决方法:您指定了一个无效的模块名称,或者没有标签权限,或者该模块可能已从可用模块中删除。请指定一个有效的模块 API 名称。 - INVALID_MODULEHTTP 400
给定的模块在API中不受支持
解决方法: 当前API不支持Documents和Projects等模块。(一旦这些模块被支持,此错误将不会显示)。请指定一个有效的模块API名称。 - INVALID_DATAHTTP 400
给定的概率无效
解决方法:交易获胜的概率不能小于0%或大于100%。请指定一个有效的概率。 - MULTIPLE_OR_MULTI_ERRORSHTTP 400
多个字段中存在重复数据
解决方法: 您已启用多个字段的重复检查,并且所有或部分字段在输入中包含重复数据。"errors" 数组会提供包含重复数据的字段的模块和 API 名称的详细信息。请为这些字段指定唯一值。 - INVALID_DATAHTTP 400
提供的向导连接未形成有效路径
解决方案: 您必须按正确的顺序指定连接的ID。例如,要在向导的屏幕1和屏幕2中创建记录,您必须依次指定screen1和screen2的连接ID。 - INVALID_DATAHTTP 400
向导连接ID无效
解决方法:指定正确的连接ID。使用获取向导响应中“containers”数组的“connections”键中的ID。 - INVALID_DATAHTTP 400
提供的向导连接未形成有效路径
解决方案: 您必须按正确的顺序指定连接的ID。例如,要在向导的屏幕1和屏幕2中创建记录,您必须依次指定screen1和screen2的连接ID。 - DEPENDENT_FIELD_MISSINGHTTP 400
必填字段未找到
- 在向向导中创建记录时,您未在输入中指定$wizard_connection_path。请在输入中包含键"$wizard_connection_path"。
- 对于Appointments模块,您为Job_Sheet_Required键提供的值为"yes",但输入中没有作业单部分。
- DEPENDENT_SERVICE_ERRORHTTP 400
错误
解决方案:当您在Campaigns模块中插入记录时,如果与CRM集成的依赖服务出现错误。
"NO_PERMISSION"表示您没有权限在依赖服务的模块中创建记录。请联系您的管理员。
"LIMIT_EXCEEDED"表示您尝试添加的记录数超过了每次API调用允许的100条记录的限制。
"PROCESSING_ERROR"表示在处理您的请求时出现了错误。请联系您的管理员。 - INVALID_DATAHTTP 400
数据无效
解决方案:指定的输入键之一存在数据类型不匹配。请参考上面的示例属性部分,并指定有效的输入。 - INVALID_DATAHTTP 400
在 "skip_feature_execution" 属性中的 "name" 键提供了无效的数据
解决方法: 指定 "name" 键的支持值。支持的值是 "cadences"。 - MANDATORY_NOT_FOUNDHTTP 400
在 "skip_feature_execution" 属性中缺少必需的键
解决方案:指定具有有效值 "cadences" 的 "name" 键。 - MANDATORY_NOT_FOUNDHTTP 400
未找到必填字段
解决方案:其中一个输入键的数据类型无效。请参阅上面的示例属性部分,并指定有效的输入。 - INVALID_DATAHTTP 400
数据无效
解决方案:您未指定一个或多个必填字段。请参阅上面每个模块部分的系统定义的必填字段。 - DEPENDENT_MISMATCHHTTP 400
在Appointments模块中,
- 您正在尝试Update与该预约无关的工作单的一个或多个字段。
解决方案:Update与正确的工作单和预约相关的字段。 - 您正在尝试为未完成的预约创建工作单。
解决方案:仅为已完成的预约创建工作单。
- 您正在尝试Update与该预约无关的工作单的一个或多个字段。
- INVALID_URL_PATTERNHTTP 404
请检查尝试访问的URL是否正确
解决方案: 请求的URL不正确。请指定一个有效的请求URL。请参阅上面的请求URL部分。 - OAUTH_SCOPE_MISMATCHHTTP 401
未经授权
解决方案:客户端没有ZohoCRM.modules.{module_name}.CREATE范围。创建一个具有有效范围的新客户端。请参阅上面的范围部分。 - NO_PERMISSIONHTTP 403
没有权限添加记录
解决方案:用户没有添加记录的权限。请联系系统管理员。 - INTERNAL_ERRORHTTP 500
内部服务器错误
解决方法:服务器中出现意外且未处理的异常。请联系支持团队。 - INVALID_REQUEST_METHODHTTP 400
HTTP 请求方法类型无效
解决方案:您指定了一个无效的 HTTP 方法来访问 API URL。请指定一个有效的请求方法。请参阅上面的端点部分。 - AUTHORIZATION_FAILEDHTTP 400
用户没有足够的权限添加记录
解决方法:用户没有添加记录的权限。请联系系统管理员。 - DUPLICATE_DATAHTTP 400
重复数据
解决方案: 您为一个或多个唯一字段指定了重复值。响应中的 "details" 键提供了输入中包含重复值的字段的 API 名称,而 "module" JSON 对象提供了具有相同值的现有记录的 API 名称和 ID。请参阅 字段元数据 API 了解唯一字段。 - LIMIT_EXCEEDEDHTTP 400
一个活动最多只能添加50名参与者。
解决方案:您最多只能向一个活动添加50名参与者。请确保您添加的参与者数量不超过50。 - RECORD_LOCKEDHTTP 400
抱歉,您无法执行此操作,因为记录已被锁定。
解决方案:如果依赖记录处于锁定状态,则多选查找关联受到限制。请确保依赖记录未处于锁定状态,然后重试。 - DEPENDENT_MISMATCHHTTP 400
通话时长不能为零。
解决方法:呼入或呼出通话的时长不能为零。请尝试使用非零值的Call_Duration。
示例输入
Copied{
"data": [
{
"What_Id": {
"id": "3652397000006067001"
},
"$se_module": "Leads",
"Status": "In Progress",
"Send_Notification_Email": true,
"Description": "Design your own layouts that align your business processes precisely. Assign them to profiles appropriately.",
"send_notification": true,
"Subject": "Subject",
"Recurring_Activity":{
"RRULE":"FREQ=DAILY;INTERVAL=1;DTSTART=2022-04-06;UNTIL=2022-04-12"
},
"Remind_At":{
"ALARM":"ACTION=EMAIL;TRIGGER=-P1D;TRIGGER_TIME=22:52"
}
}
]
}示例响应
Copied{
"data": [
{
"code": "SUCCESS",
"details": {
"Modified_Time": "2022-03-13T01:47:05+05:30",
"Modified_By": {
"name": "Patricia Boyle",
"id": "3652397000000186017"
},
"Created_Time": "2022-03-13T01:47:05+05:30",
"id": "3652397000007549434",
"Created_By": {
"name": "Patricia Boyle",
"id": "3652397000000186017"
},
"$approval_state": "approved"
},
"message": "record added",
"status": "success"
},
{
"code": "SUCCESS",
"details": {
"Modified_Time": "2022-03-13T01:47:05+05:30",
"Modified_By": {
"name": "Patricia Boyle",
"id": "3652397000000186017"
},
"Created_Time": "2022-03-13T01:47:05+05:30",
"id": "3652397000007549435",
"Created_By": {
"name": "Patricia Boyle",
"id": "3652397000000186017"
},
"$approval_state": "approved"
},
"message": "record added",
"status": "success"
},
{
"code": "SUCCESS",
"details": {
"Modified_Time": "2022-03-13T01:47:05+05:30",
"Modified_By": {
"name": "Patricia Boyle",
"id": "3652397000000186017"
},
"Created_Time": "2022-03-13T01:47:05+05:30",
"id": "3652397000007549436",
"Created_By": {
"name": "Patricia Boyle",
"id": "3652397000000186017"
},
"$approval_state": "approved"
},
"message": "record added",
"status": "success"
},
{
"code": "SUCCESS",
"details": {
"Modified_Time": "2022-03-13T01:47:05+05:30",
"Modified_By": {
"name": "Patricia Boyle",
"id": "3652397000000186017"
},
"Created_Time": "2022-03-13T01:47:05+05:30",
"id": "3652397000007549437",
"Created_By": {
"name": "Patricia Boyle",
"id": "3652397000000186017"
},
"$approval_state": "approved"
},
"message": "record added",
"status": "success"
},
{
"code": "SUCCESS",
"details": {
"Modified_Time": "2022-03-13T01:47:05+05:30",
"Modified_By": {
"name": "Patricia Boyle",
"id": "3652397000000186017"
},
"Created_Time": "2022-03-13T01:47:05+05:30",
"id": "3652397000007549438",
"Created_By": {
"name": "Patricia Boyle",
"id": "3652397000000186017"
},
"$approval_state": "approved"
},
"message": "record added",
"status": "success"
},
{
"code": "SUCCESS",
"details": {
"Modified_Time": "2022-03-13T01:47:05+05:30",
"Modified_By": {
"name": "Patricia Boyle",
"id": "3652397000000186017"
},
"Created_Time": "2022-03-13T01:47:05+05:30",
"id": "3652397000007549439",
"Created_By": {
"name": "Patricia Boyle",
"id": "3652397000000186017"
},
"$approval_state": "approved"
},
"message": "record added",
"status": "success"
},
{
"code": "SUCCESS",
"details": {
"Modified_Time": "2022-03-13T01:47:05+05:30",
"Modified_By": {
"name": "Patricia Boyle",
"id": "3652397000000186017"
},
"Created_Time": "2022-03-13T01:47:05+05:30",
"id": "3652397000007549440",
"Created_By": {
"name": "Patricia Boyle",
"id": "3652397000000186017"
},
"$approval_state": "approved"
},
"message": "record added",
"status": "success"
}
]
}