Update SMS enrollment and verification templates

This endpoint has been deprecated. To complete this action, use the Update enrollment and verification phone templates endpoint instead.

Previous functionality: Customize the messages sent to complete SMS enrollment and verification.

PUT https://{tenantDomain}/api/v2/guardian/factors/sms/templates

Go

Go

package example

import (
    context "context"

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

func do() {
    client := client.NewClient(
        option.WithToken(
            "<token>",
        ),
    )
    request := &factors.SetGuardianFactorSmsTemplatesRequestContent{
        EnrollmentMessage: "enrollment_message",
        VerificationMessage: "verification_message",
    }
    client.Guardian.Factors.Sms.SetTemplates(
        context.TODO(),
        request,
    )
}

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.guardian.factors.sms.setTemplates({
        enrollmentMessage: "enrollment_message",
        verificationMessage: "verification_message",
    });
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        token: "<token>",
    });
    await client.guardian.factors.sms.setTemplates({
        enrollmentMessage: "enrollment_message",
        verificationMessage: "verification_message",
    });
}
main();

curl --request PUT \
  --url https://{tenantDomain}/api/v2/guardian/factors/sms/templates \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "enrollment_message": "{{code}} is your verification code for {{tenant.friendly_name}}. Please enter this code to verify your enrollment.",
  "verification_message": "{{code}} is your verification code for {{tenant.friendly_name}}"
}
'

import requests

url = "https://{tenantDomain}/api/v2/guardian/factors/sms/templates"

payload = {
    "enrollment_message": "{{code}} is your verification code for {{tenant.friendly_name}}. Please enter this code to verify your enrollment.",
    "verification_message": "{{code}} is your verification code for {{tenant.friendly_name}}"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{tenantDomain}/api/v2/guardian/factors/sms/templates",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'enrollment_message' => '{{code}} is your verification code for {{tenant.friendly_name}}. Please enter this code to verify your enrollment.',
    'verification_message' => '{{code}} is your verification code for {{tenant.friendly_name}}'
  ]),
  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.put("https://{tenantDomain}/api/v2/guardian/factors/sms/templates")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"enrollment_message\": \"{{code}} is your verification code for {{tenant.friendly_name}}. Please enter this code to verify your enrollment.\",\n  \"verification_message\": \"{{code}} is your verification code for {{tenant.friendly_name}}\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenantDomain}/api/v2/guardian/factors/sms/templates")

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

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"enrollment_message\": \"{{code}} is your verification code for {{tenant.friendly_name}}. Please enter this code to verify your enrollment.\",\n  \"verification_message\": \"{{code}} is your verification code for {{tenant.friendly_name}}\"\n}"

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

200

{
  "enrollment_message": "{{code}} is your verification code for {{tenant.friendly_name}}. Please enter this code to verify your enrollment.",
  "verification_message": "{{code}} is your verification code for {{tenant.friendly_name}}"
}

Authorizations

bearerAuthoAuth2ClientCredentials

Authorization · string · header · required

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

Body

application/jsonapplication/x-www-form-urlencoded

enrollment_message · string · default: {{code}} is your verification code for {{tenant.friendly_name}}. Please enter this code to verify your enrollment. · required

Message sent to the user when they are invited to enroll with a phone number.

verification_message · string · default: {{code}} is your verification code for {{tenant.friendly_name}} · required

Message sent to the user when they are prompted to verify their account.

Response

200

application/json

SMS enrollment and verification templates successfully updated.

enrollment_message · string · default: {{code}} is your verification code for {{tenant.friendly_name}}. Please enter this code to verify your enrollment. · required

Message sent to the user when they are invited to enroll with a phone number.

verification_message · string · default: {{code}} is your verification code for {{tenant.friendly_name}} · required

Message sent to the user when they are prompted to verify their account.