Emails. Done.

Template Stable

Approval needed

Sent when an approval is needed.

approval-needed - notification

v1
notification Stable Latest stable

Approval needed v1

approval-needed - v1

Subject: Approval needed

Preheader: An item is waiting for approval.

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		 Review request
approvalDetails detailsTable No Approval details
Details table keys: item, requestedBy, requestedAt (datetime)		 {"item":"Item","requestedBy":"Requested By","requestedAt":"Requested At"}
heading text No Heading
Max 180 characters		 Approval needed
message text No Message
Max 1000 characters		 An item is waiting for approval.
preheader text No Preheader
Max 220 characters		 An item is waiting for approval.
subject text No Subject
Max 180 characters		 Approval needed

Defaults

{
  "actionButton.label": "Review request",
  "heading": "Approval needed",
  "message": "An item is waiting for approval.",
  "preheader": "An item is waiting for approval.",
  "subject": "Approval needed"
}

Example data

{
  "templateId": "approval-needed",
  "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 Approval 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 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.