Emails. Done.

Template Stable

Verify email

Sent when a user needs to verify an email address.

verify-email - security

v1
authentication Stable Latest stable

Verify email v1

verify-email - v1

Subject: Verify your email address

Preheader: Confirm your email address to finish setting up your account.

Required fields

Name Type Required Description Example
actionButton.url url Yes Action Button URL
Max 2048 characters		 https://example.com/verify

Optional fields

Name Type Required Description Example
actionButton.label text No Action Button Label
Max 120 characters		 Verify email
footerNote text No Footer Note
Max 1000 characters		 If you did not create an account, you can safely ignore this email.
heading text No Heading
Max 180 characters		 Verify your email
intro text No Intro
Max 1000 characters		 Please confirm your email address to finish setting up your account.
preheader text No Preheader
Max 220 characters		 Confirm your email address to finish setting up your account.
securityNote text No Security Note
Max 1000 characters		 Verifying your email helps keep your account secure and ensures you can receive important notifications.
subject text No Subject
Max 180 characters		 Verify your email address

Defaults

{
  "actionButton.label": "Verify email",
  "footerNote": "If you did not create an account, you can safely ignore this email.",
  "heading": "Verify your email",
  "intro": "Please confirm your email address to finish setting up your account.",
  "preheader": "Confirm your email address to finish setting up your account.",
  "securityNote": "Verifying your email helps keep your account secure and ensures you can receive important notifications.",
  "subject": "Verify your email address"
}

Example data

{
  "templateId": "verify-email",
  "data": {
    "actionButton": {
      "url": "https://example.com/verify"
    }
  }
}

Template messages

TypeCodeMessage
Return accepted Valid template data can be queued by the send endpoint.
Error missing_required_variable Action Button URL is required.
Error field_too_long Action Button URL must be 2048 characters or fewer.
Error invalid_url Action Button URL must be a valid http or https URL.
Error field_too_long Action Button Label must be 120 characters or fewer.
Error field_too_long Footer Note must be 1000 characters or fewer.
Error field_too_long Heading must be 180 characters or fewer.
Error field_too_long Intro must be 1000 characters or fewer.
Error field_too_long Preheader must be 220 characters or fewer.
Error field_too_long Security Note must be 1000 characters or fewer.
Error field_too_long Subject must be 180 characters or fewer.