Emails. Done.

Template Stable

Welcome

Sent when a user first joins an app.

welcome - security

v1
authentication Stable Latest stable

Welcome v1

welcome - v1

Subject: Welcome to {{projectName}}

Preheader: Your account is ready to go.

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		 Open {{projectName}}
callToActionHeading text No Call To Action Heading
Max 180 characters
callToActionParagraph text No Call To Action Paragraph
Max 1000 characters
heading text No Heading
Max 180 characters		 Welcome to Project Name
intro text No Intro
Max 1000 characters		 Your account has been created and you're ready to get started.
preheader text No Preheader
Max 220 characters		 Your account is ready to go.
subject text No Subject
Max 180 characters		 Welcome to Project Name

Defaults

{
  "actionButton.label": "Open {{projectName}}",
  "callToActionHeading": "",
  "callToActionParagraph": "",
  "heading": "Welcome to {{projectName}}",
  "intro": "Your account has been created and you're ready to get started.",
  "preheader": "Your account is ready to go.",
  "subject": "Welcome to {{projectName}}"
}

Example data

{
  "templateId": "welcome",
  "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 field_too_long Call To Action Heading must be 180 characters or fewer.
Error field_too_long Call To Action Paragraph must be 1000 characters or fewer.
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.