Zoho crm Logo

使用外部 ID 更新相关记录

目的

使用外部 ID 更新相关列表记录。

端点

  • PUT /{module_API_name}/{external_field_API_name/value}/{related_list_API_name}

请求详情

请求 URL

{api-domain}/crm/{version}/{module_API_name}/{external_field_API_name/value}/{related_list_API_name}

标题

授权:Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

X-外部:{module_API_name}.{external_field_API_name}

范围

ZohoCRM.modules.all
(或)
scope=ZohoCRM.modules.{module_name}.{operation_type}

可能的模块名称

线索、交易、联系人、账户、产品、活动、预约、服务和价目表

可能的操作类型

全部 - 完全访问相关记录
写入 - Edit相关记录
Update - Update模块中的相关记录

使用外部 ID 关联联系人和交易
  • 在此示例中,extcontact3 和 extdeal3 分别是联系人模块中的外部字段 External_Contact_ID 和交易模块中的 External_Deal_ID 的值。我们将引用这些值来将联系人与交易进行关联。

示例请求

Copiedcurl "https://www.zohoapis.com/crm/v8/Contacts/extcontact3/Deals"
-X PUT
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
-H "X-EXTERNAL: Contacts.External_Contact_ID,Deals.External_Deal_ID"
-d "@sample.json"

示例输入

Copied{
    "data": [
        {
            "External_Deal_ID": "extdeal3",
            "Contact_Role": "111111000000026002"
        }
    ]
}

示例回复

Copied{
    "data": [
        {
            "code": "SUCCESS",
            "details": {
                "External_Deal_ID": "extdeal3",
                "id": "111111000000094028"
            },
            "message": "relation added",
            "status": "success"
        }
    ]
}

可能的错误

  • INVALID_DATAHTTP 400

    外部字段的 ID 无效。
    解决方法:请指定正确的外部 ID。

  • INVALID_DATAHTTP 400

    您为基础模块指定了无效的外部ID。
    解决方法:请指定正确的外部ID。

  • MANDATORY_NOT_FOUNDHTTP 400

    您已在相关模块的请求头中指定了外部ID,但未在请求体中指定。
    解决方法:当您在请求头中指定外部字段时,必须在请求体中包含该外部字段。

  • INVALID_REQUEST_METHODHTTP 400

    请求方法不正确。
    解决方法:请使用 HTTP GET 方法调用此 API。使用其他请求方法将导致此错误。

  • AUTHORIZATION_FAILEDHTTP 400

    您没有足够的权限获取相关记录。
    解决方法:请联系您的系统管理员。

  • OAUTH_SCOPE_MISMATCHHTTP 401

    您用于进行此 API 调用的访问令牌不具有所需的权限范围。
    解决方法: 生成一个包含权限范围部分所述范围的新访问令牌。

  • NO_PERMISSIONHTTP 403

    您没有权限获取相关记录的数据。
    解决方法:请联系您的系统管理员。

  • INVALID_URL_PATTERNHTTP 404

    请求的URL不正确。
    解决方法:请指定有效的请求URL。请参阅请求URL部分以获得正确的URL。

  • INTERNAL_ERRORHTTP 500

    服务器发生了意外且未处理的异常。 
    解决方法:请联系支持团队,邮箱为 support@zohocrm.com。

示例请求

Copiedcurl "https://www.zohoapis.com/crm/v8/Contacts/111111000000085009/Deals"
-X PUT
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
-H "X-EXTERNAL: Deals.External_Deal_ID"
-d "@sample.json"

示例输入

Copied{
    "data": [
        {
            "Contact_Role": "111111000000026002",
            "External_Deal_ID": "extdeal3"
        }
    ]
}

示例回复

Copied{
    "data": [
        {
            "code": "SUCCESS",
            "details": {
                "External_Deal_ID": "extdeal3",
                "id": "111111000000094028"
            },
            "message": "relation added",
            "status": "success"
        }
    ]
}