insertRecordsメソッド

目的

insertRecordsメソッドを使用すると、必要なZoho CRMタブにデータを挿入できます。

重要：以下のパラメーターを渡すには、GETメソッドではなくPOSTメソッドを使用してください。

リクエストURL

XML形式：

https://crm.zoho.com/crm/private/xml/Leads/insertRecords?authtoken=AuthToken&scope=crmapi&xmlData=Your XML Data

リクエストパラメーター

パラメーター	データ型	説明
authtoken*	文字列	Zoho認証情報の認証に使用する、暗号化された英数字文字列。
scope*	文字列	crmapiと範囲を指定してください。
xmlData*	XML	これはXML文字列です。getRecordsで取得したXML形式のデータと同じ形式にする必要があります。
wfTrigger	真偽値	値をtrueに設定すると、CRMアカウントにデータを挿入する際にワークフローが実行されます。デフォルトでは、このパラメーターはfalseです。
duplicateCheck	整数	値を「1」に設定すると、重複データがチェックされてエラーレスポンスがスローされます。値を「2」に設定すると、重複データがチェックされ、重複がある場合は同じデータが更新されます。
isApproval	真偽値	デフォルトでは、データは直接挿入されます。データを承認モードのままにしておくには、値をtrueに設定してください。このパラメーターは、［見込み客］、［連絡先］、［問い合わせ］タブに使用できます。
newFormat	整数	newFormat=1：値が「null」の項目を除外して、CRMアカウントにデータを挿入します。 newFormat=2：値が「null」の項目を含めて、CRMアカウントにデータを挿入します。
version	整数	version = 1：（デフォルト値）強化前の古いAPI実装に基づいてレスポンスを取得します。 version = 2：最新のAPI実装に基づいてレスポンスを取得します。 version = 4：複数のデータに対して重複チェック機能をトリガーしてください。

* - 必須パラメーター

注：

API実装で行われた強化の詳細については、リリースノートページを参照してください。

重複チェック項目

タブ名	重複チェック項目
見込み客	メール
連絡先	メール
取引先	取引先名
商談	商談名
キャンペーン	キャンペーン名
問い合わせ	件名
商品	商品名
仕入先	仕入先名
見積書	件名
受注書	件名
発注書	件名
請求書	件名
カスタムタブ	カスタムタブ名

その他の注意事項

Zoho CRMアカウントにデータを挿入する際には、役割ベースのセキュリティ（役割、権限、項目単位のセキュリティとデータ共有ルール）が適用されます。そのため、最も高い役割（CEOなど）と権限（管理者など）を持つユーザーIDを使用してください。また、項目単位のセキュリティ設定で全項目が有効になっていることも確認してください。役割ベースのセキュリティ設定については、認証トークン作成時のセキュリティ管理を参照してください。
データを挿入する際は、日付と時刻がそれぞれMM/dd/yyyy形式とyyyy-MM-dd HH:mm:ss形式であることを確認してください。

例

外部サービスアプリケーションからZoho CRMにデータを挿入する

URL形式：
https://crm.zoho.com/crm/private/xml/Leads/insertRecords?newFormat=1&authtoken=Auth Token&scope=crmapi&xmlData=Your XML Data

リクエスト例：

https://crm.zoho.com/crm/private/xml/Leads/insertRecords?
newFormat=1
&authtoken=Auth Token
&scope=crmapi
&xmlData=

<Leads>
<row no="1">
<FL val="Lead Source">Web Download</FL>
<FL val="Company">Your Company</FL>
<FL val="First Name">Hannah</FL>
<FL val="Last Name">Smith</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>

見込み客のXMLDATA例

