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

• 200
• 400
• 404

---

OK

application/json

• Schema
• Example (from schema)

---

Schema

• meta object

  pagination object

  limit integer

  offset integer

  total_count int64
• 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

{
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total_count": 0
    }
  },
  "errors": [
    {
      "httpcode": 0,
      "message": "string"
    }
  ],
  "result": {
    "sender_name": "string",
    "subject": "string",
    "body": "string"
  }
}

Bad Request

application/json

• Schema
• Example (from schema)

---

Schema

• meta object

  pagination object

  limit integer

  offset integer

  total_count int64
• errors object[]

  httpcode integer

  message string

{
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total_count": 0
    }
  },
  "errors": [
    {
      "httpcode": 0,
      "message": "string"
    }
  ]
}

Not Found

application/json

• Schema
• Example (from schema)

---

Schema

• meta object

  pagination object

  limit integer

  offset integer

  total_count int64
• errors object[]

  httpcode integer

  message string

{
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total_count": 0
    }
  },
  "errors": [
    {
      "httpcode": 0,
      "message": "string"
    }
  ]
}