createTemplate

Prev Next

Classic/VPC環境で利用できます。

送信するメールの件名や本文などを設定して、新しいメールテンプレートを作成します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド URI
POST /template

リクエストヘッダ

Cloud Outbound Mailer APIで共通して使用されるヘッダの詳細は、Cloud Outbound Mailerのリクエストヘッダをご参照ください。

リクエストボディ

リクエストボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
categorySid String Optional テンプレートが所属するカテゴリの SID
  • -1 (root) (デフォルト)
templateName String Required 作成するテンプレートの名前
  • ハングル、英数字、ピリオド「.」、アンダースコア「_」、ハイフン「-」を使用して、0~100文字以内で入力
description String Optional テンプレートの説明(Byte)
  • 0~300
title String Required メールの件名(Byte)
  • 1~500
body String Required メールの本文
senderAddress String Required 送信者のメールアドレス
senderName String Optional 送信者名(Byte)
  • 0~69
isUse Boolean Optional 作成したテンプレートの使用有無
  • true | false
    • true: テンプレートを使用
    • false: テンプレートを使用しない

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request POST 'https://mail.apigw.ntruss.com/api/v1/template'
--header 'x-ncp-apigw-timestamp: {Timestamp}'
--header 'x-ncp-iam-access-key: {Access Key}' 
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' 
--header 'Content-Type: application/json' 
--data-raw '{
  "categorySid": 252,
  "templateName": "membershipTemplate",
  "description": "Example of creating a template",
  "title": "[EN] Naver Cloud Platform",
  "body": "Congratulations on your membership.",
  "senderAddress": "admin@master.com",
  "senderName": "Admin",
  "isUse": true
}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
sid Integer Required 作成したテンプレートの SID
createDate NesDateTime Required 作成日時
name String Required 作成したテンプレートの名前
description String Optional 作成したテンプレートの説明
title String Required メールの件名
senderAddress String Required 送信者のメールアドレス
senderName String Optional 送信者名
body String Required メールの本文
isUse Boolean Required テンプレートの使用有無
category Category Optional 親カテゴリの情報

レスポンスステータスコード

レスポンスステータスコードの説明は次の通りです。

HTTPステータスコード コード 説明
201 - リクエスト成功
400 - 認証失敗、無効なリクエスト
400 77101 ログイン情報エラー
400 77102 リクエストエラー
400 77103 リクエストしたリソースが存在しない
403 77201 リクエストしたリソースに対する権限がない
403 77202 メールサービスの使用を申し込んでいないユーザーが呼び出した場合
405 77001 サポートしないメソッドタイプ
415 77002 サポートしないメディアタイプ
500 - サーバエラー
500 77301 基本プロジェクトが存在しない
500 77302 外部システム API連携エラー
500 77303 その他の内部サーバエラー

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
  "sid": 258,
  "createDate": {
    "utc": 1589348863431,
    "formattedDate": "2020-05-13",
    "formattedDateTime": "2020-05-13 14:47:43 431"
  },
  "name": "membershipTemplate",
  "description": "Example of creating a template",
  "title": "[EN] Naver Cloud Platform",
  "senderAddress": "admin@master.com",
  "senderName": "Admin",
  "body": "Congratulations on your membership.",
  "isUse": true,
  "category": {
    "sid": 252,
    "parentSid": -1,
    "name": "testCategory"
  }
}