convertLeadメソッド

目的

このメソッドを使用すると、見込み客を商談、取引先、連絡先に変換できます。また、変換する見込み客に既存の連絡先または取引先を関連付けることもできます。

見込み客の変換プロセスについては、ユーザーマニュアルの見込み客の他の営業データへの変換を参照してください。

リクエストURL

XML形式：
https://crm.zoho.com/crm/private/xml/Leads/convertLead?authtoken=Auth Token&scope=crmapi &leadId=entity Id&xmlData=POTENTIALXMLDATA

JSON形式：
https://crm.zoho.com/crm/private/json/Leads/convertLead?authtoken=Auth Token&scope=crmapi &leadId=entity Id&xmlData=POTENTIALXMLDATA

リクエストパラメーター

パラメーターデータ型説明
authtoken*文字列Zoho認証情報の認証に使用する、暗号化された英数字文字列。
scope*文字列値をcrmapiと指定してください。
leadId*文字列見込み客の一意のIDを指定してください。
xmlData*XML項目と対応する値を指定してください。
newFormat整数newFormat=1：値が「null」の項目を除外して、CRMアカウントにデータを挿入します。
newFormat=2：値が「null」の項目を含めて、CRMアカウントにデータを挿入します。
version整数version = 1：（デフォルト値）強化前の古いAPI実装に基づいてレスポンスを取得します。
version = 2：最新のAPI実装に基づいてレスポンスを取得します。

* - 必須パラメーター

注：

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

見込み客をアカウント、連絡先、商談に変換するXML例

<Potentials>
<row no="1">
<option val="createPotential">true</option>
<option val="assignTo">sample@zoho.com</option>
<option val="notifyLeadOwner">true</option>
<option val="notifyNewEntityOwner">true</option>
</row>
<row no="2">
<FL val="Potential Name">Samplepotential</FL>
<FL val="Closing Date">12/21/2009</FL><FL val="Potential Stage">Closed Won</FL>
<FL val="Contact Role">Purchasing</FL>
<FL val="Amount">3432.23</FL>
<FL val="Probability">100</FL>
</row>
</Potentials>

注：

  • 上記XMLの<row no="2">は、「createPotential」の値がtrueに設定されている場合にのみ必須です。「createPotential」の値がfalseに設定されている場合、見込み客の変換時に商談は作成されません。

変換する見込み客に既存の連絡先または取引先を関連付けるXML例

<Potentials>
<row no="1">
<option val="createPotential">true</option>
<option val="assignTo">sample@zoho.com</option>
<option val="notifyLeadOwner">true</option>
<option val="notifyNewEntityOwner">true</option>
</row>
<row no="2">
<FL val="Potential Name">Samplepotential</FL>
<FL val="Closing Date">12/21/2009</FL><FL val="Potential Stage">Closed Won</FL>
<FL val="Contact Role">Purchasing</FL>
<FL val="Amount">3432.23</FL>
<FL val="Probability">100</FL>
<FL val="ACCOUNTID">543212345</FL>
<FL val="CONTACTID">1234554321</FL>
<FL val="OVERWRITE">true</FL>
</row>
</Potentials>

注：

  • assignToの値は、SMOWNERIDまたはメールアドレスのいずれかです。
  • 見込み客を商談に変換してもしなくても、変換する見込み客に既存の連絡先または取引先を関連付けることができます。これを実行するには、xmlを介してACCOUNTIDとCONTACTIDを送信する必要があります。
  • <FL val="ACCOUNTID"></FL>と<FL val="OVERWRITE">true</FL>の両方の値を指定して、取引先を既存取引先に関連付けると、取引先名が組織名に置き換えられます。ただし、その取引先のデータは変更されません。
  • OVERWRITEの値がfalseの場合、関連付けだけが実行されます。ただし、ACCOUNTIDを指定せずにOVERWRITEの値を指定した場合、このメソッドの動作は変更されません。
  • <FL val="CONTACTID"></FL>が指定されている場合、変換する見込み客は既存の連絡先に関連付けられます。

商談を作成せずに見込み客を変換するXML例

<Potentials>
<row no="1">
<option val="createPotential">false</option>
<option val="assignTo">sample@zoho.com</option>
<option val="notifyLeadOwner">true</option>
<option val="notifyNewEntityOwner">true</option>
</row>
</Potentials>