リード情報更新API

マーケティングプラットフォームのリード情報を更新するためのAPIです。

メソッド名

visitor.put

リクエスト情報

アクセスURL

メソッド	URL
PUT	https://{domainname}/services/rest/visitor

URL部パラメータ

パラメータ名	必須	内容
upsert	オプション	更新キーに対するデータが存在する場合は更新を行い、存在しない場合は新規登録を行いたい場合は「1」を指定します。
update_key	オプション	upsertオプションが「1」の場合の更新キーを指定します。設定値は、システム設定一覧の「Webサービス経由でのリード登録時の更新キーの利用」をご覧ください。複数指定する場合は「:」をURLエンコードした「%3A」で区切ります。なお、本項目に値を設定した場合、「Webサービス経由でのリード登録時の更新キーの利用」で設定した値よりも優先されます。
ignore_itemcheck	オプション	要素のエラーチェック(必須チェック、型チェック)を行いたくない場合は「1」を指定します。

HTTPリクエストヘッダ

パラメータ名	値	内容
X-HTTP-Method-Override	PUT	X-HTTP-Method-Override を使用して、HTTPメソッドを上書きします。

HTTPリクエストボディ

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

カラム名	データ型	内容
Id	string	リードID ※更新キーとして使用します。リードIDは更新できません。upsert=1 の場合は指定しないでください。
LoginId	string	ログインID
LoginPassword	string	ログインパスワード ※マーケティングプラットフォームでシステム設定「パスワードを暗号化して保存」が「有効」の場合、更新できません。
Name1	string	姓
Name2	string	名
Name3	string	ミドルネーム
Name1Ka	string	姓フリガナ
Name2Ka	string	名フリガナ
CompanyName	string	会社名
CompanyNameKa	string	会社名フリガナ
Division	string	部署
Position	string	役職
Zip1	string	郵便番号1
Zip2	string	郵便番号2
Zip3	string	郵便番号3
Country	CountryType	国名 CountryId : CountryName
Prefecture	PrefectureType	都道府県IDと都道府県名の対応表参照
Address1	string	住所1
Address2	string	住所2
Address3	string	住所3
Address4	string	住所4
Address5	string	住所5
Tel	string	電話番号
SubTel	string	電話番号予備
Fax	string	ファックス番号
Email	string	E-Mail アドレス
SubEmail	string	E-mailアドレス予備
PermissionType	PermissionTypeType	最新情報等をメールで受け取りますか PermissionTypeId : PermissionTypeName 1 : 希望する 2 : 希望しない
Language	LanguageType	使用言語 LanguageId : LanguageName 1: 日本語 2: 英語 ※ 他言語も利用可能（SMP環境毎に異なるため、「設定」タブの「言語設定」に登録されている言語をご確認ください）
Memo	string	メモ
Attribute{aid}	－	追加項目追加項目について/追加項目のデータ型参照
Membership	MembershipType	ログインIDの使用 MembershipId : MembershipName 1 : 使用する 0 : 使用しない
EmailValid	EmailValidType	E-mailアドレスの有効フラグ EmailValidId : EmailValidName 0 : 無効 1 : 有効
SubEmailValid	SubEmailValidType	E-mailアドレス予備の有効フラグ SubEmailValidId : SubEmailValidName 0 : 無効 1 : 有効

レスポンス情報

レスポンスコード

コード	内容
200	正常終了

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サンプル

なし

制限事項

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

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

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

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

マーケティングプラットフォームAPIは、リード情報の更新にvisitor.putメソッドを使用します。 visitor.putメソッドは更新するリード情報を特定するために、更新キーを指定する必要があります。通常、更新キーは一意であることが保証されているリードIDを使用しますが、リードID以外の更新キーを使用することもできます。

リードID以外による更新

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

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

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

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

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

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

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

メソッド	URL
PUT	https://{domainname}/services/rest/visitor

レスポンスコード

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

コード	内容
200	正常終了 ※リード情報が更新された場合
201	正常終了 ※リード情報が新規登録された場合