Download CleverTap Email API
Author: f | 2025-04-23
Contribute to CleverTap/clevertap-server-api-examples development by creating an account on GitHub. one of email, identity or CleverTap objectID if email is None and identity is None and objectId is None: raise Exception( profile requires one of email, identity or objectId ) Contribute to CleverTap/clevertap-server-api-examples development by creating an account on GitHub. one of email, identity or CleverTap objectID if email is None and identity is None and objectId is None: download profiles defined by query return self._fetch_records( profiles, query, batch_size=batch_size)
Compare CleverTap vs Netcore Email API 2025
Messaging Template PartnerOverviewTaxi for Email, a collaborative platform, streamlines the design and coding of email campaigns, enabling teams to create consistent, high-quality emails without the need for extensive coding knowledge. CleverTap integrates with Taxi for Email to:Design, code, and manage email templates using Taxi for Email, which also enables collaborative editing, live previews, approval workflows, template management, and version control, ensuring compatibility across email clients.Segment audiences, personalize content, and execute campaigns on the CleverTap dashboard, effectively targeting the right users with tailored messages.📘Enable CleverTap Connector on Taxi For EmailTo activate the CleverTap connector for Taxi For Email, contact the Taxi For Email support team or your account manager directly from the platform or send an email to [email protected] to submit a request.Prerequisites for IntegrationThe following are the prerequisites:A Taxi for Email account with all the required setup and permissions to export email templates. A CleverTap account.Steps for integrationThe integration involves the following three main steps:Configure Taxi for Email Dashboard.Set Up Personalization.Export Email Templates from Taxi For Email Dashboard to CleverTap.Configure Taxi for Email DashboardAdd CleverTap credentials on the Taxi for Email dashboard:Navigate to Integrations > ESP Connectors from the dashboard and click Add New.Add New ConnectorSelect CleverTap from the Connector type dropdown. Select Connector TypeEnter the following details:Integrate CleverTap ConnectorAccount ID : Locate the Project ID under Settings > Project from the CleverTap dashboard.Passcode: Locate Passcode under Settings > Project from the CleverTap dashboard. To know more, refer to Account Passcode.Region: Locate Region for the API endpoint you want to
Compare CleverTap vs. Netcore Email API - G2
Personalization reflects under the email editor on the CleverTap dashboard.Export Email Templates to CleverTapAfter setting up the template on the Taxi for Email, you can export the email templates to CleverTap:Select the version of the Template to be exported to the CleverTap dashboard and click Export Mailing. Export MailingSelect the API name provided in step 1 under ESP Connectors. ESP ConnectorAfter selecting the ESP connector, a new window opens for you to select the template type.Select Create a new template to export a new template to CleverTap. To update an existing CleverTap template, select Update an existing template and select a template from the drop-down menu.Create a New Template🚧ImportantEnsure that the Template Name is unique when exporting new templates to avoid errors.Under Segmentation, select the version(s) that needs to be exported.Send one version: Choose to export only a single version of the content.Create (or update) a template for each version: Generate or modify templates for each selected version.Export or Create (or Update) a Particular Template VersionClick Start Export to export the email template to the CleverTap dashboard.Start ExportCreate a Campaign on CleverTap Using Taxi for Email TemplateTo create an email campaign on CleverTap using the Taxi for Email template:Navigate to the Campaigns page, click + Campaign, and select Email from the list of messaging channels. Click Go to Editor under the When section and select Saved Templates. Select the template you exported from the Taxi for Email dashboard. CleverTap Saved Email TemplatesOnce you create a campaign on the CleverTap dashboard,CleverTap/clevertap-server-api-examples - GitHub
If the user agrees to share their IP data (function () { var wzrk = document.createElement('script'); wzrk.type = 'text/javascript'; wzrk.async = true; wzrk.src = ' var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(wzrk, s); })();</script>Send User ProfileTo send user profile details to CleverTap, add the following code snippet:JavaScriptclevertap.onUserLogin.push({ "Site": { "Name": "Jack Montana", // String "Identity": 61026032, // String or number "Email": "[email protected]", // Email address of the user }})Push EventTo push an event to CleverTap, add the following code snippet:JavaScriptclevertap.event.push("Product viewed");Push Event With PropertiesTo push the event along with properties to CleverTap, add the following code snippet:JavaScriptclevertap.event.push("Product viewed", { "Product name": "Casio Chronograph Watch", "Category": "Mens Accessories", "Price": 59.99, "Date": new Date()});Add Profile PropertiesTo add the profile properties, add the following code snippet:JavaScriptcleverTapAPI.addMultiValueForKey("userTVCount","1")Remove Profile PropertiesTo remove the profile properties, add the following code snippet:JavaScriptcleverTapAPI.removeMultiValueForKey("userTVCount","1")" data-testid="RDMD">CleverTap Web SDK integration with LG webOS TV enables you to improve user engagement and personalize the experience for your TVOS viewers. You can gain insights into user behavior, preferences, and interactions with your TV app.This guide walks you through the step-by-step process of installing and integrating CleverTap's Web SDK into your LG webOS application.To integrate CleverTap Web SDK with LG webOS TV:Install LG webOS Command Line Interface (CLI). For more information, refer to the LG CLI Installation document.Add the extension for webOS TV in Visual Studio Code from the VSCode Extension Marketplace.Install the LG Simulator. For more information, refer to the LG Simulator Installation document. Create the sample application as follows: Using VSCode: App DevelopmentUsing CLI: App. Contribute to CleverTap/clevertap-server-api-examples development by creating an account on GitHub. one of email, identity or CleverTap objectID if email is None and identity is None and objectId is None: raise Exception( profile requires one of email, identity or objectId ) Contribute to CleverTap/clevertap-server-api-examples development by creating an account on GitHub. one of email, identity or CleverTap objectID if email is None and identity is None and objectId is None: download profiles defined by query return self._fetch_records( profiles, query, batch_size=batch_size)Compare CleverTap vs Netcore Email API 2025 - TrustRadius
And the personalization reflects under the email editor on the CleverTap dashboard.After setting up the template on the Taxi for Email, you can export the email templates to CleverTap:Select the version of the Template to be exported to the CleverTap dashboard and click Export Mailing. Export MailingSelect the API name provided in step 1 under ESP Connectors. ESP ConnectorAfter selecting the ESP connector, a new window opens for you to select the template type.Select Create a new template to export a new template to CleverTap. To update an existing CleverTap template, select Update an existing template and select a template from the drop-down menu.Create a New Template🚧ImportantEnsure that the Template Name is unique when exporting new templates to avoid errors.Under Segmentation, select the version(s) that needs to be exported.Send one version: Choose to export only a single version of the content.Create (or update) a template for each version: Generate or modify templates for each selected version.Export or Create (or Update) a Particular Template VersionClick Start Export to export the email template to the CleverTap dashboard.Start ExportTo create an email campaign on CleverTap using the Taxi for Email template:Navigate to the Campaigns page, click + Campaign, and select Email from the list of messaging channels. Click Go to Editor under the When section and select Saved Templates. Select the template you exported from the Taxi for Email dashboard. CleverTap Saved Email TemplatesOnce you create a campaign on the CleverTap dashboard, follow the remaining steps listed under the Create Email Campaign sectionLinked Content for Email - CleverTap
The API endpoint you want to select under Settings > Project from the CleverTap dashboard. To identify the region for your account, refer to the following table:Locate Project ID and Region on CleverTap DashboardDefault From Name and Email: Adding a default From Name and Email address ensures recipients can recognize your emails easily. You can also change this information while exporting the email templates to CleverTap.Default Reply To Name and Email: Adding a default name and email address for replies ensures that your emails always have the correct details, saving time and preventing mistakes by automatically populating these fields.📘NoteCurrently, we do not save Reply to Name and Email address. CleverTaps sends the email as per the settings configured under the Provider Setup page.Click Save Details & Continue.CleverTap supports personalization using Liquid tags. To use Liquid tags for personalization in CleverTap, you must first set up personalization in Taxi for Email:Navigate to Dynamic Content > Personalization from the Taxi for Email dashboard, and select Add Field.Map the labels to the API default values saved in step 1. For example, the Label can be mapped to a Default Value of ABC, which can be mapped to CleverTap's Liquid Tag, that is, {{ Profile.name | default:"ABC" }}Select the project to which the personalization must be added, add the mapped Label in the template with the appropriate text, and click Save Changes. 📘NoteIf a tag does not have the required personalization information, Taxi for Email sends a default value to CleverTap.Adding PersonalizationSelect Export MailingGroup Unsubscribe for Email - CleverTap
Development In the sample application, update the index.htmlfile as required. Add the CleverTap script in the index.html file.Open the simulator.app file inside the Simulator folder, as mentioned in Step 2.In Simulator, go to File > Launch App and select the folder of sampleApp, which has .ipk fileTo initialize CleverTap, add the CleverTap script in the index.html file. var clevertap = {event:[], profile:[], account:[], onUserLogin:[], notifications:[], privacy:[]}; // replace with the CLEVERTAP_ACCOUNT_ID with the actual ACCOUNT ID value from your Dashboard -> Settings pageclevertap.account.push({"id": "CLEVERTAP_ACCOUNT_ID"});clevertap.privacy.push({optOut: false}); //set the flag to true, if the user of the device opts out of sharing their dataclevertap.privacy.push({useIP: false}); //set the flag to true, if the user agrees to share their IP data (function () { var wzrk = document.createElement('script'); wzrk.type = 'text/javascript'; wzrk.async = true; wzrk.src = ' var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(wzrk, s); })();To send user profile details to CleverTap, add the following code snippet:clevertap.onUserLogin.push({ "Site": { "Name": "Jack Montana", // String "Identity": 61026032, // String or number "Email": "[email protected]", // Email address of the user }})To push an event to CleverTap, add the following code snippet:clevertap.event.push("Product viewed");To push the event along with properties to CleverTap, add the following code snippet:clevertap.event.push("Product viewed", { "Product name": "Casio Chronograph Watch", "Category": "Mens Accessories", "Price": 59.99, "Date": new Date()});To add the profile properties, add the following code snippet:cleverTapAPI.addMultiValueForKey("userTVCount","1")To remove the profile properties, add the following code snippet:cleverTapAPI.removeMultiValueForKey("userTVCount","1")Updated over 1 year ago Table of ContentsOverviewSteps to Integrate CleverTap Web SDK for LG webOS TVInitialize CleverTap SDKSend UserNew APIs for Messaging and Analytics - CleverTap
Select under Settings > Project from the CleverTap dashboard. To identify the region for your account, refer to the following table:RegionCleverTap Dashboard URLaps3 Project ID and Region on CleverTap DashboardDefault From Name and Email: Adding a default From Name and Email address ensures recipients can recognize your emails easily. You can also change this information while exporting the email templates to CleverTap.Default Reply To Name and Email: Adding a default name and email address for replies ensures that your emails always have the correct details, saving time and preventing mistakes by automatically populating these fields.📘NoteCurrently, we do not save Reply to Name and Email address. CleverTaps sends the email as per the settings configured under the Provider Setup page.Click Save Details & Continue.Set Up PersonalizationCleverTap supports personalization using Liquid tags. To use Liquid tags for personalization in CleverTap, you must first set up personalization in Taxi for Email:Navigate to Dynamic Content > Personalization from the Taxi for Email dashboard, and select Add Field.Map the labels to the API default values saved in step 1. For example, the Label can be mapped to a Default Value of ABC, which can be mapped to CleverTap's Liquid Tag, that is, {{ Profile.name | default:"ABC" }}Select the project to which the personalization must be added, add the mapped Label in the template with the appropriate text, and click Save Changes. 📘NoteIf a tag does not have the required personalization information, Taxi for Email sends a default value to CleverTap.Adding PersonalizationSelect Export Mailing and the. Contribute to CleverTap/clevertap-server-api-examples development by creating an account on GitHub. one of email, identity or CleverTap objectID if email is None and identity is None and objectId is None: raise Exception( profile requires one of email, identity or objectId )
Profile APIs - CleverTap Developer Docs
Follow the remaining steps listed under the Create Email Campaign section and publish the campaign." data-testid="RDMD">Taxi for Email, a collaborative platform, streamlines the design and coding of email campaigns, enabling teams to create consistent, high-quality emails without the need for extensive coding knowledge. CleverTap integrates with Taxi for Email to:Design, code, and manage email templates using Taxi for Email, which also enables collaborative editing, live previews, approval workflows, template management, and version control, ensuring compatibility across email clients.Segment audiences, personalize content, and execute campaigns on the CleverTap dashboard, effectively targeting the right users with tailored messages.📘Enable CleverTap Connector on Taxi For EmailTo activate the CleverTap connector for Taxi For Email, contact the Taxi For Email support team or your account manager directly from the platform or send an email to [email protected] to submit a request.The following are the prerequisites:A Taxi for Email account with all the required setup and permissions to export email templates. A CleverTap account.The integration involves the following three main steps:Configure Taxi for Email Dashboard.Set Up Personalization.Export Email Templates from Taxi For Email Dashboard to CleverTap.Add CleverTap credentials on the Taxi for Email dashboard:Navigate to Integrations > ESP Connectors from the dashboard and click Add New.Add New ConnectorSelect CleverTap from the Connector type dropdown. Select Connector TypeEnter the following details:Integrate CleverTap ConnectorAccount ID : Locate the Project ID under Settings > Project from the CleverTap dashboard.Passcode: Locate Passcode under Settings > Project from the CleverTap dashboard. To know more, refer to Account Passcode.Region: Locate Region forAPI Overview - CleverTap Developer Docs
O melhor momento para enviar e-mails até a forma mais efetiva de entregar recomendações preditivas aos clientes. Acesse informações dinâmicas do produto e torne as mensagens de e-mail personalizadas com dados disponíveis fora da plataforma CleverTap. Capacidade de Entrega Alcance uma alta taxa de entrega com a consultoria de Aquecimento de IP, monitoramento e revisões mensais. Receba recomendações personalizadas para melhorar a sua capacidade de alcance*. Análise de Resultados Avalie os resultados das campanhas de e-mail por meio de análises como rastreamento em tempo real, receita e mensuração de impacto. *Disponível com o Plano Expert Services CleverTap is our go-to platform to engage customers with email, push notifications, SMS, in-app messages, and more. We use the platform to design and personalize emails, bringing more users back to the app and website.” Jeanette Wong, CRM Lead Veja o que nossos clientes conseguiram usando o e-mail CleverTap 54%DE AUMENTO NA TAXA DE ABERTURA DE E-MAILS Saiba mais. Contribute to CleverTap/clevertap-server-api-examples development by creating an account on GitHub. one of email, identity or CleverTap objectID if email is None and identity is None and objectId is None: raise Exception( profile requires one of email, identity or objectId ) Contribute to CleverTap/clevertap-server-api-examples development by creating an account on GitHub. one of email, identity or CleverTap objectID if email is None and identity is None and objectId is None: download profiles defined by query return self._fetch_records( profiles, query, batch_size=batch_size)API Reference - CleverTap Developer Docs
Learn how to integrate CleverTap Web SDK for apps on LG webOS TVOverviewCleverTap Web SDK integration with LG webOS TV enables you to improve user engagement and personalize the experience for your TVOS viewers. You can gain insights into user behavior, preferences, and interactions with your TV app.This guide walks you through the step-by-step process of installing and integrating CleverTap's Web SDK into your LG webOS application.Steps to Integrate CleverTap Web SDK for LG webOS TVTo integrate CleverTap Web SDK with LG webOS TV:Install LG webOS Command Line Interface (CLI). For more information, refer to the LG CLI Installation document.Add the extension for webOS TV in Visual Studio Code from the VSCode Extension Marketplace.Install the LG Simulator. For more information, refer to the LG Simulator Installation document. Create the sample application as follows: Using VSCode: App DevelopmentUsing CLI: App Development In the sample application, update the index.htmlfile as required. Add the CleverTap script in the index.html file.Open the simulator.app file inside the Simulator folder, as mentioned in Step 2.In Simulator, go to File > Launch App and select the folder of sampleApp, which has .ipk fileInitialize CleverTap SDKTo initialize CleverTap, add the CleverTap script in the index.html file.HTML<script type="text/javascript"> var clevertap = {event:[], profile:[], account:[], onUserLogin:[], notifications:[], privacy:[]}; // replace with the CLEVERTAP_ACCOUNT_ID with the actual ACCOUNT ID value from your Dashboard -> Settings pageclevertap.account.push({"id": "CLEVERTAP_ACCOUNT_ID"});clevertap.privacy.push({optOut: false}); //set the flag to true, if the user of the device opts out of sharing their dataclevertap.privacy.push({useIP: false}); //set the flag to true,Comments
Messaging Template PartnerOverviewTaxi for Email, a collaborative platform, streamlines the design and coding of email campaigns, enabling teams to create consistent, high-quality emails without the need for extensive coding knowledge. CleverTap integrates with Taxi for Email to:Design, code, and manage email templates using Taxi for Email, which also enables collaborative editing, live previews, approval workflows, template management, and version control, ensuring compatibility across email clients.Segment audiences, personalize content, and execute campaigns on the CleverTap dashboard, effectively targeting the right users with tailored messages.📘Enable CleverTap Connector on Taxi For EmailTo activate the CleverTap connector for Taxi For Email, contact the Taxi For Email support team or your account manager directly from the platform or send an email to [email protected] to submit a request.Prerequisites for IntegrationThe following are the prerequisites:A Taxi for Email account with all the required setup and permissions to export email templates. A CleverTap account.Steps for integrationThe integration involves the following three main steps:Configure Taxi for Email Dashboard.Set Up Personalization.Export Email Templates from Taxi For Email Dashboard to CleverTap.Configure Taxi for Email DashboardAdd CleverTap credentials on the Taxi for Email dashboard:Navigate to Integrations > ESP Connectors from the dashboard and click Add New.Add New ConnectorSelect CleverTap from the Connector type dropdown. Select Connector TypeEnter the following details:Integrate CleverTap ConnectorAccount ID : Locate the Project ID under Settings > Project from the CleverTap dashboard.Passcode: Locate Passcode under Settings > Project from the CleverTap dashboard. To know more, refer to Account Passcode.Region: Locate Region for the API endpoint you want to
2025-04-23Personalization reflects under the email editor on the CleverTap dashboard.Export Email Templates to CleverTapAfter setting up the template on the Taxi for Email, you can export the email templates to CleverTap:Select the version of the Template to be exported to the CleverTap dashboard and click Export Mailing. Export MailingSelect the API name provided in step 1 under ESP Connectors. ESP ConnectorAfter selecting the ESP connector, a new window opens for you to select the template type.Select Create a new template to export a new template to CleverTap. To update an existing CleverTap template, select Update an existing template and select a template from the drop-down menu.Create a New Template🚧ImportantEnsure that the Template Name is unique when exporting new templates to avoid errors.Under Segmentation, select the version(s) that needs to be exported.Send one version: Choose to export only a single version of the content.Create (or update) a template for each version: Generate or modify templates for each selected version.Export or Create (or Update) a Particular Template VersionClick Start Export to export the email template to the CleverTap dashboard.Start ExportCreate a Campaign on CleverTap Using Taxi for Email TemplateTo create an email campaign on CleverTap using the Taxi for Email template:Navigate to the Campaigns page, click + Campaign, and select Email from the list of messaging channels. Click Go to Editor under the When section and select Saved Templates. Select the template you exported from the Taxi for Email dashboard. CleverTap Saved Email TemplatesOnce you create a campaign on the CleverTap dashboard,
2025-04-22And the personalization reflects under the email editor on the CleverTap dashboard.After setting up the template on the Taxi for Email, you can export the email templates to CleverTap:Select the version of the Template to be exported to the CleverTap dashboard and click Export Mailing. Export MailingSelect the API name provided in step 1 under ESP Connectors. ESP ConnectorAfter selecting the ESP connector, a new window opens for you to select the template type.Select Create a new template to export a new template to CleverTap. To update an existing CleverTap template, select Update an existing template and select a template from the drop-down menu.Create a New Template🚧ImportantEnsure that the Template Name is unique when exporting new templates to avoid errors.Under Segmentation, select the version(s) that needs to be exported.Send one version: Choose to export only a single version of the content.Create (or update) a template for each version: Generate or modify templates for each selected version.Export or Create (or Update) a Particular Template VersionClick Start Export to export the email template to the CleverTap dashboard.Start ExportTo create an email campaign on CleverTap using the Taxi for Email template:Navigate to the Campaigns page, click + Campaign, and select Email from the list of messaging channels. Click Go to Editor under the When section and select Saved Templates. Select the template you exported from the Taxi for Email dashboard. CleverTap Saved Email TemplatesOnce you create a campaign on the CleverTap dashboard, follow the remaining steps listed under the Create Email Campaign section
2025-04-10The API endpoint you want to select under Settings > Project from the CleverTap dashboard. To identify the region for your account, refer to the following table:Locate Project ID and Region on CleverTap DashboardDefault From Name and Email: Adding a default From Name and Email address ensures recipients can recognize your emails easily. You can also change this information while exporting the email templates to CleverTap.Default Reply To Name and Email: Adding a default name and email address for replies ensures that your emails always have the correct details, saving time and preventing mistakes by automatically populating these fields.📘NoteCurrently, we do not save Reply to Name and Email address. CleverTaps sends the email as per the settings configured under the Provider Setup page.Click Save Details & Continue.CleverTap supports personalization using Liquid tags. To use Liquid tags for personalization in CleverTap, you must first set up personalization in Taxi for Email:Navigate to Dynamic Content > Personalization from the Taxi for Email dashboard, and select Add Field.Map the labels to the API default values saved in step 1. For example, the Label can be mapped to a Default Value of ABC, which can be mapped to CleverTap's Liquid Tag, that is, {{ Profile.name | default:"ABC" }}Select the project to which the personalization must be added, add the mapped Label in the template with the appropriate text, and click Save Changes. 📘NoteIf a tag does not have the required personalization information, Taxi for Email sends a default value to CleverTap.Adding PersonalizationSelect Export Mailing
2025-04-21