Getting Started with Email API
Welcome to Zoho Campaigns Email API!
This app is a part of Zoho Campaigns. You'll be using the APIs available for this app purely for performing mail delivery related tasks. Zoho Campaigns Email API is a console consisting of modules displaying essential information. You can also perform non-API related operations within this app, which we'll discuss further in.
Please make use of this link to access the API Documentation for Zoho Campaigns Email API.Signing up for Zoho Campaigns Email API
In order to open an account with Zoho Campaigns Email API, you need to create an account with Zoho first.
To create an account in the US DC of Zoho, please go to https://accounts.zoho.com and register by filling in the necessary details. We recommend you provide a strong password which includes at least a numeral, a special character, a letter in caps, and more than eight characters long. We also strongly advise you to set up Two-Factor Authentication (TFA) to make your account even more secure. Learn more about registering for an account
After registering for an account, you can access Zoho Campaigns Email API by making use of https://campaigns.zoho.com.
Currently, this is in early access. We will enable you to use Zoho Campaigns Email API based on user request. Once you have registered for an account, or if you already have an account, with Zoho, you can create an account in Zoho Campaigns first and contact us at support@zohocampaigns.com requesting to make use of this app. We will enable it from our end. Soon, we will provide an option to sign up for Zoho Campaigns Email API directly instead of making you contact us.
If you use Zoho Campaigns Email API for that same organization/portal, you'd not be able to use Zoho Campaigns. You can either use one of the two but not both in the same portal. This means you'd have to create a new portal under the same email address for using Zoho Campaigns. It is not possible to switch to Zoho Campaigns midway through using Zoho Campaigns Email API as well.
Pricing
Currently, there is only one pricing plan for Email API. It is called the PREPAID plan. We'll show you the credits remaining or used within the app, so you can have a constant lookout.
As the name suggests, you'll first purchase the credits that you plan to use. Once the purchase is successful, you can start calling APIs. If you opt for this plan, we'll show you the credits remaining within the app. For example, if you purchase 1,000 credits and use the first credit, you will see the text "999 credits remaining" at the top-right corner of the app.
Setting up Zoho Campaigns Email API
As you'll be signing up for this app from Zoho Campaigns, you have to add your company and personal information there.
Click Settings (Gear shaped icon) at the top right.
Under the General section, you can access:
Profile – Add name, email address, country, region, and city details.
Company Details – Add company name, mail address, website address, phone number, and brand logo.
Once you've set up the company details, you can contact our support team (support@zohocampaigns.com) and we'll enable Zoho Campaigns Email API.
Dashboard
After accessing Email API, you will see the Dashboard as the first screen.
It may not show data if APIs haven't been used yet. You'll first need to use APIs before you can begin to see data populated. Dashboard comprises various components, such as:
It may not show data if APIs haven't been used yet. You'll first need to use APIs before you can begin to see data populated. Dashboard comprises various components, such as:
- Navigation Toolbar
- Plan Details
- Notifications
- Profile
- More Actions
- General Mail Stats
- Bounce Stats
- Spam Stats
- API Failed Stats
- Summary Graph
Domains
Inside the Domains module, you can perform functions related to your domain, including adding new domains, making a domain as default, authenticating your email domain, and authenticating your tracking domain.
You will need to authenticate your domains when setting up Email API in order to use our APIs for the mail deliver actions. We recommend that you do this before you do anything else.
You can manually add and authenticate your domains via API as well as from within this module in Email API.
There will be two sections inside this module viz., Email Domain and Tracking Domain. Email Domain and Tracking Domain are independent of each other. If you add a domain in Email Domain, it won't get added to Tracking Domain as well, and vice-versa.
Sender APIs
Sender APIs is the place where you can make use of an authentication mechanism to connect Zoho Campaigns Email API with your application and send emails using our APIs. We provide both REST API and SMTP API as methods of integration. Email API uses the OAuth 2.0 mechanism for authentication and authorization.
OAuth 2.0 is an authorization framework that allows third-party applications to obtain limited access to user resources without exposing their credentials. It provides secure, token-based access, enabling users to grant permissions to apps and services in a standardized and controlled manner.
The steps for the setup process would be present in the section.
SMTP stands for Simple Mail Transfer Protocol. It is a protocol used in sending and receiving emails across the internet. There is no separate authentication mechanism for SMTP. The same token generated by OAuth 2.0 authentication can be used. Learn more about SMTP setup
Suppression List
Suppression List is one of the most important modules in Email API. A suppression list is a list consisting of those email addresses that do not wish to receive any more future email campaigns from you. It's important to maintain a suppression list, as it offers several uses, including:
- Maintaining the reputation of your domain
- Maintaining the reputation of your IP
- Sending emails to only the intended recipients
Within Email API, you can add recipients to the suppression list via API and also manually. You can also manually add multiple recipients at once to this list. There can only be one suppression list. Learn more about the suppression list
Recipient List
As the name suggests, this module is used for storing lists containing recipient details that have been obtained either via API or by manual addition. Unlike the suppression list, there can be more than one recipient list with each list consisting of many recipients. Using API, you can get the recipient lists, get the details of the recipients in a particular list, create a recipient list, and so on.
Template List
Template List module is used for storing the email templates that you use when sending email campaigns via API. You can create a new template, edit an existing template, and get the details of a template by using the template related APIs.
Zoho CRM Training Programs
Learn how to use the best tools for sales force automation and better customer engagement from Zoho's implementation specialists.
Zoho DataPrep Personalized Demo
If you'd like a personalized walk-through of our data preparation tool, please request a demo and we'll be happy to show you how to get the best out of Zoho DataPrep.
- Zoho Workerly Home
- Forums
- Connect With Us:
- Zoho Recruit Home
- Forums
- Connect With Us:
New to Zoho CRM Plus?
Deliver unforgettable customer experiences
New to Zoho CRM Plus?
Deliver unforgettable customer experiences
New to Zoho Marketing Plus?
Everything you need to run your marketing
New to Zoho Marketing Plus?
Everything you need to run your marketing
You are currently viewing the help pages of Qntrl’s earlier version. Click here to view our latest version—Qntrl 3.0's help articles.
New to Zoho Survey?
Zoho Sheet Resources
Zoho Forms Resources
New to Zoho Sign?
Zoho Sign Resources
Sign, Paperless!
New to Zoho TeamInbox?
Zoho TeamInbox Resources
New to Zoho ZeptoMail?
Zoho DataPrep Resources
Design. Discuss. Deliver.
New to Zoho Workerly?
New to Zoho Recruit?
New to Zoho CRM?
New to Zoho Projects?
New to Zoho Sprints?
New to Zoho Assist?
New to Bigin?
Related Articles
Getting to know about Zoho Campaigns Email API
What is Zoho Campaigns Email API? Zoho Campaigns Email API is an app that uses API (Application Programming Interface) to perform tasks related to email sending. The tasks can range from sending emails to generating delivery related reports. Note ...Getting started with email deliverability
Identifying the needs and interests of contacts and conceptualizing email campaigns around those are part and parcel of a marketer's daily routine. Sometimes marketers may assume that crafting a compelling campaign alone will help them hit their ...Create an email campaign
Email marketing is considered the simple and most effective method to reach out to your leads and contacts. The best part is that the return on investment (ROI) is much higher than other marketing channels making it the most affordable way of ...Litmus Email Test
Test how your email content looks in various email clients and devices by running a Litmus test. This test will help you see how well your content renders across different platforms so you can optimize your content to be responsive in the platforms ...Migrate your email marketing to Zoho Campaigns
If you've landed up on this document, you've either decided to switch to a new email service provider or contemplating the idea of switching. If you've shortlisted Zoho Campaigns, there is a good possibility that you've evaluated the features, ...
New to Zoho LandingPage?
Zoho LandingPage Resources