authentication
Stable
Latest stable
New device login v1
new-device-login - v1
Subject: New sign-in detected
Preheader: A new device signed in to your account.
Required fields
No fields.
Optional fields
| Name | Type | Required | Description | Example |
|---|---|---|---|---|
actionButton.label |
text | No | Action Button Label Max 120 characters |
Review account |
actionButton.url |
url | No | Action Button URL Max 2048 characters |
https://example.com/app |
footerNote |
text | No | Footer Note Max 1000 characters |
If this was you, no action is needed. |
heading |
text | No | Heading Max 180 characters |
New sign-in detected |
intro |
text | No | Intro Max 1000 characters |
Your account was accessed from a device we have not seen before. |
loginDetails |
detailsTable | No | Sign-in details Details table keys: signedInAt (datetime), device, country, ip |
{"signedInAt":"Signed In At","device":"Device","country":"Country","ip":"Ip"} |
preheader |
text | No | Preheader Max 220 characters |
A new device signed in to your account. |
subject |
text | No | Subject Max 180 characters |
New sign-in detected |
Defaults
{
"actionButton.label": "Review account",
"footerNote": "If this was you, no action is needed.",
"heading": "New sign-in detected",
"intro": "Your account was accessed from a device we have not seen before.",
"preheader": "A new device signed in to your account.",
"subject": "New sign-in detected"
}
Example data
{
"templateId": "new-device-login",
"data": {}
}
Template messages
| Type | Code | Message |
|---|---|---|
| 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 |
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 | invalid_details_table |
Sign-in details must be an object whose documented table keys are strings, numbers, or booleans. |
| Error | field_too_long |
Preheader must be 220 characters or fewer. |
| Error | field_too_long |
Subject must be 180 characters or fewer. |