CRM 帮助

CRM updateRecords 方法

目的

您可以使用updateRecords方法在 Zoho CRM 中进行更新或修改记录。

重要注意事项: 使用POST方法取代GET 方法通过这些参数。

请求 URL

XML 格式

如需在单次 API 调用中将单条记录更新至模块中:

https://crm.zoho.com.cn/crm/private/xml/Leads/updateRecords?authtoken=Auth  Token&scope=crmapi&id=Record ID&xmlData=XML Data

如需在单次 API 调用中将多条记录更新至模块中:

https://crm.zoho.com.cn/crm/private/xml/Leads/updateRecords?authtoken=Auth  Token&scope=crmapi&version=4&xmlData=XML Data

点击多条记录更新,查看示例 xmlData 和多条记录重复检查的响应。

请求参数

参数 数据类型 说明
authtoken* 字符串 验证您的 Zoho 凭据的加密字母数字字符串。
scope* 字符串 将数值指定为 crmapi
id* 字符串 指定记录的唯一 ID
xmlData* XML 指定字段和对应数值
wfTrigger 布尔 将值设定为,在将记录更新至 CRM 账户时触发工作流规则。 默认情况下,此参数为
newFormat 整数值(1 或 2) newFormat=1: 更新来自您的 CRM 账户的数据时排除有 "null" 值的字段。
newFormat=2: 更新来自您的 CRM 账户的数据时将有 "null" 值的字段包括在内。
版本 整数值 version = 1: (默认值)这将基于之前的 API 执行即在进行强化之前获取响应。
version = 2: 这将基于上一次 API 执行获取响应。
version = 4: 在单次 API 方法调用中更新多条记录。

* - 必填参数

注意:

  • 参考发布说明页面了解关于 API 执行中进行的强化的更多信息。

