Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
63 changes: 31 additions & 32 deletions modules/ROOT/pages/customize-email-apis.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,18 +12,14 @@ ThoughtSpot now provides REST APIs that enable developers and administrators to
* SpotIQ analysis results
* KPI chart alerts

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

* 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

Expand Down Expand Up @@ -71,34 +67,37 @@ curl -X POST \
-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",
"company_privacy_policy_url": "https://link-to-privacy-policy.com/",
"company_website_url": "https://your-website.com"
}
"org_identifier": "OrgA"
}'
"cta_button_bg_color": "",
"cta_text_font_color": "",
"primary_bg_color": "",
"Logo_url":
"https://storage.pardot.com/710713/1642089901EbkRibJq/TS_fullworkmark_darkmode.png",
"font_family": "",
"product_name": "ThoughtSpot",
"footer_address": "444 Castro St, Suite 1000 Mountain View, CA 94041",
"footer_phone": "(800) 508-7008",
"replacement_value_for_liveboard": "Dashboard",
"replacement_value_for_answer": "Chart",
"replacement_value_for_spot_iq": "AI Insights",
"hide_footer_phone": false,
"hide_footer_address": false,
"hide_product_name": false,
"hide_manage_notification": false,
"hide_mobile_app_nudge": false,
"hide_privacy_policy": false,
"hide_ts_vocabulary_definitions": false,
"hide_error_message": false,
"hide_unsubscribe_link": false,
"hide_notification_status": false,
"hide_modify_alert": false,
"company_website_url": "https://your-website.com/"
"company_privacy_policy_url" : "https://link-to-privacy-policy.com/"
},
"org_identifier": "-1"
}

----


Expand Down
Binary file modified static/doc-images/images/email-template.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading