SHANON MARKETING PLATFORM API GUIDE
  • APIの利用方法
    • APIの利用方法
    • 認証
    • APIコールとメソッドリファレンス
    • 検索
    • 登録・更新
  • クライアントアプリケーション認証
    • authentication.get
  • 画面ユーザ認証
    • authapi.login
    • authinfo.getToken
    • authinfo.getCheck
    • authinfo.logout
    • authapi.agencynavigation
    • authapi.agencynavigation.back
  • 管理者
    • admin.get
    • admin.post
    • admin.put
    • admin.delete
  • キャンペーン
    • seminar.get
    • seminar.post
    • seminar.put
    • seminar.delete
    • seminaritemsetting.get
    • seminar.getSession
    • seminar.postSession
    • seminar.putSession
    • seminar.deleteSession
    • sessionitemsetting.get
  • 担当者割当
    • admin.getAssinmentSeminar
    • admin.postAssinmentSeminar
    • admin.deleteAssinmentSeminar
  • アンケート
    • enquetetemplate.get
    • enquetetemplate.getQuestion
  • 講演者
    • speaker.get
    • speakersetting.get
  • 資料
    • document.get
  • リスト
    • staticlist.get
    • staticlist.post
    • staticlist.put
    • staticlist.delete
  • リスト・リード管理
    • staticlist.getVisitor
    • staticlist.postVisitor
    • staticlist.deleteVisitor
  • 企業
    • company.get
    • company.post
    • company.put
    • company.delete
  • 企業・リード管理
    • company.getVisitor
    • company.postVisitor
    • company.deleteVisitor
  • リード
    • visitor.get
    • visitor.post
    • visitor.put
    • visitor.delete
    • visitor.getFile
    • visitor.postFile
    • visitor.putFile
    • visitor.deleteFile
    • visitorsetting.get
  • 申込
    • application.post
    • application.delete
    • seminar.getDiscount
    • visitor.getDiscounthistory
    • visitor.getBilling
    • visitor.getApplication
    • visitor.putApplication
    • counting.getApplication
  • キャンペーン申込情報
    • visitor.getApplicationSeminar
    • visitor.getApplicationSession
  • 申込フロー
    • seminar.getFlow
  • 来場
    • visitor.getAttendance
    • visitor.getAttendanceSeminar
    • visitor.postAttendanceSeminar
    • visitor.deleteAttendanceSeminar
    • visitor.getAttendanceSession
    • visitor.postAttendanceSession
    • visitor.deleteAttendanceSession
    • counting.getAttendance
  • メール送信
    • visitor.postMail
    • 一斉メール送信APIの利用方法
    • mailtemplate.get
    • mailtemplate.post
    • mailtemplate.put
    • mailtemplate.delete
    • mailsender.get
    • mailsender.post
    • mailsender.delete
  • クリックカウント
    • clickcounturl.get
  • トラッキング
    • trackingurl.get
  • メール履歴情報
    • visitor.getMail
  • アンケート履歴情報
    • visitor.getEnquete
    • enquetehistory.get
  • クリックカウント履歴情報
    • visitor.getClickcount
  • トラッキング履歴情報
    • visitor.getTrackingaccesslog
    • visitor.getTrackingsession
  • 資料履歴情報
    • visitor.getDocumentdownload
  • 活動履歴情報
    • visitor.getActivity
    • visitor.postActivity
    • visitor.putActivity
    • visitor.deleteActivity
    • activitysetting.get
  • リード変更履歴情報
    • visitor.getChangelog
    • visitor.getAddlog
    • visitor.getDeletelog
    • visitor.getMergelog
  • DM個別送信履歴情報
    • visitor.getDirectMail
  • キャンペーン設定
    • seminarsettingdata.get
    • seminarsettingdata.put
  • メッセージ
    • messagestr.get
    • messagestr.put
  • ファイル情報
    • file.get
    • file.post
  • 検索条件
    • searchcondition.get
  • バルクAPI
    • 概要
    • bulkapi.get
    • bulkapi.post
  • APPENDIX
    • APIメソッドリファレンス
    • 用語について
    • 共通エラーコード一覧
    • 都道府県IDと都道府県名の対応表
    • タイムゾーンIDとタイムゾーン名の対応表
    • 非推奨API
    • 改訂履歴
Home >> Seminar.put

キャンペーン情報更新API

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

メソッド名

seminar.put

アクセスURL

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

リクエスト情報

URL部パラメータ

なし

HTTPリクエストヘッダ

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

HTTPリクエストボディ

★ エレメント名:Seminar ★ データ型:SeminarType