<Leads>
<row no="1">
<FL val="SMOWNERID">2000000016714</FL>
<FL val="Lead Owner">Scott@zohotest.com</FL>
<FL val="Company">Zoho</FL>
<FL val="First Name">Peter</FL>
<FL val="Last Name">John</FL>
<FL val="Designation">CEO</FL>
<FL val="Email">john@test.com</FL>
<FL val="Phone">04422334455</FL>
<FL val="Fax">98889</FL>
<FL val="Mobile">09999999999</FL>
<FL val="Website">www.sample.com</FL>
<FL val="Lead Source">External Referral</FL>
<FL val="Lead Status">Contacted</FL>
<FL val="Industry">Financial Services</FL>
<FL val="No of Employees">100</FL>
<FL val="Annual Revenue">100.0</FL>
<FL val="Email Opt Out">true</FL>
<FL val="Skype ID">peter</FL>
<FL val="Salutation">Mr.</FL>
<FL val="Street">Street One</FL>
<FL val="City">Chennai</FL>
<FL val="State">Tamil Nadu</FL>
<FL val="Zip Code">6000001</FL>
<FL val="Country">India</FL>
<FL val="Description">Sample Description.</FL>
</row>
</Leads>

見込み客の検索を使用した、タスクのXMLDATA例

<Tasks>
<row no="1">
<FL val="SMOWNERID">2000000016714</FL>
<FL val="Task Owner">Scott@zohotest.com</FL>
<FL val="Subject">Demo Call</FL>
<FL val="Due Date">11/23/2009</FL>
<FL val="SEID">2000000018003</FL>
<FL val="SEMODULE">Leads</FL>
<FL val="Status">In Progress</FL>
<FL val="Priority">Highest</FL>
<FL val="Send Notification Email">false</FL>
<FL val="Description">Sample Desc</FL>
</row>
</Tasks>

連絡先と取引先の検索を使用した、タスクのXMLDATA例

<Tasks>
<row no="1">
<FL val="SMOWNERID">2000000016714</FL>
<FL val="Task Owner">Scott@zohotest.com</FL>
<FL val="Subject">Demo Call</FL>
<FL val="Due Date">11/23/2009</FL>
<FL val="CONTACTID">2000000018443</FL>
<FL val="SEID">2000022218013</FL>
<FL val="SEMODULE">Accounts</FL>
<FL val="Status">In Progress</FL>
<FL val="Priority">Highest</FL>
<FL val="Send Notification Email">false</FL>
<FL val="Description">Sample Desc</FL>
</row>
</Tasks>

メモを挿入し、メインのタブに関連付ける

XML形式：

https://crm.zoho.com/crm/private/xml/Notes/insertRecords?newFormat=1&authtoken=Auth Token
&scope=crmapi
&xmlData=

<Notes>
<row no="1">
<FL val="entityId">2000000078001</FL>
<FL val="Note Title">Zoho CRM Sample Note</FL>
<FL val="Note Content">This is sample content to test Zoho CRM API</FL>
</row>
</Notes>

上記の例のentityIDは、主要データ（見込み客、アカウント、連絡先など）の一意のIDです。

担当者をデータに割り当てる

APIを使用してデータを挿入する際は、データ担当者のメールアドレスまたはユーザーIDを指定していることを確認してください。データ担当者の名前を使用すると、認証トークンで使われているデフォルトのサインイン認証情報にデータが割り当てられます。userIDを使用してデータ担当者を指定する場合は、xmlDataに<FL val="SMOWNERID">userID</FL>タグを追加してください。

注：

以下の例では、「authotoken」と「scope」の値を、作成した値に置き換えてください。

問い合わせ

https://crm.zoho.com/crm/private/xml/Cases/insertRecords?authtoken=Auth Token&scope=crmapi
&newFormat=1
&xmlData=

<Cases>
<row no="1">
<FL val="Case Origin">Phone</FL>
<FL val="Status">Escalated</FL>
<FL val="Subject">New Case</FL>
<FL val="Account Name">Account for Cases</FL>
<FL val="WHOID">508020014316189251</FL>
</row>
</Cases>

注：

