Email Templates

Retrieve an email template

Retrieves a single email template.

get/v4/email-templates/{slug}

Request

  • Base URL: https://demo.api.zephr.com
  • URL: https://demo.api.zephr.com/v4/email-templates/{slug}
  • Auth: HTTP zephr-hmac-*

Path parameters

slugstring required

Slug of the Email template

Response

OK

templateTypestring

The template type. Supported types: User Password Reset, User Email Update, User Email Verification, User Complete Registration, User Passwordless Authentication, User Oversubscription Notification, User 2FA Authentication, User 2FA Password Reset, User Email Update Interstitial, Pages User Email Update, Pages User Password Reset, Admin User 2FA Authentication, Admin User Role, Admin User Password Reset

slugstring

It can be one of the default email template slugs provided or a custom one. Default email template slugs provided: password-reset-email, user-update-email, verify-email-address, complete-user-registration, passwordless-authentication-email, user-oversubscription-notification, two-factor-authentication-email, password-reset-email-2fa, user-interstitial-update-email, pages-user-email-update-otp-email-template, pages-password-reset-email, admin-user-2fa-email-template, v4-admin-user-role-assigned-email, v4-admin-user-password-reset-email.

labelstring

Name of the email template

subjectstring

The subject on the email

contentstring

The content of the email

defaultboolean

Whether is one of the default email templates

Example response

{
  "templateType": "template type",
  "slug": "email template slug",
  "label": "Name of the email template",
  "subject": "Email subject",
  "content": "Email content"
}

Changes

No recorded changes to this operation across all 1 revision of this API.