Skip to main content

Get the named template​

Retrieves the message template named in the path.

If a custom template was previously created, it will be returned. Otherwise the default template is returned

Likewise, any template fields were left empty during creation will be set to their default values.

Path Parameters
  • template_name string required

    Possible values: [email_authn_challenge, email_otp_message, text_authn_challenge, text_otp_message, email_password_reset, email_password_change_notify, text_password_reset, text_password_change_notify]

    Name of the template to retrieve or modify

Header Parameters
  • SlashID-OrgID string required

    The organization ID

    Example: af5fbd30-7ce7-4548-8b30-4cd59cb2aba1
Responses

OK

Schema
  • meta object
  • pagination object
  • limit integer
  • offset integer
  • total_count int64
  • cursor_pagination object

    Cursors are opaque. Follow the tokens the server returns; never construct, parse or modify one.

  • limit integer
  • next_cursor string

    Opaque token addressing the next page. Absent on the last page.

  • prev_cursor string

    Opaque token addressing the previous page. Absent on the first page.

  • last_cursor string

    Opaque token addressing the final page directly, so a client can jump to the end without a total count.

  • total_count int64

    Total number of matching items. Returned on the FIRST page only; clients cache it for the remainder of the walk.

  • errors object[]
  • httpcode integer
  • message string
  • result object

    Template for E-mail or SMS messages. Empty fields fall back to default value.

  • sender_name string

    Sender name (not address). Must be empty for SMS templates.

  • subject string

    E-mail subject. Must be empty for SMS templates.

  • body string

    Message body. Must be HTML for e-mail templates and plain text for SMS