WHOID項目は、［問い合わせ］タブの［関連］項目を参照してください。問い合わせに関連付けるデータのIDを、WHOID項目の［関連］項目値として指定してください。

タスク

https://crm.zoho.com/crm/private/xml/Tasks/insertRecords?authtoken=Auth Token&scope=crmapi
&newFormat=1
&xmlData=

<Tasks>
<row no="1">
<FL val="Subject">Call</FL>
<FL val="Due Date">2009-04-20</FL>
<FL val="Status">Deferred</FL>
<FL val="CONTACTID">2000000017017</FL>
</row>
</Tasks>

予定

https://crm.zoho.com/crm/private/xml/Events/insertRecords?authtoken=Auth Token&scope=crmapi
&newFormat=1
&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">United States</FL>
<FL val="Send Notification Email">True</FL>
</row>
</Events>

連絡先と問い合わせを関連付けた予定

https://crm.zoho.com/crm/private/xml/Events/insertRecords?authtoken=Auth Token&scope=crmapi
&newFormat=1
&xmlData=

<Events>
<row no="1">
<FL val="Subject">Conference</FL>
<FL val="Start DateTime">2009-09-24 01:00:00</FL>
<FL val="End DateTime">2009-09-25 01:00:00</FL>
<FL val="Venue">Chennai</FL>
<FL val="CONTACTID">2000000055003</FL>
<FL val="SEID">2000000055007</FL>
<FL val="SEMODULE">Cases</FL>
</row>
</Events>

アカウント

https://crm.zoho.com/crm/private/xml/Accounts/insertRecords?authtoken=Auth Token&scope=crmapi
&newFormat=1
&xmlData=

<Accounts>
<row no="1">
<FL val="Account Name">Zillum</FL>
<FL val="Website">www.zillum.com</FL>
<FL val="Employees">200</FL>
<FL val="Ownership">Private</FL>
<FL val="Industry">Real estate</FL>
<FL val="Fax">99999999</FL>
<FL val="Annual Revenue">20000000</FL>
</row>
</Accounts>

連絡先

https://crm.zoho.com/crm/private/xml/Contacts/insertRecords?authtoken=Auth Token&scope=crmapi
&newFormat=1
&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">999999999</FL>
<FL val="Fax">99999999</FL>
<FL val="Mobile">99989989</FL>
<FL val="Assistant">John</FL>
</row>
</Contacts>

受注書

注：

「Product Id」の値は必須です。

https://crm.zoho.com/crm/private/xml/SalesOrders/insertRecords?authtoken=Auth Token&scope=crmapi
&newFormat=1
&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>

見積書

注：

「Product Id」の値は必須です。

https://crm.zoho.com/crm/private/xml/Quotes/insertRecords?authtoken=Auth Token&scope=crmapi
&newFormat=1
&xmlData=

<Quotes>
<row no="1">
<FL val="Subject">Zillium - Quote</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>

複数の商品を含む見積書の例：

https://crm.zoho.com/crm/private/xml/Quotes/insertRecords?authtoken=Auth Token&scope=crmapi
&xmlData=

