Emails. Done.

Template Stable

Success notification

Sent when something completes successfully.

notification-success - notification

v1
notification Stable Latest stable

Success notification v1

notification-success - v1

Subject: Completed successfully

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		 Completed successfully
preheader text No Preheader
Max 220 characters		 Message
subject text No Subject
Max 180 characters		 Completed successfully

Defaults

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

Example data

{
  "templateId": "notification-success",
  "data": {
    "message": "{{message}}"
  }
}

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 field_too_long Subject must be 180 characters or fewer.