Zoho CPaaS API Documentation

Zoho CPaaS REST APIs let you send transactional emails from your application and manage your account including templates, domains, agents, suppression lists, and more. You can make voice calls from your application using Voice, SMS, and WhatsApp.

Understanding the REST API

CPaaS APIs are designed based on RESTful architecture. The APIs are organized into resources. Each resource represents a functionality in CPaaS such as email sending, templates, Agents, SMS, Voice, WhatsApp and more. Resources are exposed through HTTP endpoints.

Each endpoint tells you:

• The endpoint URL and supported HTTP methods.

• Required request parameters and body fields.

• Authentication type and OAuth scopes (where applicable).

• Success and failure response details.

For each resource refer to the individual endpoints to create your HTTP request.

OpenAPI specification

CPaaS APIs are available as an OpenAPI document. This is a machine-readable specification that works with OpenAPI-compatible tools. You can use this document to:

• Import the APIs into tools such as Postman.

• Auto-generate client SDKs for your preferred language.

• Test endpoints before integrating them into your application.

Before you begin

Follow these steps to get started with CPaaS API:

1. Sign up for CPaaS.

2. Add and verify your sending domain. Go to Domains in the CPaaS dashboard to do this.

3. Create an Agent.

4. Generate an API key from the Agent's SMTP/API tab.

5. Make your first API call using the base URL for your account's region.

API Groups