<Quotes>
<row no="1">
<FL val="Subject">TEST</FL>
<FL val="Quote Stage">Draft</FL>
<FL val="Carrier">FedEX</FL>
<FL val="ACCOUNTID">269840000000150037</FL>
<FL val="Account Name">phone account11 9pm</FL>
<FL val="SMOWNERID">269840000000034003</FL>
<FL val="Quote Owner">TEST</FL>
<FL val="SMCREATORID">269840000000034003</FL>
<FL val="Created By">TEST</FL>
<FL val="MODIFIEDBY">269840000000034003</FL>
<FL val="Modified By">TEST</FL>
<FL val="Created Time">2010-10-19 16:16:41</FL>
<FL val="Modified Time">2010-10-19 16:16:56</FL>
<FL val="Sub Total">23.0</FL>
<FL val="Tax">0.0</FL>
<FL val="Adjustment">0.0</FL>
<FL val="Grand Total">23.0</FL>
<FL val="Product Details">
<product no="1">
<FL val="Product Id">269840000000136287</FL>
<FL val="Product Name">prd1</FL>
<FL val="Unit Price">0.0</FL>
<FL val="Quantity">1.0</FL>
<FL val="Quantity in Stock">0.0</FL>
<FL val="Total">23.0</FL>
<FL val="Discount">0.0</FL>
<FL val="Total After Discount">23.0</FL>
<FL val="List Price">23.0</FL>
<FL val="Net Total">23.0</FL>
<FL val="Tax">0.0</FL>
</product>
<product no="2">
<FL val="Product Id">269840000000128149</FL>
<FL val="Product Name">prd2</FL>
<FL val="Unit Price">0.0</FL>
<FL val="Quantity">1.0</FL>
<FL val="Quantity in Stock">0.0</FL>
<FL val="Total">23.0</FL>
<FL val="Discount">0.0</FL>
<FL val="Total After Discount">23.0</FL>
<FL val="List Price">23.0</FL>
<FL val="Net Total">23.0</FL>
<FL val="Tax">0.0</FL>
</product>
</FL>
<FL val="Terms and Conditions">Test by Zoho</FL>
<FL val="Discount">0.0</FL>
<FL val="Date Field">07/21/2010</FL>
</row>
</Quotes>

連絡先と取引先の検索を使用した挿入

<Calls>
<row no="1">
<FL val="SMOWNERID">2000000018005</FL>
<FL val="Subject">Product Support</FL>
<FL val="Call Type">Inbound</FL>
<FL val="Call Purpose">Prospecting</FL>
<FL val="CONTACTID">2000000018001</FL>
<FL val="SEID">2000000018003</FL>
<FL val="SEMODULE">Accounts</FL>
<FL val="Call Start Time">2011-06-10 22:10:00</FL>
<FL val="Call Duration">60:00</FL>
<FL val="Description">Required Product Demo</FL>
<FL val="Billable">true</FL>
<FL val="Call Result">Successful</FL>
</row>
</Calls>

見込み客の検索を使用した挿入

<Calls>
<row no="1">
<FL val="SMOWNERID">2000000018005</FL>
<FL val="Subject">Demo</FL>
<FL val="Call Type">Inbound</FL>
<FL val="Call Purpose">Prospecting</FL>
<FL val="SEID">2000000017201</FL>
<FL val="SEMODULE">Leads</FL>
<FL val="Call Start Time">2011-06-10 22:10:00</FL>
<FL val="Call Duration">60:00</FL>
<FL val="Description">Demo Call</FL>
<FL val="Billable">true</FL>
<FL val="Call Result">Successful</FL>
</row>
</Calls>

「CDATA」の使用

目的：特殊文字をXMLデータではなくプレーンテキストと見なす

URL形式：
https://crm.zoho.com/crm/private/xml/Contacts/insertRecords?newFormat=1&authtoken=Auth Token&scope=crmapi&xmlData= Your XML Data

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時：

注：

「%26」は「&」と見なされます。

複数データの挿入

URL形式： https://crm.zoho.com/crm/private/xml/Leads/insertRecords?newFormat=1&authtoken=Auth Token&scope=crmapi&xmlData= Your XML Data

XMLDATA例：

<Leads>
    <row no="1"><FL val="Last Name">testing</FL><FL val="Company">ZOHO</FL></row>
    <row no="2"><FL val="Last Name">testing</FL><FL val="Company">ZOHO</FL></row>
    <row no="3"><FL val="Last Name">testing</FL><FL val="Company">ZOHO</FL></row>
    <row no="4"><FL val="Last Name">testing</FL><FL val="Company">ZOHO</FL></row>
    <row no="5"><FL val="Last Name">testing</FL><FL val="Company">ZOHO</FL></row>
    <row no="6"><FL val="Last Name">testing</FL><FL val="Company">ZOHO</FL></row>
    <row no="7"><FL val="Last Name">testing</FL><FL val="Company">ZOHO</FL></row>
    <row no="8"><FL val="Last Name">testing</FL><FL val="Company">ZOHO</FL></row>
    <row no="9"><FL val="Last Name">testing</FL><FL val="Company">ZOHO</FL></row>
    <row no="10"><FL val="Last Name">testing</FL><FL val="Company">ZOHO</FL></row>
