テンプレート名でメールテンプレートを更新する

メールテンプレートを更新します。

PATCH https://{tenantDomain}/api/v2/email-templates/{templateName}

Go

Go

package example

import (
    context "context"

    management "github.com/auth0/go-auth0/management/management"
    client "github.com/auth0/go-auth0/management/management/client"
    option "github.com/auth0/go-auth0/management/management/option"
)

func do() {
    client := client.NewClient(
        option.WithToken(
            "<token>",
        ),
    )
    request := &management.UpdateEmailTemplateRequestContent{}
    client.EmailTemplates.Update(
        context.TODO(),
        management.EmailTemplateNameEnumVerifyEmail.Ptr(),
        request,
    )
}

200

{
  "body": "<string>",
  "enabled": true,
  "from": "[e-mail]",
  "includeEmailInRedirect": true,
  "resultUrl": "<string>",
  "subject": "<string>",
  "syntax": "liquid",
  "template": "verify_email",
  "urlLifetimeInSeconds": 1
}

承認

bearerAuthoAuth2ClientCredentials

Authorization · string · header · 必須

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

パスパラメータ

templateName · enum<string> · デフォルト: verify_email · 必須

テンプレート名。verify_email、verify_email_by_code、reset_email、reset_email_by_code、welcome_email、blocked_account、stolen_credentials、enrollment_email、mfa_oob_code、user_invitation、async_approval、change_password（レガシー）、または password_reset（レガシー）を指定できます。

利用可能なオプション: verify_email, verify_email_by_code, reset_email, reset_email_by_code, welcome_email, blocked_account, stolen_credentials, enrollment_email, mfa_oob_code, user_invitation, change_password, password_reset, async_approval

ボディ

application/jsonapplication/x-www-form-urlencoded

body · string | null

メールテンプレートの本文。

enabled · boolean | null

テンプレートが有効（true）か無効（false）か。

from · string | null · デフォルト: [e-mail]

送信者の from メールアドレス。

includeEmailInRedirect · boolean

reset_email および verify_email テンプレートで、returnUrl の email パラメーターにユーザーのメールアドレスを含めるかどうか（true）、またはリダイレクトにメールアドレスを含めないかどうか（false）。デフォルトは true です。

resultUrl · string | null

アクションの成功後にユーザーをリダイレクトするURL。

subject · string | null

メールの件名。

syntax · string | null · デフォルト: liquid

テンプレート本文の構文。

template · enum<string> · デフォルト: verify_email

テンプレート名。verify_email、verify_email_by_code、reset_email、reset_email_by_code、welcome_email、blocked_account、stolen_credentials、enrollment_email、mfa_oob_code、user_invitation、async_approval、change_password（レガシー）、または password_reset（レガシー）を指定できます。

利用可能なオプション: verify_email, verify_email_by_code, reset_email, reset_email_by_code, welcome_email, blocked_account, stolen_credentials, enrollment_email, mfa_oob_code, user_invitation, change_password, password_reset, async_approval

urlLifetimeInSeconds · number | null

メール内のリンクの有効期間（秒）。

必須範囲: x >= 0

レスポンス

200

application/json

テンプレートが正常に更新されました。

body · string | null

メールテンプレートの本文。

enabled · boolean | null

テンプレートが有効（true）か無効（false）か。

from · string | null · デフォルト: [e-mail]

送信元の from メールアドレス。

includeEmailInRedirect · boolean

reset_email および verify_email テンプレートで、returnUrl に email パラメーターとしてユーザーのメールアドレスを含めるかどうか（true）、またはリダイレクトにメールアドレスを含めないかどうか（false）。既定値は true です。

resultUrl · string | null

アクションの成功後にユーザーをリダイレクトする URL。

subject · string | null

メールの件名。

syntax · string | null · デフォルト: liquid

テンプレート本文の構文。

template · enum<string> · デフォルト: verify_email

テンプレート名。verify_email、verify_email_by_code、reset_email、reset_email_by_code、welcome_email、blocked_account、stolen_credentials、enrollment_email、mfa_oob_code、user_invitation、async_approval、change_password（レガシー）、または password_reset（レガシー）を指定できます。

利用可能なオプション: verify_email, verify_email_by_code, reset_email, reset_email_by_code, welcome_email, blocked_account, stolen_credentials, enrollment_email, mfa_oob_code, user_invitation, change_password, password_reset, async_approval

urlLifetimeInSeconds · number | null

メール内のリンクの有効期間（秒）。

必須範囲: x >= 0