カラム名 必須 データ型 内容
Id オプション string キャンペーンID
SsTargetType 必須 SsTargetTypeType キャンペーンタイプID
SsTargetTypeId:SsTargetTypeName
1:キャンペーン
2:サブキャンペーン
PriceType 必須 PriceTypeType 課金種別
PriceTypeId:PriceTypeName
SeminarCategory オプション SeminarCategoryType カテゴリ
SeminarCategoryId:SeminarCategoryName
SeminarStatus 必須 SeminarStatusType 状態
SeminarStatusId:SeminarStatusName
PortalPublicationType オプション PortalPublicationTypeType カスタム設定(ポータル公開条件)
PortalPublicationTypeId:PortalPublicationTypeName
SeminarPublicationType オプション SeminarPublicationTypeType カスタム設定(キャンペーン詳細公開条件)
SeminarPublicationTypeId:SeminarPublicationTypeName
FlowPublicationType オプション FlowPublicationTypeType カスタム設定(申込条件)
FlowPublicationTypeId:FlowPublicationTypeName
PreserveSearchCondition オプション PreserveSearchConditionType カスタム設定(リードの検索条件フィルタ)
PreserveSearchConditionId:PreserveSearchConditionName
Title 必須 string キャンペーンタイトル
SubTitle オプション string キャンペーンサブタイトル
Summary オプション string キャンペーン概要
Detail オプション string キャンペーン詳細
Notes オプション string 注意事項
TargetUser オプション string 対象者
Sponsor オプション string 主催
CoSponsor オプション string 共催
Support オプション string 協賛
HtmlEditorType オプション HtmlEditorTypeType エディタ種別ID
HtmlEditorTypeId:HtmlEditorTypeName
1: エディタ
2: HTMLソース
NewsBody オプション string フリー入力欄
Memo オプション string メモ
StartDay オプション dateTime 開催期間(開始日時)
EndDay オプション dateTime 開催期間(終了日時)
StartDayDisplay オプション string 表示用開催期間(開始日時)
ApplicationStartDay オプション dateTime 申込期間(開始日時)
ApplicationEndDay オプション dateTime 申込期間(終了日時)
ApplicationStartDayDisplay オプション string 表示用申込期間(開始日時)
LimitUserNum オプション nonNegativeInteger 定員
LimitUserNumDisplay オプション string 表示用定員
Cost オプション string 実施コスト
TargetCostPerPerson オプション string 目標単価
HallName オプション string 会場名
HallZipcode オプション string 会場の郵便番号
Prefecture オプション PrefectureType 会場の住所(都道府県) 都道府県IDと都道府県名の対応表参照
HallAddress オプション string 会場の住所
HallTel オプション string 会場の電話番号
HallNote オプション string 会場備考
HallMapUrl オプション string 会場URL
ReferenceName オプション string お問合せ先名
ReferencePersonInCharge オプション string お問合せ先担当者
ReferenceEmail オプション string お問合せ先E-mail
ReferenceTel オプション string お問合せ先電話番号
ReferenceFax オプション string お問合せ先ファックス番号
ReferenceAddress オプション string お問合せ先住所
ReferenceNote オプション string お問合せ先備考
Price 必須 nonNegativeInteger 金額
PriceDisplay オプション string 表示用金額
DetailFile オプション DetailFileType 詳細画像
DetailFileID:DetailFileName
HallFile オプション HallFileType 会場地図
HallFileId : HallFileName : HallFilePath
HeaderFile オプション HeaderFileType ヘッダー画像
HeaderFileId : HeaderFileName
Attribute{aid} オプション ― 追加項目

※API メソッドリファレンス「追加項目のデータ型」を参照

レスポンス情報

レスポンスコード

コード 内容
200 正常終了

HTTPレスポンスヘッダ

なし

HTTPレスポンスボディ

なし

XMLサンプル

リクエストXMLサンプル

<?xml version='1.0' encoding='UTF-8'?>
<Seminar xmlns="http://smartseminar.jp/">
 <Attribute1>APIテストアトリビュートテキスト1</Attribute1>
 <Attribute2List>
  <Attribute2>
   <Attribute2Id>2</Attribute2Id>
   <Attribute2Name>2</Attribute2Name>
  </Attribute2>
 </Attribute2List>
 <Detail>更新後のキャンペーン詳細</Detail>
 <EndDay>2014-03-03T23:55:00+09:00</EndDay>
 <Price>0</Price>
 <PriceDisplay>無料です</PriceDisplay>
 <PriceType>
  <PriceTypeId>1</PriceTypeId>
  <PriceTypeName>無料</PriceTypeName>
 </PriceType>
 <SeminarStatus>
  <SeminarStatusId>1</SeminarStatusId>
  <SeminarStatusName>公開</SeminarStatusName>
 </SeminarStatus>
 <SsTargetType>
  <SsTargetTypeId>1</SsTargetTypeId>
  <SsTargetTypeName>キャンペーン</SsTargetTypeName>
 </SsTargetType>
 <Title>更新後のタイトル</Title>
</Seminar>

レスポンスXMLサンプル

なし

制限事項

  • seminar.post で登録できない項目は原則、 seminar.put 時も登録・更新できません。
  • SsTargetType を変更する(例: キャンペーン型をサブキャンペーン型にする)ことはできません。
  • FlowPublicationType を 1:非公開 に更新することはできません (エラーにはならず、リクエスト値は無視されます)。これは、キャンペーン情報取得時、キャンペーンの状態が「準備中・終了」の場合、FlowPublicationType の値が 1:非公開 として取得されることによる制限です。
  • その他、マーケティングプラットフォームから変更できないパターンは原則、APIでも変更できません。