:
:
:

    <row no="100"><FL val="Last Name">testing</FL><FL val="Company">ZOHO</FL></row>
</Leads>

注：

insertRecordsメソッドを使用して複数のデータを挿入する場合：

重複チェックは機能しません。ただし、バージョン4では複数データの重複チェックをサポートしています。
条件を満たすデータに対し、ワークフローはトリガーされません。
［見積書］、［受注書］、［請求書］、［発注書］の各タブには、複数のデータを挿入できません。
複数のデータを挿入する場合は、最初の100データのみが対象と見なされます。

複数データの重複チェック

目的

insertRecordsを使用すると、複数のデータに対して重複チェック機能をトリガーできます。version=4は必須パラメーターです。

各データのAPI実行結果ステータスを表す、3種類の新しいコードが導入されました。コードは以下のとおりです。

2000 = データが正常に追加されました。
2001 = データが正常に更新されました。
2002 = データは既に存在してください。

URL形式：

https://crm.zoho.com/crm/private/xml/Leads/insertRecords?authtoken=AuthToken&scope=crmapi&duplicateCheck=( 1 OR 2 )&version=4&xmlData= Your XML Data

XMLデータ例

<Leads>
<row no="1">
<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="Company">Company2</FL>
<FL val="Last Name">Last Name2</FL>
<FL val="Email">automation@crm.com 2</FL>
</row>
</Leads>

レスポンス例

duplicateCheck=1、version=4で、メールアドレスを持つデータと持たないデータが存在している場合、機能とレスポンスは以下のようになります。

duplicateCheck=1、version=4で、メールアドレスを持つデータが存在しない場合、機能とレスポンスは以下のようになります。

duplicateCheck=1、version=4で、全データにメールアドレスがある場合、機能とレスポンスは以下のようになります。

duplicateCheck=2、version=4で、メールアドレスを持つデータが存在しない場合、機能とレスポンスは以下のようになります。

duplicateCheck=2、version=4で、全データにメールアドレスがある場合、機能とレスポンスは以下のようになります。

duplicateCheck=2、version=4で、メールアドレスを持つデータと持たないデータが存在している場合、機能とレスポンスは以下のようになります。

version=4で、エラーがあるデータとエラーがないデータが存在している場合、機能とレスポンスは以下のようになります。

<response uri="/crm/private/xml/Leads/insertRecords">
<result>
<row no="1">
<success>
<code>2001</code>
<details>
<FL val="Id">2000000120006</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>

［カスタム］タブへのデータの挿入

リクエスト例

https://crm.zoho.com/crm/private/xml/CustomModule1/insertRecords?authtoken=Auth Token&scope=crmapi
&xmlData=

<CustomModule>
<row no="1">
<FL val="CustomModule1 Name">Registration-CS1000120160101</FL>
</row>
</CustomModule>

注：

メールアドレスは、［見込み客］タブの重複チェック項目です。他のタブの重複チェック項目は異なります。詳細については、https://www.zoho.com/crm/help/api/insertrecords.html#Duplicate_Check_Fieldを参照してください。
xmlデータでユーザーがリクエストしたのと同じ形式でレスポンスのデータ詳細が表示されるようになったため、データIDを識別しやすくなりました。
バージョンを渡さない場合、デフォルトの機能が実行されます。
複数データで重複チェックを行うには、パラメーターURLでversion=4を渡す必要があります。