Template Stable

Credits low

Sent when available credits are running low.

credits-low - notification

developer Stable Latest stable

Credits low v1

credits-low - v1

Subject: Credits are running low

Preheader: Add credits to continue without interruption.

Required fields

No fields.

Optional fields

Name Type Required Description Example
actionButton.label text No Action Button Label
Max 120 characters
Add credits
actionButton.url url No Action Button URL
Max 2048 characters
https://example.com/app
creditDetails detailsTable No Credit details
Details table keys: remaining (number), threshold (number), periodEndsAt (date)
{"remaining":"Remaining","threshold":"Threshold","periodEndsAt":"Period Ends At"}
heading text No Heading
Max 180 characters
Credits are running low
intro text No Intro
Max 1000 characters
Your available credits are running low.
preheader text No Preheader
Max 220 characters
Add credits to continue without interruption.
subject text No Subject
Max 180 characters
Credits are running low

Defaults

{
  "actionButton.label": "Add credits",
  "heading": "Credits are running low",
  "intro": "Your available credits are running low.",
  "preheader": "Add credits to continue without interruption.",
  "subject": "Credits are running low"
}

Example data

{
  "templateId": "credits-low",
  "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 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.