createTemplate
    • PDF

    createTemplate

    • PDF

    記事の要約

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

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

    リクエスト

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

    メソッドURI
    POST/template

    リクエストヘッダ

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

    リクエストボディ

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

    フィールドタイプ必須の有無説明
    categorySidStringOptionalテンプレートが所属するカテゴリの SID
    • -1 (root) (デフォルト)
    templateNameStringRequired作成するテンプレートの名前
    • ハングル、英数字、ピリオド「.」、アンダースコア「_」、ハイフン「-」を使用して、0~100文字以内で入力
    descriptionStringOptionalテンプレートの説明(Byte)
    • 0~300
    titleStringRequiredメールの件名(Byte)
    • 1~500
    bodyStringRequiredメールの本文
    senderAddressStringRequired送信者のメールアドレス
    senderNameStringOptional送信者名(Byte)
    • 0~69
    isUseBooleanOptional作成したテンプレートの使用有無
    • 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
    }'
    

    レスポンス

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

    レスポンスボディ

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

    フィールドタイプ必須の有無説明
    sidIntegerRequired作成したテンプレートの SID
    createDateNesDateTimeRequired作成日時
    nameStringRequired作成したテンプレートの名前
    descriptionStringOptional作成したテンプレートの説明
    titleStringRequiredメールの件名
    senderAddressStringRequired送信者のメールアドレス
    senderNameStringOptional送信者名
    bodyStringRequiredメールの本文
    isUseBooleanRequiredテンプレートの使用有無
    categoryCategoryOptional親カテゴリの情報

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

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

    HTTPステータスコードコード説明
    201-リクエスト成功
    400-認証失敗、無効なリクエスト
    40077101ログイン情報エラー
    40077102リクエストエラー
    40077103リクエストしたリソースが存在しない
    40377201リクエストしたリソースに対する権限がない
    40377202メールサービスの使用を申し込んでいないユーザーが呼び出した場合
    40577001サポートしないメソッドタイプ
    41577002サポートしないメディアタイプ
    500-サーバエラー
    50077301基本プロジェクトが存在しない
    50077302外部システム API連携エラー
    50077303その他の内部サーバエラー

    レスポンス例

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

    {
      "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"
      }
    }
    

    この記事は役に立ちましたか?

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.