创建自定义模块
目的
要在 Zoho CRM 中创建新的自定义模块。
端点
- POST /settings/modules
请求详情
请求 URL
{api-domain}/crm/{version}/settings/modules
标题
授权:Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
范围
ZohoCRM.settings.modules.CREATE (或)
ZohoCRM.settings.modules.ALL (或)
ZohoCRM.settings.ALL
额度消耗
1 积分
每次请求限制
每个 API 调用一个模块
示例请求
Copiedcurl "https://www.zohoapis.com/crm/v8/settings/modules"
-X POST
-d "@input.json"
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"常见输入 JSON 键
- plural_label字符串,必填
表示模块的唯一复数名称。最多允许25个字符(包括空格)。请注意,此字段的值不能为空,并且仅支持字母、数字,和空格。
- singular_label字符串,必填
表示模块的唯一单数名称。最多允许25个字符,包含空格。请注意,该字段的值不能为空,并且仅支持字母、数字和空格。
- profiles字符串,必填
指定应当可以访问该模块的配置文件。至少必须指定一个配置文件。 请参阅 GET Profiles API 以检索您组织中可用的配置文件。
- api_name字符串,可选
表示该模块的唯一 API 名称。最多允许50 个字符,可以包含字母、数字、空格和下划线。
- API 名称应以英文字母字符开头。
- API 名称不应以下下划线 (_)结尾,且不应包含两个连续的下划线 (__)。
请注意,如果你跳过此键,系统将根据 plural_label 字段中提供的值生成 API 名称。
- display_fieldJSON 对象,可选
表示模块显示字段的详细信息。对于 "display_field" 键,支持两个取值。
可能的取值:
autonumber - 当你希望显示字段为每条记录自动生成唯一的编号序列时,请使用 autonumber 数据类型。你可以为自动编号序列设置起始号码、前缀和后缀。
text - 当你希望显示字段为文本字段、由用户手动输入值时,请使用 text 数据类型。
以下部分针对每种数据类型。请注意,系统默认会为显示字段生成 "Text" 数据类型。
输入 JSON
您可以创建一个包含两种字段类型的自定义模块:text 和 autonumber。要添加更多自定义字段,请使用 创建自定义字段 API,并为每种数据类型遵循相同的结构。
数据类型:文本("data_type" : "text")
- display_fieldJSON 对象,可选
表示模块的显示字段的详细信息。
- field_label字符串,必填(当您指定显示字段时,field_label 或 data_type 其中之一为必填)
表示该字段的唯一显示标签。
- data_type字符串,必填(当您指定显示字段时,data_type 或 field_label 其中之一为必填)
表示字段的数据类型。
Input JSON
数据类型:自动编号 ("data_type" : "autonumber")
- display_fieldJSON object, optional
Represents the details of the display field of a module.
- field_label字符串,必填(在指定显示字段时,field_label 或 data_type 必须至少指定一个)
表示该字段的显示名称。
- data_typestring, mandatory (either data_type or field_label is mandatory when you specify the display field)
Represents the data type of the field.
- auto_numberJSON 对象,必填
包含自动编号字段的详细信息。
- start_number整数,必填
指定自动编号序列的起始数字。最多允许 16 位数字,且仅允许数字字符。请确保键中没有空格。
- prefix字符串,可选
表示要添加到 autonumber 字段值的前缀值。最多允许 50 个字符,且仅允许字母数字字符。
- suffix字符串,可选
表示要添加到 autonumber 字段值的后缀值。最多允许 50 个字符,且仅允许字母数字字符。
注意
- 您可以通过一次 API 调用创建一个自定义模块。
- 您可以使用POST 自定义字段 API在自定义模块中创建自定义字段。
- 创建一个模块会消耗500 点数。
- 您无法使用创建自定义模块 API 创建子表单模块或关联模块(MxN)。
用于创建模块的示例输入,其中显示标签的数据类型为 "text"。
Copied{
"modules": [
{
"plural_label": "Zylkers",
"singular_label": "Zylker",
"profiles": [
{
"id": "2423488000000015972"
}
],
"display_field": {
"field_label": "Zylker",
"data_type": "text"
}
}
]
}用于创建一个模块的示例输入,其显示标签的数据类型为“autonumber”
Copied{
"modules": [
{
"plural_label": "Stocks",
"singular_label": "Stock",
"profiles": [
{
"id": "2423488000000015972"
}
],
"api_name": "stock",
"display_field": {
"field_label": "My name field label",
"data_type": "autonumber",
"auto_number": {
"prefix": "ZOHOCRM",
"start_number": "1003",
"suffix": "BRANCH"
}
}
}
]
}可能的错误
- 无效数据HTTP 400
- 提供的 API 名称似乎无效
解决方案:请指定一个有效的 API 名称。 - 请求正文中提供的字段的数据类型无效
解决方案:请为该字段指定有效的数据类型。可用的数据类型为 "autonumber" 或 "text"。 - 在 plural_label 或 singular_label 中提供的字符数超出了允许的限制。
解决方案:singular_label 和 plural_label 键每个最多允许 25 个字符。 - 无效的配置文件 ID
解决方案:请指定有效的配置文件 ID。 - 在 singular_label 或 plural_label 中发现特殊字符
解决方案: 特殊字符不允许在模块的 singular_label 和 plural_label 键中出现。请指定有效值。 - 系统定义的关键字在 plural_label 或 singular_label 中均不受支持
解决方案:为模块指定一个有效的名称。
系统定义的关键字包括 CustomTab, CustomModule, Fileupload, Imageupload, General, Approvals, SalesInbox, Unsubscribe, CheckLists, Blueprints, ConsentForm, Datarequest, Organization, ZSURVEY, Role, Roles, Profile, Profiles, Report Folders, Report Folder, Blueprint Transitions, Blueprint States, Blueprint Logs, Blueprint Transition Logs, Blueprint State Logs Forecast Quotas, Forecast Items, Fiscal Periods, Forecast Quota, Forecast Item, Fiscal Period, Forecast Types, Forecast Type, Forecast Predictions, Forecast Prediction, Forecast Groups, Forecast Group, Locking Information, and LockingInformation.
- 提供的 API 名称似乎无效
- MANDATORY_NOT_FOUNDHTTP 400
缺少必填字段
解决方案:请指定所有必填字段以创建自定义模块。有关更多详细信息,请参阅本页开头的输入 JSON部分。 - DUPLICATE_DATAHTTP 400
- 已发现 singular_label 或 plural_label 的重复值
解决方案:请指定唯一的值。 - 已发现 api_name 的重复值
解决方案:请指定唯一的 API 名称。
- 已发现 singular_label 或 plural_label 的重复值
- API_NOT_SUPPORTEDHTTP 400
所请求的版本不支持该 API
解决方案: 该 API 在版本 6及以上受支持。请尝试使用受支持的版本。 - MINIMUM_DATA_NOT_FOUNDHTTP 400
至少需要一个配置文件
解决方法:为已创建的模块分配至少一个配置文件。profile key不应为空或为 null。 - NOT_SUPPORTEDHTTP 400
当前版本不支持创建模块
解决方案: 若要创建自定义模块,请升级到 企业版或更高版本。 - LIMIT_EXCEEDEDHTTP 400
当前 Edition 的模块创建数已达到上限
解决方案:升级到更高的 Edition 以创建更多自定义模块。请参阅 Zoho CRM Editions 的功能对比以了解更多信息。 - EXPECTED_FIELD_MISSINGHTTP 400
缺少一个或多个预期字段。
解决方案:如果在请求正文中指定了 display_field,则至少指定以下键中的任意一个:field_label 或 data_type。 - DEPENDENT_FIELD_MISSINGHTTP 400
对于你在请求正文中指定的字段,缺少一个或多个依赖键
解决方案:有关更多详细信息,请参阅本页开头的输入 JSON部分。 - Authentication_失败HTTP 401
Authentication失败
解决方案:在 API 调用的请求头中传递访问令牌。 - OAUTH_SCOPE_MISMATCHHTTP 401
未授权
解决方法: 客户端没有创建自定义模块所需的有效作用域。请创建一个具有所需作用域的新令牌。请参阅作用域部分。 - RESERVED_KEYWORD_NOT_ALLOWEDHTTP 403
已为 api_name 键提供了系统定义的关键字
解决方案:您指定了一个系统定义的关键字。请为 API 名称指定一个有效的名称。系统定义的关键字包括 settings, signals, Last_Follow_Up_By, Number_Of_Followups, Last_Follow_Up_Time, First_Follow_Up_By, First_Follow_Up_Time, Notes, nearby_distance__s, Quoted_Items, Discount_Percentage__s, Discount_Type__s, ChronologicalView, nearby_distance__s, Ordered_Items, Discount_Percentage__s, ShiftHours, nearby_distance__s, Converted_Account, Converted_Contact, Converted_Deal, Converted_Potential, ChronologicalView, nearby_distance__s, Mailchimp, nearby_distance__s, Status, ChronologicalView. - NO_PERMISSIONHTTP 403
没有权限创建自定义模块
解决方案:请联系管理员。 - INVALID_URL_PATTERNHTTP 404
请检查您尝试访问的 URL 是否正确
解决方案: 指定的请求 URL 不正确。请指定有效的请求 URL。请参阅请求 URL部分。
示例响应
Copied{
"modules": [
{
"code": "SUCCESS",
"details": {
"id": "2423488000000834002"
},
"message": "module created successfully",
"status": "success"
}
]
}