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}.

Path ParamsData typeDescription
etidstring(Required) Email Template Identifier (ETID) is returned in the email template response payload. (Path Parameter).
Body ParamsData typeRequirementDescription
namestringoptionalA unique name to give the template.
fromNamestringoptionalThe name that will appear in the From line of the email.
subjectstringoptionalThe Subject of the email.
headerImagestringoptionalA Base64 encoded string of an image that will show as the header of the email.
headerImageAltTextstringoptionalThe Alt Text for the Header Image in the email.
accentColorstringoptionalA Hex color value, six hexadecimal digits preceded by a pound sign, used as an accent in the email.
messageBodystringoptionalThe 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.
🚧 Coming soon
smsMessageBody
stringoptionalThe message body for the SMS. This is often used to let the recipient know why they have received the reward. Must be non-NULL when sending rewards via SMS. (limited to 90 characters)
closingstringoptionalAfter the reward credential, a space to close the message to the recipient.
customerServiceMessagestringoptionalIf 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 objectsoptionalWhich Customers and/or Accounts should have access to this template.
-typestringoptionalThe type of access being specified: PLATFORM, CUSTOMER or ACCOUNT.
-identifierstringoptionalLeave this field blank if the type is PLATFORM. Enter either the the customerIdentifier or the accountIdentifier if the type is CUSTOMER OR ACCOUNT, respectively.
defaultsarray of objectsoptional(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.
-typestringoptionalThe type of default being specified: PLATFORM, CUSTOMER or ACCOUNT.
-identifierstringoptionalLeave this field blank if the type is PLATFORM. Enter either the the customerIdentifier or the accountIdentifier if the type is CUSTOMER OR ACCOUNT, respectively.

See the example payload below:

{
  "etid": "string",
  "name": "string",
  "fromName": "string",
  "subject": "string",
  "headerImage": "string",
  "headerImageAltText": "string",
  "accentColor": "string",
  "messageBody": "string",
  "smsMessageBody": "string", **🚧 Coming soon**
  "closing": "string",
  "customerServiceMessage": "string",
  "accessControls": [
    {
      "type": "PLATFORM",
      "identifier": "string"
    }
  ],
  "defaults": [
    {
      "type": "PLATFORM",
      "identifier": "string"
    }
  ]
}

Here's an example payload for when you receive an error:

{
  "timestamp": "2025-02-21T23:23:13.930Z",
  "requestId": "string",
  "path": "string",
  "httpCode": 0,
  "httpPhrase": "string",
  "i18nKey": "string",
  "message": "The error message will show here for error codes ",
  "errors": [
    {}
  ]
}

The possible response codes for this endpoint are as follows. For details, see i18nkey codes and their error messages:

Response codeMeaning
200The request was successful.
400The server could not understand the request due to invalid syntax.
401Authentication is required and has either not been provided or failed.
403The server understood the request but refuses to authorize it.
404The server could not find the requested resource. In other words, the URL you’re trying to access doesn’t point to anything that exists on the server.
409The server understands the request but cannot process it due to semantic errors.
500Something went wrong on the server, but the server cannot be more specific about what the exact problem is.
503The server is currently unable to handle the request due to temporary overload or maintenance.

© 2025 Tango API are provided by Tango, a division of BHN, Inc.