Customize email template <sup class="beta betaBackground">Beta</sup>

Customize email template Beta

ThoughtSpot now provides REST APIs that enable developers and administrators to customize the branding, content, and visibility of components in notification emails. ThoughtSpot embedded users receive notification emails for several events, including:

  • ThoughtSpot welcome emails

  • Sharing of Liveboards, visualizations, or saved answers

  • SpotIQ analysis results

  • KPI chart alerts

These APIs support customizations of the following parameters of the email template at the Org level:

  • Style customization, including font and email colour palette, allows you to set the look and feel, including fonts and colours, for a seamless product experience.

  • Custom vocabulary for notification emails. This allows you to replace ThoughtSpot specific terms like “ThoughtSpot,” “Liveboard,” “Answer,” and "SpotIQ," with your product terminology.

  • Customizing the company logo and the company contact details in the email footer.

  • Customizing the visibility of actions like unsubscribe and mobile app nudge.

  • Customizing the visibility of the Privacy Policy and Manage Notification Preferences components.

Note

These APIs are in beta and disabled by default on ThoughtSpot instances. To enable these APIs on your instance, contact ThoughtSpot support.

Before you begin🔗

  • For REST API v2 operations, the Org context is determined based on the authentication token used in your API requests. Ensure you log in to the appropriate Org context from which you want to send API requests.

  • Ensure that you have developer or administrator privileges for the Org.

Note

For overlapping components, customized configuration through these APIs overrides the email configuration through the Admin > Onboarding page of your ThoughtSpot instance.

Create an email customization🔗

To customize the notification emails for your Org, send a POST request to the /api/rest/2.0/customization/email API endpoint, with the following parameters in the request body.

At any given time, only one customized configuration can be set for the notification emails of the Org. The most recently set configuration will be the active one.

Note

The customized configuration set for the Org overrides the configuration set for the ThoughtSpot instance. However, any Org with no specific configuration will reflect the same configuration as for the ThoughtSpot instance.

Request parameters🔗

In your POST request body, include the following parameters:

ParameterDescription

template_properties

String. Required. A JSON map of customizable elements of the email.

Example request🔗

curl -X POST \
  --url 'https://{ThoughtSpot-Host}/api/rest/2.0/customization/email'  \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {AUTH_TOKEN}' \
  --data-raw '{
  "template_properties": {
    "ctaButtonBgColor": "",
    "ctaTextFontColor": "",
    "primaryBgColor": "",
    "hideMobileAppNudge": false,
    "fontFamily" : "",
    "hideProductName" : false,
    "hideFooterPhone" : false,
    "hideFooterAddress" : false,
    "hidePrivacyPolicy" : false,
    "hideManageNotification" : false,
    "hideTsVocabularyDefinitions": false,
    "hideNotificationStatus" : false,
    "textTransform": "",
    "replacementValueForLiveboard": "LB dashboard",
    "replacementValueForAnswer": "Answer dashboard",
    "replacementValueForSpotIQ": "SpotIQ dashboard",
    "hideErrorMessage": false,
    "hideUnsubscribeLink" : false,
    "hideModifyAlert": false,
    "productName":"ThoughtSpot",
    "footerPhone":"(800) 508-7008",
    "footerAddress":"444 Castro St, Suite 1000 Mountain View, CA 94041"
  }
}'

JSON actions explained

Validate the email customization🔗

To validate your email customization configuration in ThoughtSpot, send a POST request to the /api/rest/2.0/customization/email/validate API endpoint. This triggers a test email that reflects all the customizations you have configured. It allows you to confirm that customizations are applied as expected. You can adjust your configuration if needed and repeat the validation until done.

For users with developer privileges, the email will be sent to their email id. For users with admin privileges, the email will be delivered to the address associated with the ThoughtSpot account.

Note

Validation email delivery requires the mail service to be enabled for the Org. If email configuration is missing, emails will not be sent or received, regardless of the API response.

Search an email customization🔗

To search the email customization configuration set for the Org send a POST request to the /api/rest/2.0/customization/email/search API endpoint.

Delete an email customization🔗

To remove an existing customization configuration for notification emails in your Org, send a POST request to the /api/rest/2.0/customization/email/{template_identifier}/delete API endpoint, with the template_identifier passed as a path parameter in the request URL .

Additional references🔗