Skip to main content

API Reference Overview

CleverReach offers powerful and flexible APIs that allow you to deeply integrate email marketing and automation features directly into your existing systems, applications, or workflows. This documentation is your portal to understanding and utilizing all available endpoints across our platform.

Whether you are synchronizing your CRM data, automating transactional emails, or building custom subscriber experiences, our APIs provide the robust interactions you need to scale your email marketing efforts programmatically.

Available Endpoints​

Our standard REST APIs cover all major capabilities within the CleverReach platform. Whether you are managing basic subscriber lists or building complex automated workflows, a consistent integration path is provided.

Key capabilities include:

  • Subscriber Management: Create, update, and manage your contacts (receivers) and segmented groups.
  • Campaign Operations: Programmatically draft, send, and analyze email mailings.
  • Reporting & Stats: Retrieve detailed insights into campaign performance, open rates, and bounce statistics.
  • Automated Workflows (Flows): Build and trigger customized subscriber journeys, manage signup/opt-in processes, and handle complex preference center interactions.
  • Account Settings: Manage client configurations, user privileges, and overall account limits.

Depending on the feature being utilized, requests may be routed to our core v3 API or the dedicated Flows API for modern subscriber interactions. You can explore all these features directly via the sidebar navigation.

Getting Started​

Integrating with the CleverReach APIs is straightforward. Both the REST API (v3) and the Flows API utilize the same OAuth 2.0 authentication mechanism, meaning a single access token works across both services.

Quick Start Guide
  1. Create an OAuth App: In your CleverReach account, navigate to Account > Extras > REST API and create a new application to generate your Client ID and Client Secret.
  2. Obtain an Access Token: You can use the "Test Process Now" button within your newly created app to test the OAuth flow and directly receive an access token.
  3. Make Your First Request: Use your token to securely query the API. Here is an example fetching your subscriber groups:
curl -H "Authorization: Bearer ACCESS_TOKEN" https://rest.cleverreach.com/v3/groups
  1. Explore the Endpoints: Browse through the API documentation pages linked above to find specific endpoints, view expected request/response payloads, and try out live requests.

Helpful Resources​

  • API Changelog: Stay informed about new features, endpoint deprecations, and performance improvements by reviewing our Changelog.
  • Developer Guides: Looking for higher-level architectural guidance? Our Guides section covers topics like Authentication, Webhooks, and the My Content Interface.