Template Stable

Reminder

Sent as a simple reminder.

reminder - notification

notification Stable Latest stable

Reminder v1

reminder - v1

Subject: Reminder

Preheader: {{message}}

Required fields

Name Type Required Description Example
message text Yes Message
Max 1000 characters
There is an update in your account.

Optional fields

Name Type Required Description Example
actionButton.label text No Action Button Label
Max 120 characters
View
actionButton.url url No Action Button URL
Max 2048 characters
https://example.com/app
heading text No Heading
Max 180 characters
Reminder
preheader text No Preheader
Max 220 characters
Message
reminderDetails detailsTable No Reminder details
Details table keys: dueAt (datetime), reference
{"dueAt":"Due At","reference":"Reference"}
subject text No Subject
Max 180 characters
Reminder

Defaults

{
  "actionButton.label": "View",
  "heading": "Reminder",
  "message": "",
  "preheader": "{{message}}",
  "subject": "Reminder"
}

Example data

{
  "templateId": "reminder",
  "data": {
    "message": "There is an update in your account."
  }
}

Template messages

TypeCodeMessage
Return accepted Valid template data can be queued by the send endpoint.
Error missing_required_variable Message is required.
Error field_too_long Message must be 1000 characters or fewer.
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 Preheader must be 220 characters or fewer.
Error invalid_details_table Reminder details must be an object whose documented table keys are strings, numbers, or booleans.
Error field_too_long Subject must be 180 characters or fewer.