删除自定义字段
目的
要从您的 Zoho CRM 账户的某个模块中删除自定义字段。
端点
- DELETE /settings/fields/{field_ID}?module={module_API_name}
请求详情
请求 URL
{api-domain}/crm/{version}/settings/fields/{field_ID}
标题
授权: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
范围
ZohoCRM.settings.fields.DELETE (或)
ZohoCRM.settings.fields.ALL (或)
ZohoCRM.settings.ALL
支持的模块
潜在客户, 联系人, Account, 市场活动, 案例, Invoices, 商机, 价格表, 产品, Purchase Orders, 报价单, Sales Orders, 解决方案, Vendors, 电话, 任务, 事件, Users, 商机历史, 报价的Items, Order的Items, 采购的Items, Invoice的Items, 拜访, 服务, 预约, 以及自定义。
参数
- module string,必填
指定要从中删除自定义字段的模块,例如潜在客户或联系人。使用 GET - 模块 API 来获取模块的 API 名称和 ID。
注意
- 您可以删除自定义字段,但不能删除系统定义的字段。
- 每次 API 调用只能删除一个自定义字段。
- 使用 GET - 字段元数据 API 获取字段 ID。
示例请求
Copiedcurl "https://www.zohoapis.com/crm/v8/settings/fields/111116000000063101?module=Leads"
-X DELETE
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf" 可能的错误
- INVALID_DATAHTTP 400
提供的 ID 似乎无效
解决方案:请指定有效的字段 ID。 - NOT_ALLOWEDHTTP 400
- 该自定义字段已在其他地方使用
- 只能删除自定义字段
解决方案:
- 无法删除已在其他地方使用的自定义字段,例如工作流、评分规则、审批流程、审核流程等。
- 无法删除系统定义的字段。请仅指定有效的自定义字段。
- REQUIRED_PARAM_MISSINGHTTP 400
缺少必需的 paRAMeter
解决方案:请指定 模块 paRAMeter 及其对应的值。 - INVALID_DATAHTTP 400
该 job_id 无效。
解决方法:请指定有效的作业 ID。 - INVALID_REQUEST_METHODHTTP 400
HTTP 请求方法类型无效
解决方案:您为访问 API URL 指定了无效的 HTTP 方法。请指定有效的请求方法。请参阅端点部分。 - OAUTH_SCOPE_MISMATCHHTTP 401
未授权
解决方案: 客户端没有用于删除自定义字段的有效作用域。请创建具有有效作用域的新令牌。请参阅作用域部分。 - Authentication_失败HTTP 401
Authentication 失败
解决方案: 在 API 调用的请求头中传递访问令牌。 - 无效_URL_模式HTTP 404
请检查您尝试访问的URL是否正确
解决方案:所指定的请求URL不正确。请指定有效的请求URL。请参阅请求URL部分。 - INTERNAL_ERRORHTTP 500
内部服务器错误
解决方法: 服务器中出现了意外且未处理的异常。请联系支持团队。
示例响应
Copied{
"fields": [
{
"code": "SUCCESS",
"details": {
"id": "111116000000063101"
},
"message": "字段已删除",
"status": "成功"
}
]
}