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 >> Mailtemplate.put

メールテンプレート情報更新API

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

メソッド名

mailtemplate.put

リクエスト情報

アクセスURL

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

URL部パラメータ

なし

HTTPリクエストヘッダ

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

HTTPリクエストボディ

★ エレメント名:MailTemplate ★ データ型:MailTemplateType

カラム名 必須 データ型 内容
Id 必須 string メールテンプレートID
MailType オプション MailTypeType メール種別
MailTypeId:MailTypeName
1:テキスト形式
2:HTML形式
3:マルチパート形式
SenderAddress オプション string 送信者Emailアドレス
SenderName オプション string 送信者名
ReplyTo オプション string 返信先
ReturnPath オプション string エラー時返信先
MailEditorType オプション MailEditorTypeType エディタ種別
MailEditorTypeId:MailEditorTypeName
1:テキスト
2:旧エディタ
3:エディタ
4:HTMLソース
Title オプション string タイトル
Body オプション string 本文
Body2 オプション string 本文2(マルチパート形式におけるHTML文面)
DestinationAddress オプション string 宛先Emailアドレス
Cc オプション string CC
Bcc オプション string BCC
Charset オプション CharsetType 文字コード
CharsetId:CharsetName
1:西欧 (ISO-8859-1)
2:Unicode (UTF-8)
3:日本語 (EUC-JP)
4:日本語 (ISO-2022-JP)
5:日本語 (Shift_JIS)
6:簡体字中国語 (GB2312)
7:繁体字中国語 (BIG5)
8:韓国語 (EUC-KR)
9:キリル文字 (ISO-8859-5)
10:キリル文字 (KOI8-R)
11:キリル文字 (Windows-1251)
StopAutoSend オプション StopAutoSendType 自動送信ON/OFF
0:ON
1:OFF
MailFile オプション MailFileType 添付ファイル
MailFileId:ファイルID
MailFileName:ファイル名
MailFileExtension:ファイル拡張子
Memo オプション string メモ
DkimKey オプション DkimKeyType DKIM
DkimKeyId:DKIM ID
DkimKeyName:FQDN
MailUsageList オプション MailUsageListType 用途のリスト
MailUsageの内容は
MailUsageId:MailUsageName
1:送信ウィザード/ステップメール用
2:シナリオ
SenderDomainAuthentication オプション SenderDomainAuthenticationType 送信ドメイン
SenderDomainAuthenticationId:送信ドメイン ID
SenderDomainAuthenticationName:設定名

※こちらを指定された場合、SenderAddressの末尾に”@” + 送信ドメインのドメインを付与します。

レスポンス情報

レスポンスコード

コード 内容
200 正常終了

HTTPレスポンスヘッダ

なし

HTTPレスポンスボディ

なし

XMLサンプル

リクエストXMLサンプル

送信ドメインを指定しない場合

<?xml version='1.0' encoding='UTF-8'?>
<MailTemplate xmlns="http://smartseminar.jp/">
 <Id>9215</Id>
 <MailType>
  <MailTypeId>2</MailTypeId>
  <MailTypeName>HTML形式</MailTypeName>
 </MailType>
 <MailEditorType>
  <MailEditorTypeId>3</MailEditorTypeId>
 </MailEditorType>
 <SenderAddress>failure+sender2@shanon.co.jp</SenderAddress>
 <SenderName></SenderName>
 <ReplyTo>failure+replyto2@shanon.co.jp</ReplyTo>
 <DkimKey>
  <DkimKeyId>1</DkimKeyId>
  <DkimKeyName>a01._domiankey.shanon.co.jp</DkimKeyName>
 </DkimKey>
 <ReturnPath>failure+returnpath2@shanon.co.jp</ReturnPath>
 <Title>APIから更新</Title>
 <Body>テストメールです</Body>
 <DestinationAddress>[% VisitorData.email %]</DestinationAddress>
 <Cc>failure+cc2@shanon.co.jp</Cc>
 <Bcc>failure+bcc2@shanon.co.jp</Bcc>
 <Charset>
  <CharsetId>1</CharsetId>
 </Charset>
 <StopAutoSend>
  <StopAutoSendId></StopAutoSendId>
  <StopAutoSendName></StopAutoSendName>
 </StopAutoSend>
 <MailFile>
  <MailFileExtension>jpg</MailFileExtension>
  <MailFileId>6409</MailFileId>
  <MailFileName>pikachu</MailFileName>
 </MailFile>
 <MailUsageList>
  <MailUsage>
   <MailUsageId>1</MailUsageId>
   <MailUsageName>送信ウィザード/ステップメール用</MailUsageName>
  </MailUsage>
 </MailUsageList>
 <Memo>テストメモです</Memo>
