向记录添加标签
目的
向记录添加标签。
端点
- POST /{module_API_name}/actions/add_tags
- POST /{module_API_name}/{record_ID}/actions/add_tags
Request 详情
Request URL
向多个记录添加多个标签:
{api-domain}/crm/{version}/{module_API_name}/actions/add_tags
给特定记录添加标签:
{api-domain}/crm/{version}/{module_API_name}/{record_ID}/actions/add_tags
支持的模块
潜在客户,账户,联系人,交易,活动,任务,案例,事件,呼叫,解决方案,产品,供应商,价格书,报价,销售订单,采购订单,发票,以及自定义模块。
标题
授权:Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
范围
ZohoCRM.modules.ALL
(或者)
ZohoCRM.modules.{模块名称}.{操作类型}
可能的模块名称
潜在客户,账户,联系人,交易,活动,任务,案例,事件,电话,解决方案,产品,供应商,价格表,报价,销售订单,采购订单,发票,以及自定义模块。
可能的操作类型
ALL - 对记录的完全访问
WRITE - 编辑模块中的记录
CREATE - 在模块中创建记录
输入 JSON
- tagsJSON 对象,必填
您想要添加到记录的标签的“名称”,“id”和“颜色代码”。请参考GET标签列表API以获取可用的标签及其各自的颜色代码。请注意,标签的ID优先于名称。
- over_write布尔值,可选
指定是否要覆盖现有的标签。默认值为false。
- idsJSON 数组,当向多个记录添加标签时必填
指定记录的唯一ID。您可以指定最多500个记录ID。使用 GET - 记录API检索记录ID。
示例输入以向多个记录添加多个标签
可能的错误
- INVALID_REQUEST_METHODHTTP 400
HTTP请求方法类型无效
解决方案:您指定了无效的HTTP方法来访问API URL。请指定一个有效的请求方法。请参考端点部分。 - AUTHORIZATION_FAILEDHTTP 400
用户没有足够的权限添加标签
解决方案:用户没有权限向记录添加标签。请联系您的系统管理员。 - INVALID_MODULEHTTP 400
给出的模块名称似乎无效
解决方案:您指定的模块名称无效,或者没有标签权限,或者该模块可能已从可用模块中删除。请指定一个有效的模块API名称。 - INVALID_MODULEHTTP 400
给定的模块在API中不受支持
解决方案:当前API不支持诸如文档和项目等模块。(一旦这些模块得到支持,此错误将不会显示)。请指定一个有效的模块API名称。使用模块API 获取模块API名称。 - PATTERN_NOT_MATCHEDHTTP 400
请检查输入值是否正确
解决方案:输入键中指定的值错误。请参考Request JSON部分并指定有效值。 - RECORD_LOCKEDHTTP 400
您无法执行此操作,因为记录已被锁定。
解决方案:请等待记录解锁。 - OAUTH_SCOPE_MISMATCHHTTP 401
未经授权
解决方案:客户端没有ZohoCRM.modules.{module_name}.WRITE范围。创建一个具有有效范围的新客户端。请参阅范围部分。 - NO_PERMISSIONHTTP 403
拒绝权限更新记录
解决方案:用户没有权限向记录添加标签。请联系您的系统管理员。 - INVALID_URL_PATTERNHTTP 404
请检查试图访问的URL是否正确
解决方案:指定的RequestURL不正确。请指定一个有效的RequestURL。请参考RequestURL部分。 - INTERNAL_ERRORHTTP 500
内部服务器错误
解决方案:服务器中出现意外且未处理的异常。请联系支持团队。