Update Enrollment and Verification Phone Templates

Customize the messages sent to complete phone enrollment and verification (subscription required).

PUT https://{tenantDomain}/api/v2/guardian/factors/phone/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.SetGuardianFactorPhoneTemplatesRequestContent{
        EnrollmentMessage: "enrollment_message",
        VerificationMessage: "verification_message",
    }
    client.Guardian.Factors.Phone.SetTemplates(
        context.TODO(),
        request,
    )
}

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

Phone 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.