Emails. Done.

Template Stable

Login code

Sent when a user requests a one-time login code.

login-code - security

v1
authentication Stable Latest stable

Login code v1

login-code - v1

Subject: Your login code

Preheader: Use this code to continue signing in.

Required fields

Name Type Required Description Example
code code Yes Code
Max 240 characters		 123456

Optional fields

Name Type Required Description Example
footerNote text No Footer Note
Max 1000 characters		 If you did not request this code, you can safely ignore this email.
heading text No Heading
Max 180 characters		 Your login code
intro text No Intro
Max 1000 characters		 Use this code to continue signing in.
preheader text No Preheader
Max 220 characters		 Use this code to continue signing in.
securityNote text No Security Note
Max 1000 characters		 For security, this code will expire soon.
subject text No Subject
Max 180 characters		 Your login code

Defaults

{
  "footerNote": "If you did not request this code, you can safely ignore this email.",
  "heading": "Your login code",
  "intro": "Use this code to continue signing in.",
  "preheader": "Use this code to continue signing in.",
  "securityNote": "For security, this code will expire soon.",
  "subject": "Your login code"
}

Example data

{
  "templateId": "login-code",
  "data": {
    "code": "123456"
  }
}

Template messages

TypeCodeMessage
Return accepted Valid template data can be queued by the send endpoint.
Error missing_required_variable Code is required.
Error field_too_long Code must be 240 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.