Eメール配信

Eメール配信登録

Eメールによる配信を登録します。<br> メールアドレスをを指定して、メッセージ本文を配信します。

post/api/v1/emails

Request

  • Base URL: https://sandbox.cpaasnow.com
  • URL: https://sandbox.cpaasnow.com/api/v1/emails
  • Auth: HTTP bearer

Request body

subjectstring required

Eメールの件名

textstring required

テキストメールの本文<br> URLを入れる場合、前後に半角スペースまたは改行を挿入してください。<br> 配信停止URLを利用する場合は本文に{{配信停止URL}}を入力してください。<br> 本文中の配信停止URL数は1個以内にしてください。<br> 受信者が本文中の配信停止URLから配信停止を希望すると、Eメール配信結果取得の配信情報の「配信停止希望」がtrueになります。

htmlstring nullable

HTMLメールの本文<br> 配信停止URLを利用する場合は本文に<a href="{{配信停止URL}}">配信停止はこちら</a>のような形式で入力してください。<br> 本文中の配信停止URL数は1個以内にしてください。<br> 受信者が本文中の配信停止URLから配信停止を希望すると、Eメール配信結果取得の配信情報の「配信停止希望」がtrueになります。

oneclick_unsubscribeboolean

ワンクリック購読解除<br>

  • trueの場合<br> ワンクリック購読解除が可能なＥメールとして配信します。<br> メーラーのインタフェースに「購読解除」リンクが表示されます。<br> 「購読解除」リンクをクリックした場合、Eメール配信結果取得の配信情報の「配信停止希望」がtrueになります。<br> また、Webhookの設定をしている場合は、配信停止希望のイベントを送信します。<br> 配信停止URLで既に配信停止希望がtrueになっている場合はイベントを送信しません。 <br> ※RFC8058の規定に準拠した機能です。メーラーの仕様により「購読解除」リンクが表示されない場合があります。
open_trackingboolean

開封トラッキング<br>

  • trueの場合<br> 配信されたメールを受信者が開封したかどうかを確認できます。<br> true を指定した場合 html が必須になります。<br> 受信者がメールを開封した場合、Eメール配信結果取得APIの配信情報の「開封ステータス」がopenedになります。<br> また、Webhookの設定をしている場合は、Eメール開封のイベントを送信します。
user_referencestring nullable

ユーザー識別子<br> リクエスト時に指定可能な識別子です。<br> Eメール配信結果取得APIのレスポンス、WebhookでのEメール配信結果通知にて同じ値が返却されます。<br> 使用可能文字は半角英数字 、 -(半角ハイフン)、 _(半角アンダースコア)です。

bill_split_codestring nullable

請求明細分割コード<br> 請求明細を分割コード毎に作成します。<br> 使用可能文字は半角英数字 、 -(半角ハイフン)、 _(半角アンダースコア)です。

Response

Accepted

delivery_order_idinteger required

配信オーダーID

accepted_atstring date-time required

配信オーダーの受付日時

Changes

No recorded changes to this operation across all 1 revision of this API.