</MailTemplate>

送信ドメインを指定する場合

<?xml version='1.0' encoding='UTF-8'?>
<MailTemplate xmlns="http://smartseminar.jp/">
 <Id>9215</Id>
 <MailType>
  <MailTypeId>2</MailTypeId>
  <MailTypeName>HTML形式</MailTypeName>
 </MailType>
 <MailEditorType>
  <MailEditorTypeId>3</MailEditorTypeId>
 </MailEditorType>
 <SenderAddress>failure+sender2</SenderAddress>
 <SenderName></SenderName>
 <ReplyTo>failure+replyto2@shanon.co.jp</ReplyTo>
 <ReturnPath>failure+returnpath2@shanon.co.jp</ReturnPath>
 <Title>APIから更新</Title>
 <Body>テストメールです</Body>
 <DestinationAddress>[% VisitorData.email %]</DestinationAddress>
 <Cc>failure+cc2@shanon.co.jp</Cc>
 <Bcc>failure+bcc2@shanon.co.jp</Bcc>
 <Charset>
  <CharsetId>1</CharsetId>
 </Charset>
 <StopAutoSend>
  <StopAutoSendId></StopAutoSendId>
  <StopAutoSendName></StopAutoSendName>
 </StopAutoSend>
 <MailFile>
  <MailFileExtension>jpg</MailFileExtension>
  <MailFileId>6409</MailFileId>
  <MailFileName>pikachu</MailFileName>
 </MailFile>
 <MailUsageList>
  <MailUsage>
   <MailUsageId>1</MailUsageId>
   <MailUsageName>送信ウィザード/ステップメール用</MailUsageName>
  </MailUsage>
 </MailUsageList>
 <SenderDomainAuthentication>
  <SenderDomainAuthenticationId>2</SenderDomainAuthenticationId>
  <SenderDomainAuthenticationName>shanon.co.jpの設定</SenderDomainAuthenticationName>
 </SenderDomainAuthentication>
 <Memo>テストメモです</Memo>
</MailTemplate>

レスポンスXMLサンプル

なし

制限事項

  • 種別、カテゴリ、キャンペーンIDを変更することはできません。
  • 添付ファイル (MailFile) を利用する場合、ファイル情報API (file.post) を利用して予めファイルをアップロードする必要があります。一度使用したファイルは繰り返し指定できません。ファイルのサイズの上限は、システム設定「メール添付のファイルサイズ制限」の設定値と同じで、通常2.5MBです。
  • Seminarが設定されている場合、MailUsageListの項目で「2:シナリオ用」を指定する事はできません。

注意事項

  • 既にメール送信に使用されたテンプレートの変更は行わないでください。変更した場合メール送信履歴の整合性に矛盾が生じる場合があります。
  • 既にメール予約配信に登録されているテンプレートの変更は行わないでください。文面を変更する場合は、予約を一度削除してから変更し、再度予約を行ってください。
  • メール種別に対応していないエディタ種別を指定することはできません。
    • メール種別がテキスト形式の場合 → テキストのみ指定できます。
    • メール種別がHTML形式かマルチパート形式の場合 → エディタ、HTMLソースのいずれかのみ指定できます。
  • 送信ドメイン(SenderDomainAuthentication)を指定された場合、登録時にSenderAddressの末尾に”@” + 送信ドメインのドメインを付与します。
    • そのため、SenderAddressに関してはメールアカウント部(@の前までの文字列)のみ指定してください。
    • また、DKIMの指定も不要となります。(送信ドメイン側でDKIMを指定しているため)