Template Stable

Account locked

Sent when an account is locked.

account-locked - security

authentication Stable Latest stable

Account locked v1

account-locked - v1

Subject: Account locked

Preheader: Your account has been locked for security.

Required fields

No fields.

Optional fields

Name Type Required Description Example
actionButton.label text No Action Button Label
Max 120 characters
Unlock account
actionButton.url url No Action Button URL
Max 2048 characters
https://example.com/app
heading text No Heading
Max 180 characters
Account locked
intro text No Intro
Max 1000 characters
Your account has been locked for security.
lockDetails detailsTable No Lock details
Details table keys: lockedAt (datetime), reason
{"lockedAt":"Locked At","reason":"Reason"}
notice text No Notice
Max 1000 characters
You may need to verify your identity before access is restored.
preheader text No Preheader
Max 220 characters
Your account has been locked for security.
subject text No Subject
Max 180 characters
Account locked

Defaults

{
  "actionButton.label": "Unlock account",
  "heading": "Account locked",
  "intro": "Your account has been locked for security.",
  "notice": "You may need to verify your identity before access is restored.",
  "preheader": "Your account has been locked for security.",
  "subject": "Account locked"
}

Example data

{
  "templateId": "account-locked",
  "data": {}
}

Template messages

TypeCodeMessage
Return accepted Valid template data can be queued by the send endpoint.
Error field_too_long Action Button Label must be 120 characters or fewer.
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 Heading must be 180 characters or fewer.
Error field_too_long Intro must be 1000 characters or fewer.
Error invalid_details_table Lock details must be an object whose documented table keys are strings, numbers, or booleans.
Error field_too_long Notice must be 1000 characters or fewer.
Error field_too_long Preheader must be 220 characters or fewer.
Error field_too_long Subject must be 180 characters or fewer.