Emails. Done.

Template Stable

Digest

Sent as a summary digest.

digest - notification

v1
notification Stable Latest stable

Digest v1

digest - v1

Subject: Your digest

Preheader: A summary of recent activity.

Required fields

No fields.

Optional fields

Name Type Required Description Example
actionButton.label text No Action Button Label
Max 120 characters		 View activity
actionButton.url url No Action Button URL
Max 2048 characters		 https://example.com/app
heading text No Heading
Max 180 characters		 Your digest
intro text No Intro
Max 1000 characters		 Here is a summary of recent activity.
message text No Message
Max 1000 characters
preheader text No Preheader
Max 220 characters		 A summary of recent activity.
subject text No Subject
Max 180 characters		 Your digest
summary detailsTable No Summary
Details table keys: newItems (number), updates (number), alerts (number)		 {"newItems":"New Items","updates":"Updates","alerts":"Alerts"}

Defaults

{
  "actionButton.label": "View activity",
  "heading": "Your digest",
  "intro": "Here is a summary of recent activity.",
  "message": "",
  "preheader": "A summary of recent activity.",
  "subject": "Your digest"
}

Example data

{
  "templateId": "digest",
  "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 field_too_long Message 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.
Error invalid_details_table Summary must be an object whose documented table keys are strings, numbers, or booleans.