Actualizar parcialmente las plantillas de correo electrónico por nombre de plantilla

Modificar una plantilla de correo electrónico.

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,
    )
}

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.emailTemplates.update("verify_email", {});
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.emailTemplates.update("verify_email", {});
}
main();

curl --request PATCH \
  --url https://{tenantDomain}/api/v2/email-templates/{templateName} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "body": "<string>",
  "enabled": true,
  "from": "[e-mail]",
  "includeEmailInRedirect": true,
  "resultUrl": "<string>",
  "subject": "<string>",
  "syntax": "liquid",
  "template": "verify_email",
  "urlLifetimeInSeconds": 1
}
'

import requests

url = "https://{tenantDomain}/api/v2/email-templates/{templateName}"

payload = {
    "body": "<string>",
    "enabled": True,
    "from": "[e-mail]",
    "includeEmailInRedirect": True,
    "resultUrl": "<string>",
    "subject": "<string>",
    "syntax": "liquid",
    "template": "verify_email",
    "urlLifetimeInSeconds": 1
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{tenantDomain}/api/v2/email-templates/{templateName}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'body' => '<string>',
    'enabled' => true,
    'from' => '[e-mail]',
    'includeEmailInRedirect' => true,
    'resultUrl' => '<string>',
    'subject' => '<string>',
    'syntax' => 'liquid',
    'template' => 'verify_email',
    'urlLifetimeInSeconds' => 1
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

HttpResponse<String> response = Unirest.patch("https://{tenantDomain}/api/v2/email-templates/{templateName}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"body\": \"<string>\",\n  \"enabled\": true,\n  \"from\": \"[e-mail]\",\n  \"includeEmailInRedirect\": true,\n  \"resultUrl\": \"<string>\",\n  \"subject\": \"<string>\",\n  \"syntax\": \"liquid\",\n  \"template\": \"verify_email\",\n  \"urlLifetimeInSeconds\": 1\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenantDomain}/api/v2/email-templates/{templateName}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"body\": \"<string>\",\n  \"enabled\": true,\n  \"from\": \"[e-mail]\",\n  \"includeEmailInRedirect\": true,\n  \"resultUrl\": \"<string>\",\n  \"subject\": \"<string>\",\n  \"syntax\": \"liquid\",\n  \"template\": \"verify_email\",\n  \"urlLifetimeInSeconds\": 1\n}"

response = http.request(request)
puts response.read_body

200

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

Autorizaciones

bearerAuthoAuth2ClientCredentials

Authorization · string · header · requerido

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

Parámetros de ruta

templateName · enum<string> · predeterminado: verify_email · requerido

Nombre de la plantilla. Puede ser 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 (legado) o password_reset (legado).

Opciones 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

Cuerpo

application/jsonapplication/x-www-form-urlencoded

body · string | null

Cuerpo de la plantilla de correo electrónico.

enabled · boolean | null

Indica si la plantilla está habilitada (true) o deshabilitada (false).

from · string | null · predeterminado: [e-mail]

Dirección de correo electrónico from del remitente.

includeEmailInRedirect · boolean

Indica si las plantillas reset_email y verify_email deben incluir la dirección de correo electrónico del usuario como parámetro email en la returnUrl (true) o si no debe incluirse ninguna dirección de correo electrónico en la redirección (false). El valor predeterminado es true.

resultUrl · string | null

URL a la que se redirigirá al usuario después de una acción correcta.

subject · string | null

Asunto del correo electrónico.

syntax · string | null · predeterminado: liquid

Sintaxis del cuerpo de la plantilla.

template · enum<string> · predeterminado: verify_email

Nombre de la plantilla. Puede ser 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 (legado) o password_reset (legado).

Opciones 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

urlLifetimeInSeconds · number | null

Duración, en segundos, durante la que será válido el enlace incluido en el correo electrónico.

Rango requerido: x >= 0

Respuesta

200

application/json

Plantilla actualizada correctamente.

body · string | null

Cuerpo de la plantilla de correo electrónico.

enabled · boolean | null

Indica si la plantilla está habilitada (true) o deshabilitada (false).

from · string | null · predeterminado: [e-mail]

Dirección de correo electrónico del remitente (from).

includeEmailInRedirect · boolean

Indica si las plantillas reset_email y verify_email deben incluir la dirección de correo electrónico del usuario como parámetro email en la returnUrl (true) o si no debe incluirse ninguna dirección de correo electrónico en la redirección (false). El valor predeterminado es true.

resultUrl · string | null

URL a la que redirigir al usuario después de que la acción se complete correctamente.

subject · string | null

Asunto del correo electrónico.

syntax · string | null · predeterminado: liquid

Sintaxis del cuerpo de la plantilla.

template · enum<string> · predeterminado: verify_email

Nombre de la plantilla. Puede ser 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 (legado) o password_reset (legado).

Opciones 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

urlLifetimeInSeconds · number | null

Duración, en segundos, durante la que el enlace incluido en el correo electrónico será válido.

Rango requerido: x >= 0