API Authentication

The Email API uses the API key to provide authentication to access our API functions. An API key is a unique code that helps the developers to interact with the data and functionalities of email API. 

How to generate API key 

The most important step in using this version is you must generate API keys before you can start using Email API.

1. Log in to your Zoho Campaigns account and access the Email API homepage.

2. Click API Keys from the Navigation Toolbar to the left.

3. At the top-right corner, click Create API Key.

4. In the slide-in window that appears, provide the API Key Name.

5. Select the Scope, then click Create.

Note :

• Scope: ZohoCampaigns.emailapi.ALL

• A maximum of 20 API keys can be generated per user.

Calling an API  

Once you've generated the API key, you can start making API calls. To call an API, you must add the below header to your API request

Authorization: Zoho-zapikey <api_key>

API Root Endpoint: https://campaigns.zoho.com/emailapi/v2/

Sample Request  

Request Type:

GET

Request URL:

https://campaigns.zoho.com/emailapi/v2/transmission/2145480000364369

Request Headers:

Content-Type: application/json
Authorization: Zoho-zapikey 1001.a0********0.db**********39