ConvertLead
Lead をAccount、Contact、もしくは（オプションで）Opportunity に変換します。
Note: This procedure makes use of indexed parameters. These input parameters are denoted with a '#' character at the end of their names.
Indexed parameters facilitate providing multiple instances a single parameter as inputs for the procedure.
Suppose there is an input parameter named Param#. Input multiple instances of an indexed parameter like this:
EXEC ProcedureName Param#1 = "value1", Param#2 = "value2", Param#3 = "value3"
Input
| Name | Type | Description |
| AccountId# | String | Lead がマージされるAccount のID。個人アカウントを含む既存アカウントを更新する際のみに必要です。アカウントID が指定されない場合、API は新しいアカウントを作成します。新しいアカウントの作成には、クライアントアプリケーションは必要なアクセス権においてログインされている必要があります。Lead を既存アカウントにマージする場合、クライアントアプリケーションは指定されたアカウントへの読み/書きアクセスでログインされている必要があります。アカウント名および他の既存データは上書きされません。 |
| ContactId# | String | Lead がマージされるContact のID （このコンタクトは指定されたアカウントIDに関連し、アカウントID は指定される必要があります）。既存コンタクトを更新する際のみに必要です。Lead をperson アカウントに変換する場合には、contact ID を指定する必要はありません。指定するとエラーとなります。Person アカウントのaccountID のみを指定します。コンタクトID が指定されない場合、API は、Account に黙示的に関連付けられた新しいコンタクトを作成します。新しいコンタクトの作成には、クライアントアプリケーションは必要なアクセス権においてログインされている必要があります。Lead を既存コンタクトにマージする場合、クライアントアプリケーションは指定されたコンタクトへの読み/書きアクセスでログインされている必要があります。コンタクト名および他の既存データは上書きされません（overwriteLeadSource がtrue に設定されている場合のみ、LeadSource フィールドは上書きされます）。 |
| ConvertedStatus# | String | 変換されたLead のValid LeadStatus 値。必須。使用可能な値のリストを取得するには、クライアントアプリケーションはLeadStatus オブジェクトをクエリします。 |
| DoNotCreateOpportunity# | String | Lead の変換においてOpportunity を作成する（デフォルトはfalse）、もしくはしない（true）。Lead からOpportunity を作成したくない場合にのみこのフラグをtrue に設定します。デフォルトでOpportunity は作成されます。 |
| LeadId# | String | 変換するLead のID。必須。 |
| OpportunityName# | String | 作成するOpportunity の名前。名前を指定しない場合、Lead の会社名にデフォルトで設定されます。本フィールドの最大数値は80文字です。doNotCreateOpportunity がtrue の場合、Opportunity は作成されないので、本フィールドは空白にする必要があります。空白でない場合はエラーが返されます。 |
| OverwriteLeadSource# | String | Lead オブジェクトのLeadSource フィールドの内容でターゲットContact オブジェクトのLeadSource オブジェクトを上書きする（true）もしくはしない（false デフォルト）を指定します。本フィールドをtrue に設定するには、クライアントアプリケーションはターゲットcontact のcontactId を指定する必要があります。 |
| OwnerId# | String | 新しく作成されたaccount、contact、およびopportunity を所有する人のID を指定。クライアントアプリケーションがこの値を指定しない場合、新しいオブジェクトの所有者はLead の所有者となります。既存のオブジェクトにマージする場合でownerId が指定されていても、既存account もしくはcontact のowenerId フィールドは上書きされません。 |
| SendNotificationEmail# | String | owenerId で指定された所有者にE メール通知を送る（true）か送らない（false、デフォルト）を指定。
The default value is FALSE. |
Result Set Columns
| Name | Type | Description |
| AccountId | String | 新しいAccount のID（新しいaccount が指定された場合）、もしくはconvertLead() が呼び出された場合のaccount のID。 |
| ContactId | String | 新しいContact のID（新しいcontact が指定された場合）、もしくはconvertLead() が呼び出された場合のcontact のID。 |
| LeadId | String | 変換されたLead のID。 |
| OpportunityId | String | convertLead() が呼び出された時に作成された場合の新しいOpportunity のID。 |
| Success | String | このオブジェクトのConvertLead() call が成功（true）か失敗（false）かを示します。 |
| Errors | String | create() call 中にエラーが起こった場合、エラーコードおよび説明を提供するエラーオブジェクトの配列です。 |