CleverTap Email API
Author: g | 2025-04-25
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 ) After you receive the API Key from CleverTap's onboarding team: Navigate to Settings Email Provider. Select CleverTap Email from the dropdown menu. Enter the provider details shared by CleverTap's onboarding team and click Save. Configure CleverTap Email Provider. For more information, refer to Setup Provider.
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 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 ) 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,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-03Personalization 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-03-30And 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-09The 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-07Select 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
2025-03-31