Mettre à jour un modèle de courriel par nom de modèle

Mettre à jour un modèle de courriel.

PUT 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.SetEmailTemplateRequestContent{
        Template: management.EmailTemplateNameEnumVerifyEmail,
    }
    client.EmailTemplates.Set(
        context.TODO(),
        management.EmailTemplateNameEnumVerifyEmail.Ptr(),
        request,
    )
}

200

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

Autorisations

bearerAuthoAuth2ClientCredentials

Authorization · string · header · requis

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

Paramètres de chemin

templateName · enum<string> · défaut: verify_email · requis

Nom du modèle. Peut être 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 (ancien) ou password_reset (ancien).

Options disponibles: 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

Corps

application/jsonapplication/x-www-form-urlencoded

body · string | null · requis

Corps du modèle de courriel.

enabled · boolean | null · requis

Indique si le modèle est activé (true) ou désactivé (false).

from · string | null · défaut: [e-mail] · requis

Adresse de courriel from de l’expéditeur.

subject · string | null · requis

Objet du courriel.

syntax · string | null · défaut: liquid · requis

Syntaxe du corps du modèle.

template · enum<string> · défaut: verify_email · requis

Nom du modèle. Peut être 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 (ancien) ou password_reset (ancien).

Options disponibles: 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

includeEmailInRedirect · boolean

Indique si les modèles reset_email et verify_email doivent inclure l'adresse de courriel de l'utilisateur comme paramètre email dans le returnUrl (true), ou si aucune adresse de courriel ne doit être incluse dans la redirection (false). La valeur par défaut est true.

resultUrl · string | null

URL vers laquelle rediriger l’utilisateur après une action réussie.

urlLifetimeInSeconds · number | null

Durée de validité, en secondes, du lien contenu dans le courriel.

Plage requise: x >= 0

Réponse

200

application/json

Modèle mis à jour avec succès.

body · string | null · requis

Corps du modèle de courriel.

enabled · boolean | null · requis

Indique si le modèle est activé (true) ou désactivé (false).

from · string | null · défaut: [e-mail] · requis

Adresse de courriel d'expédition (from).

subject · string | null · requis

Objet du courriel.

syntax · string | null · défaut: liquid · requis

Syntaxe du corps du modèle.

template · enum<string> · défaut: verify_email · requis

Nom du modèle. Peut être 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 (ancien) ou password_reset (ancien).

Options disponibles: 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

includeEmailInRedirect · boolean

Indique si les modèles reset_email et verify_email doivent inclure l'adresse de courriel de l'utilisateur comme paramètre email dans le returnUrl (true), ou si aucune adresse de courriel ne doit être incluse dans la redirection (false). La valeur par défaut est true.

resultUrl · string | null

URL vers laquelle rediriger l'utilisateur après une action réussie.

urlLifetimeInSeconds · number | null

Durée de validité, en secondes, du lien contenu dans le courriel.

Plage requise: x >= 0