其它说明

  • 在您的 Zoho CRM 账户中更新数据时,基于角色的安全(角色、概要文件、字段级别的安全和数据共享规则)应用。 因此,使用有最高级别角色(例如: CEO 和概要文件(例如: 管理员)的用户 ID。 另外确保所有字段在字段级别安全设置中启用。 关于基于角色的安全设置,请在生成 API 票据时参阅安全管理
  • 更新数据时,确保日期时间分别采用月/日/年年-月-日 小时:分钟:秒的格式

更新记录所有者

通过 API 更新记录时,确保您指定记录所有者的电子邮箱地址或 userID。 如果您使用记录所有者的姓名,记录将分配给验证令牌中使用的默认登录凭证。 如果您希望使用 userID 指定记录所有者,则添加 <FL val="SMOWNERID">userID</FL> 标签至您的 xmlData 中。

示例

如需在 Zoho CRM 中更新记录,请执行以下步骤:

  1. URL 应给出如下:
    https://crm.zoho.com.cn/crm/private/xml/Leads/updateRecords
  2. 参数应给出如下:
    • authtoken:Auth Token
    • scope:将值指定为crmapi
    • xmlData 这是 XML 字符串,格式应与您获取 API 期间获得 XML 格式的记录之方式相同。
    • id:须更新的记录 id

XML 数据格式
https://crm.zoho.com.cn/crm/private/xml/Leads/updateRecords?newFormat=1&authtoken=Auth Token&scope=crmapi&xmlData=XMLDATA

  • authtoken=xy4gr1554712345fg
  • scope=crmapi
  • xmlData= 如下文所提
  • id = 1000000019001

<Leads>
<row no="1">
<FL val="Lead Source">Web Download</FL>
<FL val="First Name">contacto 1</FL>
<FL val="Last Name">apellido</FL>
<FL val="Email">testing@testing.com</FL>
<FL val="Title">Manager</FL>
<FL val="Phone">1234567890</FL>
<FL val="Home Phone">0987654321</FL>
<FL val="Other Phone">1212211212</FL>
<FL val="Fax">02927272626</FL>
<FL val="Mobile">292827622</FL>
</row>
</Leads>

有联系人映射的任务

https://crm.zoho.com.cn/crm/private/xml/Tasks/updateRecords?authtoken=AuthToken&scope=crmapi
&newFormat=1
&id=2000000017022
&xmlData=

<Tasks>
<row no="1">
<FL val="Subject">Meeting Hall</FL>
<FL val="Due Date">2009-04-22</FL>
<FL val="Status">Completed</FL>
<FL val="CONTACTID">2000000017027</FL>
</row>
</Tasks>

活动

https://crm.zoho.com.cn/crm/private/xml/Events/updateRecords?authtoken=AuthToken&scope=crmapi
&newFormat=1
&id=2000000017023
&xmlData=

<Events>
<row no="1">
<FL val="Subject">Conference</FL>
<FL val="Start DateTime">2009-08-04 01:00:00</FL>
<FL val="End DateTime">2009-08-05 01:00:00</FL>
<FL val="Venue">Plaza</FL>
<FL val="Send Notification Email">false</FL>
</row>
</Events>

联系人

https://crm.zoho.com.cn/crm/private/xml/Contacts/updateRecords?authtoken=AuthToken&scope=crmapi
&newFormat=1
&id=2000000017024
&xmlData=

<Contacts>
<row no="1">
<FL val="First Name">Scott</FL>
<FL val="Last Name">James</FL>
<FL val="Email">test@test.com</FL>
<FL val="Department">CG</FL>
<FL val="Phone">989898988</FL>
<FL val="Fax">99999999</FL>
<FL val="Mobile">99989989</FL>
<FL val="Assistant">John</FL>
</row>
</Contacts>

报价

注意:

  • "Product Id" 的值为必填。
  • 如果您没有有效的产品 ID,您可以指定产品名称。

https://crm.zoho.com.cn/crm/private/xml/Quotes/updateRecords?authtoken=Auth Token&scope=crmapi
&newFormat=1
&id=2000000017025
&xmlData=<Quotes>

<row no="1">
<FL val="Subject">Zillium - SO</FL>
<FL val="Due Date">2009-03-10</FL>
<FL val="Sub Total">48000.0</FL>
<FL val="Tax">0.0</FL>
<FL val="Adjustment">0.0</FL>
<FL val="Grand Total">48000.0</FL>
<FL val="Billing Street">test</FL>
<FL val="Shipping Street">test</FL>
<FL val="Billing City">test</FL>
<FL val="Shipping City">test</FL>
<FL val="Billing State">test</FL>
<FL val="Shipping State">test</FL>
<FL val="Billing Code">223</FL>
<FL val="Shipping Code">223</FL>
<FL val="Billing Country">test</FL>
<FL val="Shipping Country">test</FL>
<FL val="Product Details">
<product no="1">
<FL val="Product Id">2000000017001</FL>
<FL val="Unit Price">10.0</FL>
<FL val="Quantity">1.0</FL>
<FL val="Total">123.0</FL>
<FL val="Discount">1.23</FL>
<FL val="Total After Discount">121.77</FL>
<FL val="List Price">123.0</FL>
<FL val="Net Total">121.77</FL>
</product>
</FL>
<FL val="Terms and Conditions">Test by Zoho</FL>
<FL val="Description">Test By Zoho</FL>
</row>
</Quotes>

销售订单

注意:

  • "Product Id" 的值为必填。
  • 如果您没有有效的产品 ID,您可以指定产品名称。

https://crm.zoho.com.cn/crm/private/xml/SalesOrders/updateRecords?authtoken=Auth Token&scope=crmapi
&newFormat=1
&id=2000000017026
&xmlData=<SalesOrders>

<row no="1">
<FL val="Subject">Zillium - SO</FL>
<FL val="Due Date">2009-03-10</FL>
<FL val="Sub Total">48000.0</FL>
<FL val="Tax">0.0</FL>
<FL val="Adjustment">0.0</FL>
<FL val="Grand Total">48000.0</FL>
<FL val="Billing Street">test</FL>
<FL val="Shipping Street">test</FL>
<FL val="Billing City">test</FL>
<FL val="Shipping City">test</FL>
<FL val="Billing State">test</FL>
<FL val="Shipping State">test</FL>
<FL val="Billing Code">223</FL>
<FL val="Shipping Code">223</FL>
<FL val="Billing Country">test</FL>
<FL val="Shipping Country">test</FL>
<FL val="Product Details">
<product no="1">
<FL val="Product Id">2000000017001</FL>
<FL val="Unit Price">10.0</FL>
<FL val="Quantity">1.0</FL>
<FL val="Total">123.0</FL>
<FL val="Discount">1.23</FL>
<FL val="Total After Discount">121.77</FL>
<FL val="List Price">123.0</FL>
<FL val="Net Total">121.77</FL>
</product>
</FL>
<FL val="Terms and Conditions">Test by Zoho</FL>
<FL val="Description">Test By Zoho</FL>
</row>
</SalesOrders>

产品

https://crm.zoho.com.cn/crm/private/xml/Products/updateRecords?authtoken=491e5e3374b0132324lqs2f1scb18cd0&
newFormat=1&scope=crmapi&id=508020000000366001&xmlData=

<Products>
<row no="1">
<FL val="Product Owner">manishp@zillum.com</FL>
<FL val="Product Name">Product Test</FL>
<FL val="Product Code">098732</FL>
<FL val="VENDORID">508020000000038476</FL>
<FL val="Product Active">true</FL>
<FL val="Manufacturer">AltvetPet Inc.</FL>
<FL val="Product Category">CRM App</FL>
<FL val="Sales Start Date">11/09/2012</FL>
<FL val="Sales End Date">11/11/2012</FL>
<FL val="Support Start Date">11/16/2012</FL>
<FL val="Support Expiry Date">11/18/2012</FL>
<FL val="Amount">100</FL>
<FL val="Probability">2</FL>
<FL val="Expected Revenue">200</FL>
<FL val="Unit Price">200</FL>
<FL val="Commission Rate">2</FL>
<FL val="Tax">Sales Tax;asdf</FL>
<FL val="Taxable">true</FL>
<FL val="Usage Unit">Dozen</FL>
<FL val="Qty Ordered">500000</FL>
<FL val="Qty in Stock">200000</FL>
<FL val="Reorder Level">10000</FL>
<FL val="Qty in Demand">10</FL>
<FL val="Handler">508020000000210005</FL>
<FL val="Description">Description Added for the product</FL>
</row>
</Products>

注意:

  • 处理人员的值应为 SMOWNERID。

测试程序

您可以使用所附程序运行并测试在您的 Java 环境中 updateRecords 方法的工作效果。
Java 程序包含以下内容:

  • 令牌生成格式
  • 参数及其数值
  • 方法的实际使用

点击此处下载程序。

使用 'CDATA'

目的: 考虑将特殊字符作为普通文本,而非 XML 数据

URL 格式:
https://crm.zoho.com.cn/crm/private/xml/Contacts/updateRecords?newFormat=1&authtoken=Auth Token&scope=crmapi&id=50000000216189251

样本 XML 数据:

作为 POST:

<Contacts>
<row no="1">
<FL val="First Name">Amy</FL>
<FL val="Last Name">Dawson</FL>
<FL val="Email">testing@testing.com</FL>
<FL val="Title">Manager</FL>
<FL val="Phone">1234567890</FL>
<FL val="Mobile">292827622</FL>
<FL val="Account Name"> <![CDATA["A & A"]]> </FL>
</row>
</Contacts>

作为 GET:

<Contacts>
<row no="1">
<FL val="First Name">Amy</FL>
<FL val="Last Name">Dawson</FL>
<FL val="Email">testing@testing.com</FL>
<FL val="Title">Manager</FL>
<FL val="Phone">1234567890</FL>
<FL val="Mobile">292827622</FL>
<FL val="Account Name"> <![CDATA["A %26 A"]]> </FL>
</row>
</Contacts>

注意:

  • "%26" 不会被视为 "&"

多条记录更新

目的

您可以使用updateRecords在单个 updateRecords API 方法中更新多条记录。 请注意,version=4 为必填参数。

我们引入了新代码,代表各条记录的 API 结果状态。 代码给出如下:

2001 = 记录更新成功

URL 格式:

https://crm.zoho.com.cn/crm/private/xml/Leads/updateRecords?authtoken=Auth  Token&scope=crmapi&version=4&xmlData=

样本 XML 数据

<Leads>
<row no="1">
<FL val="Id">2000000178701</FL>
<FL val="Company">Company1</FL>
<FL val="Last Name">Last Name1</FL>
<FL val="Email">automation@crm.com 1</FL>
</row>
<row no="2">
<FL val="Id">2000000178702</FL>
<FL val="Company">Company2</FL>
<FL val="Last Name">Last Name2</FL>
<FL val="Email">automation@crm.com 2</FL>
</row>
</Leads>

样本响应

功能和响应将如下所示,

<response uri="/crm/private/xml/Leads/insertRecords">
<result>
<row no="1">
<success>
<code>2001</code>
<details>
<FL val="Id">2000000178701</FL>
<FL val="Created Time">2013-02-11 17:55:04</FL>
<FL val="Modified Time">2013-02-11 17:55:04</FL>
<FL val="Created By">
<![CDATA[ aghil123 ]]>
</FL>
<FL val="Modified By">
<![CDATA[ aghil123 ]]>
</FL>
</details>
</success>
</row>
<row no="2">
<success>
<code>2001</code>
<details>
<FL val="Id">2000000178702</FL>
<FL val="Created Time">2013-02-11 17:55:04</FL>
<FL val="Modified Time">2013-02-11 17:55:04</FL>
<FL val="Created By">
<![CDATA[ aghil123 ]]>
</FL>
<FL val="Modified By">
<![CDATA[ aghil123 ]]>
</FL>
</details>
</success>
</row>
</result>
</response>

如果 version=4,有些记录包含错误,有些记录则没有,功能和响应给出如下:

<response uri="/crm/private/xml/Leads/insertRecords">
<result>
<row no="1">
<success>
<code>2001</code>
<details>
<FL val="Id">2000000178701</FL>
<FL val="Created Time">2013-02-11 17:55:04</FL>
<FL val="Modified Time">2013-02-11 17:55:04</FL>
<FL val="Created By">
<![CDATA[ aghil123 ]]>
</FL>
<FL val="Modified By">
<![CDATA[ aghil123 ]]>
</FL>
</details>
</success>
</row>
<row no="2">
<error>
<code>4832</code>
<details>You have given a wrong value for the field : Annual Revenue</details>
</error>
</row>
</result>
</response>

注意:

  • 如果您使用 version=4,那么您必须在 xmlData 中提供 Id。
  • 开发者现在可以轻松识别记录 id,因为响应中的记录详细信息是以用户在 xml 数据中请求的同样方式给出。
  • 如果您不通过这一版本,默认功能将被执行。
  • 您在单次 API 调用中最多更新 100 条记录。

依然找不到您想要的内容?

请给我们写邮件:support-crm@zohocorp.com.cn