Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
All 92 tools →
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/thoughtspot-email-customization-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: ThoughtSpot Public REST Email Customization API
version: '2.0'
servers:
- url: '{base-url}'
variables:
base-url:
default: https://localhost:443
security:
- bearerAuth: []
tags:
- name: Email Customization
paths:
/api/rest/2.0/customization/email:
post:
operationId: createEmailCustomization
description: 'Beta Version: 10.10.0.cl or later
Creates a customization configuration for the notification email.
#### Pre-requisites
Requires `DEVELOPER` (**has developer privilege**) or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.
If Role-Based Access Control (RBAC) is enabled on your instance, the `DEVELOPER` (**Has developer privilege**) privilege is required.
**NOTE**:This endpoint in currently in beta. Contact ThoughtSpot support to enable this on your instance.
#### Usage guidelines
To create a custom configuration pass these parameters in your API request:
- A JSON map of configuration attributes `template_properties`. The following example shows a sample set of customization configuration:
```
{
{
"cta_button_bg_color": "#444DEA",
"cta_text_font_color": "#FFFFFF",
"primary_bg_color": "#D3DEF0",
"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/",
"contact_support_url": "https://link-to-contact-support.com/",
"hide_contact_support_url": false,
"hide_logo_url" : false
}
}
```
#### Endpoint URL'
tags:
- Email Customization
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateEmailCustomizationRequest'
required: true
parameters: []
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/CreateEmailCustomizationResponse'
'400':
description: Invalid request.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'403':
description: Unauthorized access.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
summary: Create email customization
x-summary-source: derived
/api/rest/2.0/customization/email/{template_identifier}/delete:
post:
operationId: deleteEmailCustomization
description: 'Beta Version: 10.10.0.cl or later
Deletes the configuration for the email customization.
#### Pre-requisites
Requires `DEVELOPER` (**has developer privilege**) or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.
If Role-Based Access Control (RBAC) is enabled on your instance, the `DEVELOPER` (**Has developer privilege**) privilege is required.
**NOTE**:This endpoint in currently in beta. Contact ThoughtSpot support to enable this on your instance.
#### Usage guidelines
- Call the search API endpoint to get the `template_identifier` from the response.
- Use that `template_identifier` as a parameter in this API request.
#### Endpoint URL'
deprecated: true
tags:
- Email Customization
parameters:
- in: path
name: template_identifier
required: true
schema:
type: string
description: Unique ID or name of the email customization.
responses:
'204':
description: Email Customization configuration successfully deleted.
'400':
description: Invalid request.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'403':
description: Unauthorized access.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
summary: Delete email customization
x-summary-source: derived
/api/rest/2.0/customization/email/delete:
post:
operationId: deleteOrgEmailCustomization
description: 'Beta Version: 10.12.0.cl or later
Deletes the configuration for the email customization.
#### Pre-requisites
Requires `DEVELOPER` (**has developer privilege**) or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.
If Role-Based Access Control (RBAC) is enabled on your instance, the `DEVELOPER` (**Has developer privilege**) privilege is required.
**NOTE**:This endpoint in currently in beta. Contact ThoughtSpot support to enable this on your instance.
#### Usage guidelines
- Call the search API endpoint to get the `org_identifier` from the response.
- Use that `org_identifier` as a parameter in this API request.
#### Endpoint URL'
tags:
- Email Customization
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteOrgEmailCustomizationRequest'
required: true
parameters: []
responses:
'204':
description: Email Customization configuration successfully deleted.
'400':
description: Invalid request.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'401':
description: Unauthorized access.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'403':
description: Unauthorized access.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
summary: Delete org email customization
x-summary-source: derived
/api/rest/2.0/customization/email/search:
post:
operationId: searchEmailCustomization
description: 'Beta Version: 10.10.0.cl or later
Search the email customization configuration if any set for the ThoughtSpot system.
#### Pre-requisites
Requires `DEVELOPER` (**has developer privilege**) or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.
If Role-Based Access Control (RBAC) is enabled on your instance, the `DEVELOPER` (**Has developer privilege**) privilege is required.
**NOTE**:This endpoint in currently in beta. Contact ThoughtSpot support to enable this on your instance.
#### Endpoint URL'
tags:
- Email Customization
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SearchEmailCustomizationRequest'
required: true
parameters: []
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/CreateEmailCustomizationResponse'
'400':
description: Invalid request.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'403':
description: Unauthorized access.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
summary: Search email customization
x-summary-source: derived
/api/rest/2.0/customization/email/update:
post:
operationId: updateEmailCustomization
description: 'Beta Version: 10.12.0.cl or later
Updates a customization configuration for the notification email.
#### Pre-requisites
Requires `DEVELOPER` (**has developer privilege**) or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.
If Role-Based Access Control (RBAC) is enabled on your instance, the `DEVELOPER` (**Has developer privilege**) privilege is required.
**NOTE**:This endpoint in currently in beta. Contact ThoughtSpot support to enable this on your instance.
#### Usage guidelines
To update a custom configuration pass these parameters in your API request:
- A JSON map of configuration attributes `template_properties`. The following example shows a sample set of customization configuration:
```
{
{
"cta_button_bg_color": "#444DEA",
"cta_text_font_color": "#FFFFFF",
"primary_bg_color": "#D3DEF0",
"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/",
"contact_support_url": "https://link-to-contact-support.com/",
"hide_contact_support_url": false,
"hide_logo_url" : false
}
}
```
#### Endpoint URL'
tags:
- Email Customization
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateEmailCustomizationRequest'
required: true
parameters: []
responses:
'204':
description: Email Customization configuration successfully updated.
'400':
description: Invalid request.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'401':
description: Unauthorized access.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'403':
description: Unauthorized access.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
summary: Update email customization
x-summary-source: derived
/api/rest/2.0/customization/email/validate:
post:
operationId: validateEmailCustomization
description: 'Beta Version: 10.10.0.cl or later
Validates the email customization configuration if any set for the ThoughtSpot system.
#### Pre-requisites
Requires `DEVELOPER` (**has developer privilege**) or `ADMINISTRATION` (**Can administer ThoughtSpot**) privilege.
If Role-Based Access Control (RBAC) is enabled on your instance, the `DEVELOPER` (**Has developer privilege**) privilege is required.
**NOTE**:This endpoint in currently in beta. Contact ThoughtSpot support to enable this on your instance.
#### Endpoint URL'
tags:
- Email Customization
parameters: []
responses:
'204':
description: Triggered test email for customization configuration
'400':
description: Invalid request.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'403':
description: Unauthorized access.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
summary: Validate email customization
x-summary-source: derived
components:
schemas:
CreateEmailCustomizationRequest:
type: object
properties:
template_properties:
description: Email customization configuration as key value pair
allOf:
- $ref: '#/components/schemas/Template_Properties_Input_Create'
org_identifier:
description: 'Unique ID or name of org <br/> <span class="since-beta-tag">Version: 10.12.0.cl or later</span>'
type: string
required:
- template_properties
DeleteOrgEmailCustomizationRequest:
type: object
properties:
org_identifiers:
description: Unique identifier of the organization.
type: array
items:
type: string
UpdateEmailCustomizationRequest:
type: object
properties:
template_properties:
description: Email customization configuration as key value pair
allOf:
- $ref: '#/components/schemas/Template_Properties_Input_Create'
org_identifier:
description: Unique ID or name of org
type: string
required:
- template_properties
OrgType:
type: object
properties:
name:
type:
- string
- 'null'
id:
type:
- integer
- 'null'
format: int32
ErrorResponse:
type: object
properties:
error:
type:
- object
- 'null'
CreateEmailCustomizationResponse:
type: object
required:
- tenant_id
- org
- name
- template_properties
properties:
tenant_id:
type: string
description: Tenant ID
org:
$ref: '#/components/schemas/OrgType'
description: Email customization org
name:
type: string
description: Email customization name.
template_properties:
type: object
description: Customization configuration for the email
SearchEmailCustomizationRequest:
type: object
properties:
org_identifiers:
description: 'Unique ID or name of org <br/> <span class="since-beta-tag">Version: 10.12.0.cl or later</span>'
type: array
items:
type: string
Template_Properties_Input_Create:
type: object
properties:
cta_button_bg_color:
type:
- string
- 'null'
description: Background color for call-to-action button in hex format
cta_text_font_color:
type:
- string
- 'null'
description: Text color for call-to-action button in hex format
primary_bg_color:
type:
- string
- 'null'
description: Primary background color in hex format
home_url:
type:
- string
- 'null'
description: Home page URL (HTTP/HTTPS only)
logo_url:
type:
- string
- 'null'
description: Logo image URL (HTTP/HTTPS only)
font_family:
type:
- string
- 'null'
description: Font family for email content (e.g., Arial, sans-serif)
product_name:
type:
- string
- 'null'
description: Product name to display
footer_address:
type:
- string
- 'null'
description: Footer address text
footer_phone:
type:
- string
- 'null'
description: Footer phone number
replacement_value_for_liveboard:
type:
- string
- 'null'
description: Replacement value for Liveboard
replacement_value_for_answer:
type:
- string
- 'null'
description: Replacement value for Answer
replacement_value_for_spot_iq:
type:
- string
- 'null'
description: Replacement value for SpotIQ
hide_footer_address:
type:
- boolean
- 'null'
description: Whether to hide footer address
hide_footer_phone:
type:
- boolean
- 'null'
description: Whether to hide footer phone number
hide_manage_notification:
type:
- boolean
- 'null'
description: Whether to hide manage notification link
hide_mobile_app_nudge:
type:
- boolean
- 'null'
description: Whether to hide mobile app nudge
hide_privacy_policy:
type:
- boolean
- 'null'
description: Whether to hide privacy policy link
hide_product_name:
type:
- boolean
- 'null'
description: Whether to hide product name
hide_ts_vocabulary_definitions:
type:
- boolean
- 'null'
description: Whether to hide ThoughtSpot vocabulary definitions
hide_notification_status:
type:
- boolean
- 'null'
description: Whether to hide notification status
hide_error_message:
type:
- boolean
- 'null'
description: Whether to hide error message
hide_unsubscribe_link:
type:
- boolean
- 'null'
description: Whether to hide unsubscribe link
hide_modify_alert:
type:
- boolean
- 'null'
description: Whether to hide modify alert
company_privacy_policy_url:
type:
- string
- 'null'
description: Company privacy policy URL (HTTP/HTTPS only)
company_website_url:
type:
- string
- 'null'
description: Company website URL (HTTP/HTTPS only)
contact_support_url:
type:
- string
- 'null'
description: 'Contact support url (HTTP/HTTPS only). <br/> <span class="since-beta-tag">Version: 26.2.0.cl or later</span>'
hide_contact_support_url:
type:
- boolean
- 'null'
description: 'Whether to hide contact support url. <br/> <span class="since-beta-tag">Version: 26.2.0.cl or later</span>'
hide_logo_url:
type:
- boolean
- 'null'
description: 'Whether to hide logo <br/> <span class="since-beta-tag">Version: 26.4.0.cl or later</span>'
description: Email customization configuration properties
securitySchemes:
bearerAuth:
type: http
scheme: bearer
x-roles:
- name: 26.2.0.cl
id: 26.2.0.cl
tags:
- 26.2.0.cl
description: Roles for version 26.2.0.cl
- name: 10.4.0.cl
id: 10.4.0.cl
tags:
- 10.4.0.cl
description: Roles for version 10.4.0.cl
- name: 26.7.0.cl
id: 26.7.0.cl
tags:
- 26.7.0.cl
description: Roles for version 26.7.0.cl
- name: 26.8.0.cl
id: 26.8.0.cl
tags:
- 26.8.0.cl
description: Roles for version 26.8.0.cl
- name: 26.6.0.cl
id: 26.6.0.cl
tags:
- 26.6.0.cl
description: Roles for version 26.6.0.cl
- name: 10.15.0.cl
id: 10.15.0.cl
tags:
- 10.15.0.cl
description: Roles for version 10.15.0.cl
- name: 10.13.0.cl
id: 10.13.0.cl
tags:
- 10.13.0.cl
description: Roles for version 10.13.0.cl
- name: 26.9.0.cl
id: 26.9.0.cl
tags:
- 26.9.0.cl
description: Roles for version 26.9.0.cl
- name: 10.7.0.cl
id: 10.7.0.cl
tags:
- 10.7.0.cl
description: Roles for version 10.7.0.cl
- name: 26.5.0.cl
id: 26.5.0.cl
tags:
- 26.5.0.cl
description: Roles for version 26.5.0.cl
- name: 9.0.0.cl
id: 9.0.0.cl
tags:
- 9.0.0.cl
description: Roles for version 9.0.0.cl
- name: 9.4.0.cl
id: 9.4.0.cl
tags:
- 9.4.0.cl
description: Roles for version 9.4.0.cl
- name: 9.12.0.cl
id: 9.12.0.cl
tags:
- 9.12.0.cl
description: Roles for version 9.12.0.cl
- name: 26.4.0.cl
id: 26.4.0.cl
tags:
- 26.4.0.cl
description: Roles for version 26.4.0.cl
- name: 10.12.0.cl
id: 10.12.0.cl
tags:
- 10.12.0.cl
description: Roles for version 10.12.0.cl
- name: 9.2.0.cl
id: 9.2.0.cl
tags:
- 9.2.0.cl
description: Roles for version 9.2.0.cl
- name: 9.9.0.cl
id: 9.9.0.cl
tags:
- 9.9.0.cl
description: Roles for version 9.9.0.cl
- name: 9.6.0.cl
id: 9.6.0.cl
tags:
- 9.6.0.cl
description: Roles for version 9.6.0.cl
- name: 10.10.0.cl
id: 10.10.0.cl
tags:
- 10.10.0.cl
description: Roles for version 10.10.0.cl
- name: 10.6.0.cl
id: 10.6.0.cl
tags:
- 10.6.0.cl
description: Roles for version 10.6.0.cl
- name: 10.3.0.cl
id: 10.3.0.cl
tags:
- 10.3.0.cl
description: Roles for version 10.3.0.cl
- name: 10.1.0.cl
id: 10.1.0.cl
tags:
- 10.1.0.cl
description: Roles for version 10.1.0.cl
- name: 10.9.0.cl
id: 10.9.0.cl
tags:
- 10.9.0.cl
description: Roles for version 10.9.0.cl
- name: 10.8.0.cl
id: 10.8.0.cl
tags:
- 10.8.0.cl
description: Roles for version 10.8.0.cl
- name: 9.5.0.cl
id: 9.5.0.cl
tags:
- 9.5.0.cl
description: Roles for version 9.5.0.cl
- name: 26.3.0.cl
id: 26.3.0.cl
tags:
- 26.3.0.cl
description: Roles for version 26.3.0.cl
- name: 10.14.0.cl
id: 10.14.0.cl
tags:
- 10.14.0.cl
description: Roles for version 10.14.0.cl
- name: 9.7.0.cl
id: 9.7.0.cl
tags:
- 9.7.0.cl
description: Roles for version 9.7.0.cl