FusionAuth developer image
FusionAuth developer logo
  • Back to site
  • Expert Advice
  • Blog
  • Developers
  • Downloads
  • Account
  • Contact sales
Navigate to...
  • Welcome
  • Getting Started
    • Getting Started
    • 5-minute Setup Guide
      • Overview
      • Docker
      • Fast Path
      • Sandbox
    • Setup Wizard & First Login
    • Register a User and Login
    • Self-service Registration
    • Start and Stop FusionAuth
    • Core Concepts
      • Overview
      • Users
      • Roles
      • Groups
      • Registrations
      • Applications
      • Tenants
      • Identity Providers
      • Authentication/Authorization
      • Integration Points
    • Example Apps
      • Overview
      • Dart
      • Go
      • Java
      • JavaScript
      • .NET Core
      • PHP
      • Python
      • Ruby
    • Tutorials
  • Installation Guide
    • Overview
    • System Requirements
    • Server Layout
    • Cloud
    • Cluster
    • Docker
    • Fast Path
    • Kubernetes
      • Overview
      • Deployment Guide
      • Minikube Setup
      • Amazon EKS Setup
      • Google GKE Setup
      • Microsoft AKS Setup
    • Kickstart™
    • Homebrew
    • Marketplaces
    • Packages
    • Database
    • FusionAuth App
    • FusionAuth Search
    • Common Configuration
  • Migration Guide
    • Overview
    • General
    • Auth0
    • Keycloak
    • Amazon Cognito
    • Firebase
    • Microsoft Azure AD B2C
    • Tutorial
  • Admin Guide
    • Overview
    • Account Portal
    • Config Management
    • Editions and Features
    • Key Rotation
    • Licensing
    • Monitoring
    • Prometheus Setup
    • Proxy Setup
    • Reference
      • Overview
      • Configuration
      • CORS
      • Data Types
      • Hosted Login Pages Cookies
      • Known Limitations
      • Password Hashes
    • Releases
    • Roadmap
    • Search And FusionAuth
    • Securing
    • Switch Search Engines
    • Technical Support
    • Troubleshooting
    • Upgrading
    • WebAuthn
  • Login Methods
    • Identity Providers
      • Overview
      • Apple
      • Epic Games
      • External JWT
        • Overview
        • Example
      • Facebook
      • Google
      • HYPR
      • LinkedIn
      • Nintendo
      • OpenID Connect
        • Overview
        • Amazon Cognito
        • Azure AD
        • Discord
        • Github
      • Sony PlayStation Network
      • Steam
      • Twitch
      • Twitter
      • SAML v2
        • Overview
        • ADFS
        • Azure AD
      • SAML v2 IdP Initiated
        • Overview
        • Okta
      • Xbox
    • OIDC & OAuth 2.0
      • Overview
      • Endpoints
      • Tokens
      • OAuth Modes
    • Passwordless
      • Overview
      • Magic Links
      • WebAuthn & Passkeys
    • SAML v2 IdP
      • Overview
      • Google
      • Zendesk
  • Developer Guide
    • Overview
    • API Gateways
      • Overview
      • ngrok Cloud Edge
    • Client Libraries & SDKs
      • Overview
      • Dart
      • Go
      • Java
      • JavaScript
      • .NET Core
      • Node
      • OpenAPI
      • PHP
      • Python
      • React
      • Ruby
      • Typescript
    • Events & Webhooks
      • Overview
      • Writing a Webhook
      • Securing Webhooks
      • Events
        • Overview
        • Audit Log Create
        • Event Log Create
        • JWT Public Key Update
        • JWT Refresh
        • JWT Refresh Token Revoke
        • Kickstart Success
        • Group Create
        • Group Create Complete
        • Group Delete
        • Group Delete Complete
        • Group Update
        • Group Update Complete
        • Group Member Add
        • Group Member Add Complete
        • Group Member Remove
        • Group Member Remove Complete
        • Group Member Update
        • Group Member Update Complete
        • User Action
        • User Bulk Create
        • User Create
        • User Create Complete
        • User Deactivate
        • User Delete
        • User Delete Complete
        • User Email Update
        • User Email Verified
        • User IdP Link
        • User IdP Unlink
        • User Login Failed
        • User Login Id Dup. Create
        • User Login Id Dup. Update
        • User Login New Device
        • User Login Success
        • User Login Suspicious
        • User Password Breach
        • User Password Reset Send
        • User Password Reset Start
        • User Password Reset Success
        • User Password Update
        • User Reactivate
        • User Reg. Create
        • User Reg. Create Complete
        • User Reg. Delete
        • User Reg. Delete Complete
        • User Registration Update
        • User Reg. Update Complete
        • User Reg. Verified
        • User 2FA Method Add
        • User 2FA Method Remove
        • User Update
        • User Update Complete
    • Guides
      • Overview
      • Authentication Tokens
      • Exposing A Local Instance
      • JSON Web Tokens
      • Key Master
      • Localization and Internationalization
      • Multi-Factor Authentication
      • Multi-Tenant
      • Passwordless
      • Registration-based Email Verification
      • Searching With Elasticsearch
      • Securing Your APIs
      • Silent Mode
      • Single Sign-on
      • Two Factor (pre 1.26)
    • Integrations
      • Overview
      • CleanSpeak
      • Kafka
      • Twilio
    • Plugins
      • Overview
      • Writing a Plugin
      • Custom Password Hashing
    • User Control & Gating
      • Overview
      • Gate Unverified Users
      • Gate Unverified Registrations
      • User Account Lockout
  • Customization
    • Email & Templates
      • Overview
      • Configure Email
      • Email Templates
      • Email Variables
      • Message Templates
    • Lambdas
      • Overview
      • Apple Reconcile
      • Client Cred. JWT Populate
      • Epic Games Reconcile
      • External JWT Reconcile
      • Facebook Reconcile
      • Google Reconcile
      • HYPR Reconcile
      • JWT Populate
      • LDAP Connector Reconcile
      • LinkedIn Reconcile
      • Nintendo Reconcile
      • OpenID Connect Reconcile
      • SAML v2 Populate
      • SAML v2 Reconcile
      • SCIM Group Req. Converter
      • SCIM Group Resp. Convtr.
      • SCIM User Req. Converter
      • SCIM User Resp. Converter
      • Sony PSN Reconcile
      • Steam Reconcile
      • Twitch Reconcile
      • Twitter Reconcile
      • Xbox Reconcile
    • Messengers
      • Overview
      • Generic Messenger
      • Twilio Messenger
    • Themes
      • Overview
      • Examples
      • Helpers
      • Localization
      • Template Variables
  • Premium Features
    • Overview
    • Advanced Registration Forms
    • Advanced Threat Detection
    • Application Specific Themes
    • Breached Password Detection
    • Connectors
      • Overview
      • Generic Connector
      • LDAP Connector
      • FusionAuth Connector
    • Entity Management
    • SCIM
      • Overview
      • Azure AD Client
      • Okta Client
      • SCIM-SDK
    • Self Service Account Mgmt
      • Overview
      • Updating User Data & Password
      • Add Two-Factor Authenticator
      • Add Two-Factor Email
      • Add Two-Factor SMS
      • Add WebAuthn Passkey
      • Customizing
      • Troubleshooting
    • WebAuthn
  • APIs
    • Overview
    • Authentication
    • Errors
    • API Explorer
    • Actioning Users
    • API Keys
    • Applications
    • Audit Logs
    • Connectors
      • Overview
      • Generic
      • LDAP
    • Consents
    • Emails
    • Entity Management
      • Overview
      • Entities
      • Entity Types
      • Grants
    • Event Logs
    • Families
    • Forms
    • Form Fields
    • Groups
    • Identity Providers
      • Overview
      • Links
      • Apple
      • External JWT
      • Epic Games
      • Facebook
      • Google
      • HYPR
      • LinkedIn
      • Nintendo
      • OpenID Connect
      • SAML v2
      • SAML v2 IdP Initiated
      • Sony PlayStation Network
      • Steam
      • Twitch
      • Twitter
      • Xbox
    • Integrations
    • IP Access Control Lists
    • JWT
    • Keys
    • Lambdas
    • Login
    • Message Templates
    • Messengers
      • Overview
      • Generic
      • Twilio
    • Multi-Factor/Two Factor
    • Passwordless
    • Reactor
    • Registrations
    • Reports
    • SCIM
      • Overview
      • SCIM User
      • SCIM Group
      • SCIM EnterpriseUser
      • SCIM Service Provider Config.
    • System
    • Tenants
    • Themes
    • Users
    • User Actions
    • User Action Reasons
    • User Comments
    • WebAuthn
    • Webhooks
  • Release Notes

    Message Template APIs

    Overview

    This API has been available since 1.26.0

    This page contains the APIs for managing Message Templates as well as messaging users using those templates. Here are the APIs:

    • Create a Message Template

    • Retrieve a Message Template

    • Update a Message Template

    • Delete a Message Template

    • Preview a Message Template

    Create a Message Template

    This API is used to create a Message Template. Specifying an Id on the URI will instruct FusionAuth to use that Id when creating the Message Template. Otherwise, FusionAuth will generate an Id for the Message Template.

    Request

    Create a Message Template without providing an Id. An Id will be automatically generated.

    URI

    POST /api/message/template

    Create a Message Template with the provided Id

    URI

    POST /api/message/template/{messageTemplateId}

    Request Parameters

    messageTemplateId [UUID] Optional defaults to secure random UUID

    The Id to use for the new Message Template. If not specified a secure random UUID will be generated.

    Request Body

    messageTemplate.data [Object] Optional

    An object that can hold any information about the Message Template that should be persisted.

    messageTemplate.defaultTemplate [String (FreeMarker Enabled)] Required

    The default Message Template.

    messageTemplate.localizedTemplates [Map<Locale,String (FreeMarker Enabled)>] Optional

    The Message Template used when sending messages to users who speak other languages. This overrides the default Message Template based on the user’s list of preferred languages.

    messageTemplate.name [String] Required

    A descriptive name for the Message Template (i.e. "Two Factor Code Message")

    messageTemplate.type [String] Required

    The type of the template. This must have the value SMS.

    Example Request JSON
    
    {
      "messageTemplate": {
        "data": {
          "updatedBy": "richard@fusionauth.io"
        }
        "defaultTemplate": "Here's your Two Factor Code: ${code}",
        "localizedTemplates": {
          "de": "Hier ist Ihr Zwei-Faktoren-Code: ${code}",
          "es": "Este es su código de dos factores: ${code}"
        },
        "name": "Default Two Factor Request",
        "type": "SMS"
      }
    }

    Response

    The response for this API contains the information for the Message Template that was created.

    Table 1. Response Codes
    Code Description

    200

    The request was successful. The response will contain a JSON body.

    400

    The request was invalid and/or malformed. The response will contain an Errors JSON Object with the specific errors. This status will also be returned if a paid FusionAuth license is required and is not present.

    401

    You did not supply a valid Authorization header. The header was omitted or your API key was not valid. The response will be empty. See Authentication.

    500

    There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty.

    Response Body

    messageTemplate.data [Object]

    An object that can hold any information about the Message Template that should be persisted.

    messageTemplate.defaultTemplate [String (FreeMarker Enabled)]

    The default Message Template.

    messageTemplate.id [UUID]

    The unique identifier for this Message Template.

    messageTemplate.insertInstant [Long]

    The instant that the Application was added to the FusionAuth database.

    messageTemplate.lastUpdateInstant [Long]

    The instant that the Application was last updated in the FusionAuth database.

    messageTemplate.localizedTemplates [Map<Locale,String (FreeMarker Enabled)>]

    The Message Template used when sending messages to users who speak other languages. This overrides the default Message Template based on the user’s list of preferred languages.

    messageTemplate.name [String]

    A descriptive name for the message template.

    messageTemplate.type [String]

    The type of the template. This will have the value SMS.

    Example Response JSON for a Single Message Template
    
    {
      "messageTemplate": {
        "data": {
          "updatedBy": "richard@fusionauth.io"
        }
        "id": "da6edb51-3d1b-40cf-b791-43b657536621",
        "insertInstant": 1619822235060,
        "lastUpdateInstant": 1619822235060,
        "defaultTemplate": "Here's your Two Factor Code: ${code}",
        "localizedTemplates": {
          "de": "Hier ist Ihr Zwei-Faktoren-Code: ${code}",
          "es": "Este es su código de dos factores: ${code}"
        },
        "name": "Default Two Factor Request",
        "type": "SMS"
      }
    }

    Retrieve a Message Template

    This API is used to retrieve one or all of the configured Message Templates. Specifying an Id on the URI will retrieve a single Message Template. Leaving off the Id will retrieve all of the Message Templates.

    Request

    Retrieve all of the Message Templates

    URI

    GET /api/message/template

    Retrieve a single Message Template by Id

    URI

    GET /api/message/template/{messageTemplateId}

    Request Parameters

    messageTemplateId [UUID] Optional

    The Id of the Message Template to retrieve.

    Response

    The response for this API contains either a single Message Template or all of the Message Templates. When you call this API with an Id the response will contain just that Message Template. When you call this API without an Id the response will contain all of the Message Templates. Both response types are defined below along with an example JSON response.

    Table 2. Response Codes
    Code Description

    200

    The request was successful. The response will contain a JSON body.

    401

    You did not supply a valid Authorization header. The header was omitted or your API key was not valid. The response will be empty. See Authentication.

    404

    The object you requested doesn’t exist. The response will be empty.

    500

    There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty.

    Response Body

    messageTemplate.data [Object]

    An object that can hold any information about the Message Template that should be persisted.

    messageTemplate.defaultTemplate [String (FreeMarker Enabled)]

    The default Message Template.

    messageTemplate.id [UUID]

    The unique identifier for this Message Template.

    messageTemplate.insertInstant [Long]

    The instant that the Application was added to the FusionAuth database.

    messageTemplate.lastUpdateInstant [Long]

    The instant that the Application was last updated in the FusionAuth database.

    messageTemplate.localizedTemplates [Map<Locale,String (FreeMarker Enabled)>]

    The Message Template used when sending messages to users who speak other languages. This overrides the default Message Template based on the user’s list of preferred languages.

    messageTemplate.name [String]

    A descriptive name for the message template.

    messageTemplate.type [String]

    The type of the template. This will have the value SMS.

    Example Response JSON for a Single Message Template
    
    {
      "messageTemplate": {
        "data": {
          "updatedBy": "richard@fusionauth.io"
        }
        "id": "da6edb51-3d1b-40cf-b791-43b657536621",
        "insertInstant": 1619822235060,
        "lastUpdateInstant": 1619822235060,
        "defaultTemplate": "Here's your Two Factor Code: ${code}",
        "localizedTemplates": {
          "de": "Hier ist Ihr Zwei-Faktoren-Code: ${code}",
          "es": "Este es su código de dos factores: ${code}"
        },
        "name": "Default Two Factor Request",
        "type": "SMS"
      }
    }

    Response Body

    messageTemplates[x].data [Object]

    An object that can hold any information about the Message Template that should be persisted.

    messageTemplates[x].defaultTemplate [String (FreeMarker Enabled)]

    The default Message Template.

    messageTemplates[x].id [UUID]

    The unique identifier for this Message Template.

    messageTemplates[x].insertInstant [Long]

    The instant that the Application was added to the FusionAuth database.

    messageTemplates[x].lastUpdateInstant [Long]

    The instant that the Application was last updated in the FusionAuth database.

    messageTemplates[x].localizedTemplates [Map<Locale,String (FreeMarker Enabled)>]

    The Message Template used when sending messages to users who speak other languages. This overrides the default Message Template based on the user’s list of preferred languages.

    messageTemplates[x].name [String]

    A descriptive name for the message template.

    messageTemplates[x].type [String]

    The type of the template. This will have the value SMS.

    Example Response JSON for all Message Templates
    
    {
      "messageTemplates": [
        {
          "data": {
            "updatedBy": "richard@fusionauth.io"
          }
          "id": "da6edb51-3d1b-40cf-b791-43b657536621",
          "insertInstant": 1619822235060,
          "lastUpdateInstant": 1619822235060,
          "defaultTemplate": "Here's your Two Factor Code: ${code}",
          "localizedTemplates": {
            "de": "Hier ist Ihr Zwei-Faktoren-Code: ${code}",
            "es": "Este es su código de dos factores: ${code}"
          },
          "name": "Default Two Factor Request",
          "type": "SMS"
        }
      ]
    }

    Update a Message Template

    This API is used to update an existing Message Template.

    You must specify the Id of the Message Template you are updating on the URI.

    You must specify all of the properties of the Message Template when calling this API with the PUT HTTP method. When used with PUT, this API doesn’t merge the existing Message Template and your new data. It replaces the existing Message Template with your new data.

    Utilize the PATCH HTTP method to send specific changes to merge into an existing Message Template.

    Request

    Update a Message Template by Id

    URI

    PUT /api/message/template/{messageTemplateId}

    PATCH /api/message/template/{messageTemplateId}

    Available since 1.39.0

    When using the PATCH method, you can either use the same request body documentation that is provided for the PUT request for backward compatibility. Or you may use either JSON Patch/RFC 6902 or JSON Merge Patch/RFC 7396. See the PATCH documentation for more information.

    Available since 1.12.0

    When using the PATCH method, use the same request body documentation that is provided for the PUT request. The PATCH method will merge the provided request parameters into the existing object, this means all parameters are optional when using the PATCH method and you only provide the values you want changed. A null value can be used to remove a value. Patching an Array will result in all values from the new list being appended to the existing list, this is a known limitation to the current implementation of PATCH.

     

    Request Parameters

    messageTemplateId [UUID] Required

    The Id of the Message Template to update.

    Request Body

    messageTemplate.data [Object] Optional

    An object that can hold any information about the Message Template that should be persisted.

    messageTemplate.defaultTemplate [String (FreeMarker Enabled)] Required

    The default Message Template.

    messageTemplate.localizedTemplates [Map<Locale,String (FreeMarker Enabled)>] Optional

    The Message Template used when sending messages to users who speak other languages. This overrides the default Message Template based on the user’s list of preferred languages.

    messageTemplate.name [String] Required

    A descriptive name for the Message Template (i.e. "Two Factor Code Message")

    messageTemplate.type [String] Required

    The type of the template. This must have the value SMS.

    Example Request JSON
    
    {
      "messageTemplate": {
        "data": {
          "updatedBy": "richard@fusionauth.io"
        }
        "defaultTemplate": "Here's your Two Factor Code: ${code}",
        "localizedTemplates": {
          "de": "Hier ist Ihr Zwei-Faktoren-Code: ${code}",
          "es": "Este es su código de dos factores: ${code}"
        },
        "name": "Default Two Factor Request",
        "type": "SMS"
      }
    }

    Response

    The response for this API contains the new information for the Message Template that was updated.

    Table 3. Response Codes
    Code Description

    200

    The request was successful. The response will contain a JSON body.

    400

    The request was invalid and/or malformed. The response will contain an Errors JSON Object with the specific errors. This status will also be returned if a paid FusionAuth license is required and is not present.

    401

    You did not supply a valid Authorization header. The header was omitted or your API key was not valid. The response will be empty. See Authentication.

    404

    The object you are trying to update doesn’t exist. The response will be empty.

    500

    There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty.

    Response Body

    messageTemplate.data [Object]

    An object that can hold any information about the Message Template that should be persisted.

    messageTemplate.defaultTemplate [String (FreeMarker Enabled)]

    The default Message Template.

    messageTemplate.id [UUID]

    The unique identifier for this Message Template.

    messageTemplate.insertInstant [Long]

    The instant that the Application was added to the FusionAuth database.

    messageTemplate.lastUpdateInstant [Long]

    The instant that the Application was last updated in the FusionAuth database.

    messageTemplate.localizedTemplates [Map<Locale,String (FreeMarker Enabled)>]

    The Message Template used when sending messages to users who speak other languages. This overrides the default Message Template based on the user’s list of preferred languages.

    messageTemplate.name [String]

    A descriptive name for the message template.

    messageTemplate.type [String]

    The type of the template. This will have the value SMS.

    Example Response JSON for a Single Message Template
    
    {
      "messageTemplate": {
        "data": {
          "updatedBy": "richard@fusionauth.io"
        }
        "id": "da6edb51-3d1b-40cf-b791-43b657536621",
        "insertInstant": 1619822235060,
        "lastUpdateInstant": 1619822235060,
        "defaultTemplate": "Here's your Two Factor Code: ${code}",
        "localizedTemplates": {
          "de": "Hier ist Ihr Zwei-Faktoren-Code: ${code}",
          "es": "Este es su código de dos factores: ${code}"
        },
        "name": "Default Two Factor Request",
        "type": "SMS"
      }
    }

    Delete a Message Template

    This API is used to delete a Message Template. You must specify the Id of the Message Template on the URI.

    Request

    Delete a Message Template By Id

    URI

    DELETE /api/message/template/{messageTemplateId}

    Request Parameters

    messageTemplateId [UUID] Required

    The Id of the Message Template to delete.

    Response

    This API does not return a JSON response body.

    Table 4. Response Codes
    Code Description

    200

    The request was successful. The response will be empty.

    400

    The request was invalid and/or malformed. The response will contain an Errors JSON Object with the specific errors. This status will also be returned if a paid FusionAuth license is required and is not present.

    401

    You did not supply a valid Authorization header. The header was omitted or your API key was not valid. The response will be empty. See Authentication.

    404

    The object you are trying to delete doesn’t exist. The response will be empty.

    500

    There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty.

    Preview a Message Template

    This API is used to preview a Message Template. You pass all of the information for the Message Template in the request and a rendered version of the Message is sent back to you in the response.

    FusionAuth provides sample values for the ${code} and ${user} objects when previewing. The value for ${code} will always be 123456.

    The Message Template in the request does not need to be completely filled out. You can send in a partial Message Template and the response will contain only what you provided.

    Request

    Preview a Message Template

    URI

    POST /api/message/template/preview

    Request Body

    locale [Locale] Optional

    The locale to use when rendering the Message Template. If this is null or omitted, the defaults will be used and the localized versions will be ignored.

    messageTemplate.defaultTemplate [String (FreeMarker Enabled)] Required

    The default Message Template to preview.

    messageTemplate.localizedTemplates [Map<Locale,String (FreeMarker Enabled)>] Optional

    The Message Template used when sending messages to users who speak other languages. This overrides the default Message Template based on the locale string passed.

    messageTemplate.type [String] Required

    The type of the template. This must be the value SMS.

    Example Preview Request JSON
    
    {
      "messageTemplate": {
        "defaultTemplate" : "Your code is: ${code}",
        "localizedTemplates": {
          "de": "Hier ist Ihr Zwei-Faktoren-Code: ${code}"
        },
        "type": "SMS"
      },
      "locale":"en"
    }

    Response

    The response for this API contains the rendered Message and also an Errors that contains any rendering issues FusionAuth found. The template might have syntax or logic errors and FusionAuth will put these errors into the response.

    Table 5. Response Codes
    Code Description

    200

    The request was successful. The response will contain a JSON body.

    400

    The request was invalid and/or malformed. The response will contain an Errors JSON Object with the specific errors. This status will also be returned if a paid FusionAuth license is required and is not present.

    401

    You did not supply a valid Authorization header. The header was omitted or your API key was not valid. The response will be empty. See Authentication.

    500

    There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty.

    Response Body

    message.textMessage [String]

    The message text.

    message.type [String]

    The type of the message. This will always be SMS.

    email.errors [Errors]

    An Errors object that contains any errors in the Message Template.

    Example Successful Response JSON
    
    {
      "errors":{},
      "message":{
        "textMessage": "Your code is: 123456",
        "type":"SMS"
      }
    }
    Example Errors Response JSON
    
    {
      "errors": {
        "fieldErrors":{
          "messageTemplate.defaultTemplate": [
            {
              "code":"[invalidTemplate]messageTemplate.defaultTemplate",
              "message":"Freemarker processing error: [Syntax error in nameless template in line 1, column 14:\nUnexpected end of file reached. You have an unclosed \"{\".]"
            }
          ]
        }
      },
      "message": {
        "type":"SMS"
      }
    }

    Feedback

    How helpful was this page?

    See a problem?

    File an issue in our docs repo

    Have a question or comment to share?

    Visit the FusionAuth community forum.

    © 2023 FusionAuth
    Subscribe for developer updates