Emails. Done.

Template Stable

Password reset

Sent when a user requests a password reset.

password-reset - security

v1
authentication Stable Latest stable

Password reset v1

password-reset - v1

Subject: Reset your password

Preheader: Use this secure link to reset your password.

Required fields

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

Optional fields

Name Type Required Description Example
actionButton.label text No Action Button Label
Max 120 characters		 Reset password
footerNote text No Footer Note
Max 1000 characters		 If you did not request this, you can safely ignore this email. Your password will remain unchanged.
heading text No Heading
Max 180 characters		 Reset your password
intro text No Intro
Max 1000 characters		 We received a request to reset your password.
preheader text No Preheader
Max 220 characters		 Use this secure link to reset your password.
requestDetails detailsTable No Request details
Details table keys: requestedAt (datetime), device, country, ip		 {"requestedAt":"Requested At","device":"Device","country":"Country","ip":"Ip"}
securityNote text No Security Note
Max 1000 characters		 For security, this link is private and will expire soon.
subject text No Subject
Max 180 characters		 Reset your password

Defaults

{
  "actionButton.label": "Reset password",
  "footerNote": "If you did not request this, you can safely ignore this email. Your password will remain unchanged.",
  "heading": "Reset your password",
  "intro": "We received a request to reset your password.",
  "preheader": "Use this secure link to reset your password.",
  "securityNote": "For security, this link is private and will expire soon.",
  "subject": "Reset your password"
}

Example data

{
  "templateId": "password-reset",
  "data": {
    "actionButton": {
      "url": "https://example.com/reset"
    }
  }
}

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 invalid_details_table Request details must be an object whose documented table keys are strings, numbers, or booleans.
Error field_too_long Security Note must be 1000 characters or fewer.
Error field_too_long Subject must be 180 characters or fewer.