リード情報更新API

SMPのリード情報を更新するためのAPIです。

メソッド名

visitor.put

リクエスト情報

アクセスURL

URL部パラメータ

HTTPリクエストヘッダ

HTTPリクエストボディ

★エレメント名：VisitorData ★データ型：VisitorDataType

レスポンス情報

レスポンスコード

HTTPレスポンスヘッダ

なし

HTTPレスポンスボディ

なし

XMLサンプル

リクエストXMLサンプル

<?xml version='1.0' encoding='UTF-8'?>
<VisitorData xmlns="http://smartseminar.jp/" version="1.5">
　<Id>10</Id>
　<LoginId>testuser001</LoginId>
　<LoginPassword>testpass001</LoginPassword>
　<Name1>テスト</Name1>
　<Name2>太郎</Name2>
　<Name3>J</Name3>
　<Name1Ka>テスト</Name1Ka>
　<Name2Ka>タロウ</Name2Ka>
　<CompanyName>会社名１</CompanyName>
　<CompanyNameKa>カイシャメイフリガナ１</CompanyNameKa>
　<Division>部署１</Division>
　<Position>役職１</Position>
　<Zip1>111</Zip1>
　<Zip2>1111</Zip2>
　<Zip3>11</Zip3>
　<Country>
　　<CountryId>1</CountryId>
　　<CountryName>Japan</CountryName>
　</Country>
　<Prefecture>
　　<PrefectureId>1</PrefectureId>
　　<PrefectureName>北海道</PrefectureName>
　</Prefecture>
　<Address1>札幌市</Address1>
　<Address2>中央区</Address2>
　<Address3>双子山</Address3>
　<Address4>１－１－１</Address4>
　<Address5>ハイツ○○×××号室</Address5>
　<Tel>111-111-1111</Tel>
　<SubTel>222-222-2222</SubTel>
　<Fax>333-333-3333</Fax>
　<Email>failure01@shanon.co.jp</Email>
　<SubEmail>failure02@shanon.co.jp</SubEmail>
　<PermissionType>
　　<PermissionTypeId>1</PermissionTypeId>
　　<PermissionTypeName>許可</PermissionTypeName>
　</PermissionType>
　<Memo>メモメモ</Memo>
　<Attribute1>追加属性１</Attribute1>
　<Attribute2List>
　　<Attribute2>
　　　<Attribute2Id>1</Attribute2Id>
　　　<Attribute2Name>選択肢１</Attribute2Name>
　　</Attribute2>
　</Attribute2List>
</VisitorData>

レスポンスXMLサンプル

なし

制限事項

SHANON MARKETING PLATFORM APIのリクエストパラメータに記載されている必須カラムと、対応するSMPの必須カラムは、整合性がとれている必要があります。
例えば、SHANON MARKETING PLATFORM APIでは必須でないカラムであっても、SMPのカラムが必須であった場合、APIによるデータ更新処理時に必須エラーが発生します。

URL部パラメータでupsetを1に指定した場合の注意事項

• 指定する更新キーによって、「リクエストボディの必須カラム」が変わります。
• 更新キーに「id」を指定した場合は、アクセスURLが「https://{domainname}/services/rest/visitor 」となります。
• このメソッドでリード情報が更新・登録されるかによって、レスポンスコードが変わります。
• ※詳細は下記の URL パラメータ[upsert=1]およびレスポンスコードを参照下さい。

リード情報の更新方法について

SHANON MARKETING PLATFORM APIは、リード情報の更新にvisitor.putメソッドを使用します。 visitor.putメソッドは更新するリード情報を特定するために、更新キーを指定する必要があります。 通常、更新キーは一意であることが保証されているリードIDを使用しますが、リードID以外の更新キーを使用することもできます。

リードID以外による更新

リード情報の更新は、emailなどリードID以外の更新キーを指定できます。 リードID以外の更新キーによる更新を行う場合、下記の設定を行う必要があります。

システム設定 [Webサービス経由でのリード登録時の更新キーの利用]
URLパラメータ [upsert=1]

★ システム設定「Webサービス経由でのリード登録時の更新キーの利用」

SMPのシステム設定「Webサービス経由でのリード登録時の更新キーの利用」に更新キーを指定します。 ※システム設定「Webサービス経由でのリード登録時の更新キーの利用」については「APIガイドの利用方法」の「APIによるキャンペーンの申込について」節の「キャンペーンへの追加申込」項を参照してください。

★ URLパラメータ [upsert=1]

visitor.putのURLパラメータでupsertを1に指定した場合、リード情報の更新方法が変わります。

• ※UPSERTとは、UPDATE+INSERTのことであり、更新対象のデータがあればデータの更新（UPDATE）、なければデータの新規登録（INSERT)を行います。
• 指定した更新キーに該当するリードがいる場合にリード情報の更新を行い、該当するリードがいなければリード情報の新規登録を行います。
• 更新キーに該当するリードが２件以上存在する場合、リード情報の更新・新規登録はされません。
• 新キーとして指定したカラムは、リクエストボディの必須カラムになります。
  • 例えば、「email」を更新キーに設定した場合、Emailが必須カラムになります。
• リクエストURL：更新キーを「id」に指定した場合は、リクエストURLの｛id｝、HTTPリクエストボディのは不要となります。

レスポンスコード

• upsertに1を指定した場合は、更新と新規登録でレスポンスコードが変わります。