updateRecordsメソッド
目次
目的
updateRecordsメソッドを使用すると、Zoho CRMのデータを更新または変更できます。
重要：以下のパラメーターを渡すには、GETメソッドではなくPOSTメソッドを使用してください。
リクエストURL
XML形式
単一のAPI呼び出しでタブの単一データを更新する：
https://crm.zoho.com/crm/private/xml/Leads/updateRecords?authtoken=AuthToken&scope=crmapi&id=Record ID&xmlData=XML Data
単一のAPI呼び出しでタブの複数データを更新する：
https://crm.zoho.com/crm/private/xml/Leads/updateRecords?authtoken=AuthToken&scope=crmapi&version=4&xmlData=XML Data
複数データ重複チェックのxmlDataとレスポンスの例を確認するには、複数データの更新をクリックしてください。
リクエストパラメーター
| パラメーター | データ型 | 説明 |
| authtoken* | 文字列 | Zoho認証情報の認証に使用する、暗号化された英数字文字列。 |
| scope* | 文字列 | 値をcrmapiと指定してください。 |
| id* | 文字列 | データの一意のIDを指定してください。 |
| xmlData* | XML | 項目と対応する値を指定してください。 |
| wfTrigger | 真偽値 | 値をtrueに設定すると、CRMアカウントのデータを更新する際にワークフローが実行されます。デフォルトでは、このパラメーターはfalseです。 |
| newFormat | 整数（1または2） | newFormat=1：値が「null」の項目を除外して、CRMアカウントのデータを更新します。 newFormat=2：値が「null」の項目を含めて、CRMアカウントのデータを更新します。 |
| version | 整数 | version = 1：（デフォルト値）強化前の古いAPI実装に基づいてレスポンスを取得します。 version = 2：最新のAPI実装に基づいてレスポンスを取得します。 version = 4：単一のAPIメソッド呼び出しで複数データを更新します。 |
* - 必須パラメーター
注：
- API実装で行われた強化の詳細については、リリースノートページを参照してください。
その他の注意事項
- Zoho CRMアカウントのデータを更新する際には、役割ベースのセキュリティ（役割、権限、項目単位のセキュリティとデータ共有ルール）が適用されます。そのため、最上位の役職（CEOなど）と権限（管理者など）を持つユーザーIDを使用してください。また、項目単位のセキュリティ設定で全項目が有効になっていることも確認してください。役割ベースのセキュリティ設定については、API問い合わせ作成時のセキュリティ管理を参照してください。
- データを更新する際は、日付と時刻がそれぞれMM/dd/yyyy形式とyyyy-MM-dd HH:mm:ss形式であることを確認してください。
データの担当者の更新
APIを使用してデータを更新する際は、データ担当者のメールアドレスまたはユーザーIDを指定していることを確認してください。データ担当者の名前を使用すると、認証トークンで使われているデフォルトのサインイン認証情報にデータが割り当てられます。userIDを使用してデータ担当者を指定する場合は、xmlDataに<FL val="SMOWNERID">userID</FL>タグを追加してください。
例
Zoho CRMのデータを更新するには、次の手順に従います。
- URLは次のように指定する必要があります。
https://crm.zoho.com/crm/private/xml/Leads/updateRecords - パラメーターは次のように指定する必要があります。
- authtoken：Auth Token
- scope：値をcrmapiとして指定してください。
- xmlData：これはXML文字列です。取得APIでのXML形式データの取得方法と同じ形式にする必要があります。
- id：更新するデータのidです。
XMLデータ形式：
https://crm.zoho.com/crm/private/xml/Leads/updateRecords?newFormat=1&authtoken=Auth Token&scope=crmapi&xmlData=XMLDATA
- authtoken=xy4gr1554712345fg
- scope=crmapi
- xmlData= as mentioned below
- 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/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/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/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/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/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/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>
注：
- Handlerの値はSMOWNERIDである必要があります。
テストプログラム
添付のプログラムを使用すると、Java環境でupdateRecordsメソッドの動作を実行、テストできます。
このJavaプログラムには、以下が含まれています。
- トークン作成形式
- パラメーターとその値
- メソッドの実際の使用
プログラムをダウンロードするには、こちらをクリックしてください。
「CDATA」の使用
目的：特殊文字をXMLデータではなくプレーンテキストと見なす
URL形式：
https://crm.zoho.com/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/crm/private/xml/Leads/updateRecords?authtoken=AuthToken&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を指定する必要があります。
- xmlデータでユーザーがリクエストしたのと同じ形式でレスポンスのデータ詳細が表示されるようになったため、データIDを識別しやすくなりました。
- バージョンを渡さない場合、デフォルトの機能が実行されます。
- 1回のAPI呼び出しで最大100データを更新できます。