Zoho Campaigns Python API Docs | dltHub

Zoho Campaigns is an email marketing platform that provides REST APIs to manage campaigns, mailing lists, contacts, and reporting. The REST API base URL is https://campaigns.zoho.com/api/v1.1 and OAuth2 access token (Zoho OAuth) required for API v1.1; include token in request headers..

dlt is an open-source Python library that handles authentication, pagination, and schema evolution automatically. dlthub provides AI context files that enable code assistants to generate production-ready pipelines. Install with uv pip install "dlt[workspace]" and start loading Zoho Campaigns data in under 10 minutes.

---

What data can I load from Zoho Campaigns?

Here are some of the endpoints you can load from Zoho Campaigns:

---

How do I authenticate with the Zoho Campaigns API?

Zoho Campaigns APIs (v1.1) use OAuth2 access and refresh tokens. Requests must include the access token in the Authorization header as 'Authorization: Zoho-oauthtoken <access_token>' (or pass &authtoken for some legacy flows). Scopes for Campaigns include ZohoCampaigns.campaign.READ, contact.READ/CREATE/UPDATE, etc.

1. Get your credentials

1. Sign in to Zoho Campaigns (or Zoho accounts) at https://accounts.zoho.com/.
2. Register a client in Zoho API Console/Developer Console to obtain client_id and client_secret.
3. Use OAuth2 authorization code flow to obtain authorization code (user grants scopes such as ZohoCampaigns.campaign.READ).
4. Exchange authorization code for access_token and refresh_token using Zoho token endpoint.
5. Use the access_token in requests as 'Authorization: Zoho-oauthtoken <access_token>'. Refresh tokens when expired.

2. Add them to .dlt/secrets.toml

Copy
[sources.zoho_campaigns_source]
access_token = "your_oauth_access_token_here"

dlt reads this automatically at runtime — never hardcode tokens in your pipeline script. For production environments, see setting up credentials with dlt for environment variable and vault-based options.

---

How do I set up and run the pipeline?

Set up a virtual environment and install dlt:

Copy
uv venv && source .venv/bin/activate
uv pip install "dlt[workspace]"

1. Install the dlt AI Workbench:

Copy
dlt ai init --agent <your-agent> # <agent>: claude | cursor | codex

This installs project rules, a secrets management skill, appropriate ignore files, and configures the dlt MCP server for your agent. Learn more →

2. Install the rest-api-pipeline toolkit:

Copy
dlt ai toolkit rest-api-pipeline install

This loads the skills and context about dlt the agent uses to build the pipeline iteratively, efficiently, and safely. The agent uses MCP tools to inspect credentials — it never needs to read your secrets.toml directly. Learn more →

3. Start LLM-assisted coding:

Use /find-source to load data from the Zoho Campaigns API into DuckDB.

The rest-api-pipeline toolkit takes over from here — it reads relevant API documentation, presents you with options for which endpoints to load, and follows a structured workflow to scaffold, debug, and validate the pipeline step by step.

4. Run the pipeline:

Copy
python zoho_campaigns_pipeline.py

If everything is configured correctly, you'll see output like this:

Copy
Pipeline zoho_campaigns_pipeline load step completed in 0.26 seconds
1 load package(s) were loaded to destination duckdb and into dataset zoho_campaigns_data
The duckdb destination used duckdb:/zoho_campaigns.duckdb location to store data
Load package 1749667187.541553 is LOADED and contains no failed jobs

Inspect your pipeline and data:

Copy
dlt pipeline zoho_campaigns_pipeline show

This opens the Pipeline Dashboard where you can verify pipeline state, load metrics, schema (tables, columns, types), and query the loaded data directly.

---

Python pipeline example

This example loads mailing_lists and campaigns from the Zoho Campaigns API into DuckDB. It mirrors the endpoint and data selector configuration from the table above:

Copy
import dlt
from dlt.sources.rest_api import RESTAPIConfig, rest_api_resources

@dlt.source
def zoho_campaigns_source(access_token=dlt.secrets.value):
    config: RESTAPIConfig = {
        "client": {
            "base_url": "https://campaigns.zoho.com/api/v1.1",
            "auth": {
                "type": "bearer",
                "token": access_token,
            },
        },
        "resources": [
            {"name": "mailing_lists", "endpoint": {"path": "getmailinglists", "data_selector": "list_of_details"}},
            {"name": "campaigns", "endpoint": {"path": "getcampaigns", "data_selector": "campaigns"}}
        ],
    }
    yield from rest_api_resources(config)


def get_data() -> None:
    pipeline = dlt.pipeline(
        pipeline_name="zoho_campaigns_pipeline",
        destination="duckdb",
        dataset_name="zoho_campaigns_data",
    )
    load_info = pipeline.run(zoho_campaigns_source())
    print(load_info)

To add more endpoints, append entries from the resource table to the "resources" list using the same name, path, and data_selector pattern.

---

How do I query the loaded data?

Once the pipeline runs, dlt creates one table per resource. You can query with Python or SQL.

Python (pandas DataFrame):

Copy
import dlt

data = dlt.pipeline("zoho_campaigns_pipeline").dataset()
sessions_df = data.mailing_lists.df()
print(sessions_df.head())

SQL (DuckDB example):

Copy
SELECT * FROM zoho_campaigns_data.mailing_lists LIMIT 10;

In a marimo or Jupyter notebook:

Copy
import dlt

data = dlt.pipeline("zoho_campaigns_pipeline").dataset()
data.mailing_lists.df().head()

See how to explore your data in marimo Notebooks and how to query your data in Python with dataset.

---

What destinations can I load Zoho Campaigns data to?

dlt supports loading into any of these destinations — only the destination parameter changes:

Change the destination in dlt.pipeline(destination="snowflake") and add credentials in .dlt/secrets.toml. See the full destinations list.

---

Troubleshooting

Authentication failures

If you receive status codes indicating authentication errors (401/403), ensure you are using a valid OAuth2 access token and that the token is sent in the header as 'Authorization: Zoho-oauthtoken '. If using API v1.1, confirm the access token has not expired—use the refresh_token to obtain a new access_token.

Rate limits and throttling

Zoho may enforce rate limits and disable APIs on misuse. If you receive 429 or throttling errors, back off and retry with exponential backoff. Contact support if limits are unexpectedly low.

Pagination quirks

Many v1.1 GET endpoints use resfmt=JSON plus 'fromindex' and 'range' query parameters for pagination. Responses include the requestdetails block and a result array under keys like 'list_of_details', 'campaigns', 'contacts', or 'subscribers'. Adjust fromindex/range to page through results.

Ensure that the API key is valid to avoid 401 Unauthorized errors. Also, verify endpoint paths and parameters to avoid 404 Not Found errors.

---

Next steps

Continue your data engineering journey with the other toolkits of the dltHub AI Workbench:

• data-exploration — Build custom notebooks, charts, and dashboards for deeper analysis with marimo notebooks.
• dlthub-runtime — Deploy, schedule, and monitor your pipeline in production.

Copy
dlt ai toolkit data-exploration install
dlt ai toolkit dlthub-runtime install

• How to deploy a pipeline
• How to explore your data in marimo Notebooks
• How to query your data in Python with dataset
• Join the dlt community on Slack