Manage email templates

Using Tango you can send digital rewards by email through Tango. Email templates help customize messages and branding that is used repeatedly when sending rewards. Email templates for reward delivery can be managed via the Tango API.

📘

Note:

Custom email templates can be assigned and accessed at the Platform, Customer (Group), or Account levels.

Tango email template

In addition to supporting custom templates at the Platform, Customer, or Account levels, Tango supports one-off email templates that can be called by the optional ETID field, to override the default assigned email template. Contact your Tango Customer Success Manger, or email [email protected] for details.

You can configure the following attributes of the reward email template:

  • Template Name (uniqueness enforced at platform level)
  • From Name
  • Subject
  • Header Image
  • Primary Message
  • Customer Service Message
  • Closing message
  • Accent Color (for emphasized copy in the reward block containing reward credentials and redemption instructions)

Once created, an email template is assigned an ETID, which is used to identify that specific template when placing an order. Here is a sample of our default template.

484

About header images

Header images must be 650 x150 pixels and Base64 encoded before they are passed to us via API. Standard image formats can be uploaded manually via Tango portal. See this document to learn more about Base64 encoding.

What are mustache tags

We support a variety of different dynamic tags that can be inserted into various elements.

Mustache TagsDescriptionEmail template element(s)
{{message}}This tag maps to the "Message" field in the Place Order method.Message Body, Closing Message
{{recipient_name}}This tag maps to the recipient first-name and last-name fields (concatenated) in the Place Order method, Blast Rewards Template, and Tango portal.Message Body, Closing Message
{{reward_name}}This tag maps to the reward name that is being sent to the recipient (i.e. "Reward Link Preferred").Email Subject, Message Body, Closing Message, Customer Service Message

Providing customer service to rewards recipients

By default, Tango provides tier-one customer service for rewards delivered via our email server, a fact reflected by the default Tango customer-service message that comes standard in email templates. However, if you are planning to provide your own tier-one customer service to reward recipients, you'll need to include a unique customer-service message when creating your email templates. If left blank, the default Tango customer-service message will appear.

How to tie email template to an account

It's possible to tie an email template to a specific Account or Customer (Group) so that specific email template will not be accessible by any other Account or Customer (Group). If you'd like an email template to be broadly accessible by any Account beneath your platform, ensure access is set at the Platform level. Currently, this access-control feature is only accessible via the API, but it will be coming to email-template management in Tango at a later date.

How to set default email template

Setting an email template as a default for an Account, Customer (Group), or Platform enables you to specify an email template for orders placed without a specified ETID. While an email template must be selected when placing an order through our Reward Genius web application, it is possible to place an order via the API or Blast Rewards without specifying an email template. If an ETID is not provided, our system will check for a default first at the Account level, then at the Customer (Group) level, and finally at the Platform level. If no default is found, the rewards will be sent on our standard Tango email template.

Sending emails

Use the sendEmail field (true/false) to specify whether or not Tango should deliver a reward email to the recipient. When the sendEmail= true, Tango sends the recipient email.

Get a list of all email templates on this platform

Use the following endpoin to get a list of all email templates created in your platform. This method is paginated and defaults to the first page with 25 templates per page if the paging is not specified.

EndpointPurpose
GET {URI}/emailTemplatesGet a list of all Email Templates on this Platform.

Here are a list of query parameters for when you use GET {URI}/emailTemplates to get a list of all email templates on this Platform:

ParameterData typeDescription
elementsPerBlockint32specify the number of elements in a block.
pageint32specify the page number to return.

The response message for this endpoint is:

  • 200 OK
  • 400 Bad Request
  • 401 Unauthorized
  • 403 Forbidden

Create a new email template

Use POST {URI}/emailTemplates to create email templates for reward delivery. The ETID returned in the API response is necessary to identify a particular email template when ordering.

EndpointPurpose
POST {URI}/emailTemplatesCreate a new email template.

Here is the list of body parameters for when you use POST {URI}/emailTemplates to create a new email template:

ParameterData typeDescription
namestringA unique name to give the template.
fromNamestringThe name that appears in the From line of the email.
subjectstringThe Subject of the email.
headerImagestringA Base64 encoded string of an image that shows as the header of the email.
headerImageAltTextstringThe Alt Text for the Header Image in the email.
accentColorstringA Hex color value, six hexadecimal digits preceded by a pound sign, used as an accent in the email.
messageBodystringThe message body for the email. This is often used to let the recipient know why they have received the reward.
closingstringAfter the reward credential, a space to close the message to the recipient.
customerServiceMessagestring(Optional) If left null, Tango's Customer Support contact information is included. Otherwise contact information for your customer support, if you are taking responsibility for providing first tier customer support of your recipients.
accessControlarray of objects(Optional) Indicates which Customers and/or Accounts should have access to this template.
-typestringThe type of access being specified: PLATFORM, CUSTOMER or ACCOUNT.
-identifierstringLeave this field blank if the type is PLATFORM. Enter either customerIdentifier or accountIdentifier (5-100 chars), if the type is CUSTOMER OR ACCOUNT, respectively.
defaultsarray of objectsIf you want this template to be used at order time for the given Platform, Customer or Account when the Email Template Identifier (etid) is not provided with the order.
-typestringThe type of default being specified: PLATFORM, CUSTOMER or ACCOUNT.
-identifierstringLeave this field blank if the type is PLATFORM. Enter either customerIdentifier or accountIdentifier (5-100 chars), if the type is CUSTOMER OR ACCOUNT, respectively.

The response message for this endpoint is:

  • 201 Created
  • 400 Bad Request
  • 401 Unauthorized
  • 403 Forbidden
  • 404 Not Found
  • 409 Conflict, Duplicate Exists
  • 422 Unprocessable Entity

Get details for a specific email template

Use the following endpoint to receive details pertaining to a specific email template on this platform.

EndpointPurpose
GET /{URI}/emailTemplates/{etid}Get details for a specific Email Template on this Platform.

Here is the path parameter for when you use GET /{URI}/emailTemplates/{etid} to get details for a specific Email Template on this platform.:

ParameterData typeDescription
etidstring(Required) Email Template Identifier (ETID) is returned in the email template response payload.

The response message for this endpoint is:

  • 200 OK
  • 400 Bad Request
  • 401 Unauthorized
  • 403 Forbidden
  • 404 Not Found

Update details for a specific email template

Use the following endpoint to update details for a specific email template on this platform. Only include elements that need to be updated.

EndpointPurpose
PATCH {URI}/emailTemplates/{etid}Update details for a specific Email Template on this Platform.

The following table shows parameters for PATCH {URI}/emailTemplates/{etid}.

ParameterData typeDescription
etidstring(Required) Email Template Identifier (ETID) is returned in the email template response payload. (Path Parameter).
namestring(Optional) A unique name to give the template.
fromNamestring(Optional) The name that will appear in the From line of the email.
subjectstring(Optional) The Subject of the email.
headerImagestring(Optional) A Base64 encoded string of an image that will show as the header of the email.
headerImageAltTextstring(Optional) The Alt Text for the Header Image in the email.
accentColorstring(Optional) A Hex color value, six hexadecimal digits preceded by a pound sign, used as an accent in the email.
messageBodystring(Optional) The message body for the email. This is often used to let the recipient know why they have received the reward. The string may have up to 1024 characters.
closingstring(Optional) After the reward credential, a space to close the message to the recipient.
customerServiceMessagestring(Optional) If left null, Tango's Customer Support contact information will be included. Otherwise contact information for your customer support, if you are taking responsibility for providing first tier customer support of your recipients.
accessControlarray of objects(Optional) Which Customers and/or Accounts should have access to this template.
defaultsarray of objects(Optional) If you want this template to be used at order time for the given Platform, Customer or Account when the Email Template Identifier (ETID) is not provided with the order.

The response message for this endpoint is:

  • 200 Ok
  • 400 Bad Request
  • 401 Unauthorized
  • 403 Forbidden
  • 404 Not Found
  • 409 Conflict, Duplicate Exists

Delete a specific email template

📘

Note:

Once an email template has been used to send rewards, it cannot be deleted.

Use the following endpoint to delete an existing email template.

EndpointPurpose
DELETE {URI}/emailTemplates/{etid}Delete a specific Email Template on this Platform.

Here is a path parameter for when you use DELETE {URI}/emailTemplates/{etid} to delete a specific email template on your platform.

Path parameterData typeDescription
etidstringEmail Template Identifier (ETID) is returned in the email template response payload.

The response message for this endpoint is:

  • 204 No Content
  • 400 Bad Request
  • 401 Unauthorized
  • 403 Forbidden
  • 404 Not Found

What’s Next