Emails. Done.

Template Stable

Credits exhausted

Sent when available credits are exhausted.

credits-exhausted - notification

v1
developer Stable Latest stable

Credits exhausted v1

credits-exhausted - v1

Subject: Credits exhausted

Preheader: Add credits to continue.

Required fields

Name Type Required Description Example
actionButton.url url Yes Action Button URL
Max 2048 characters		 https://example.com/app

Optional fields

Name Type Required Description Example
actionButton.label text No Action Button Label
Max 120 characters		 Add credits
creditDetails detailsTable No Credit details
Details table keys: remaining (number), used (number), periodEndsAt (date)		 {"remaining":"Remaining","used":"Used","periodEndsAt":"Period Ends At"}
heading text No Heading
Max 180 characters		 Credits exhausted
intro text No Intro
Max 1000 characters		 Your available credits have been used.
preheader text No Preheader
Max 220 characters		 Add credits to continue.
subject text No Subject
Max 180 characters		 Credits exhausted

Defaults

{
  "actionButton.label": "Add credits",
  "heading": "Credits exhausted",
  "intro": "Your available credits have been used.",
  "preheader": "Add credits to continue.",
  "subject": "Credits exhausted"
}

Example data

{
  "templateId": "credits-exhausted",
  "data": {
    "actionButton": {
      "url": "https://example.com/app"
    }
  }
}

Template messages

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