At a glance
- Availability: Experimental (how to enable).
- Auth: OAuth 2.0.
- Connection: A user authorizes the connection in the provider’s consent screen.
- Docs: https://developers.cleverreach.com/api/authentication/
Credentials
Set these per environment. See Connect an integration. With a managed OAuth app, Connect works without these variables; set them to use your own OAuth app instead.Setup
- Create a CleverReach account: Sign up at cleverreach.com - the free Lite plan (up to 250 recipients) is enough for development and testing.
- Create an OAuth app: In your CleverReach account go to Account > Extras > REST API and create an OAuth app. Note the Client ID and Client Secret it contains, and register your redirect (callback) URL.
- Store the credentials and connect: Set CLEVERREACH_CLIENT_ID and CLEVERREACH_CLIENT_SECRET, then complete the OAuth authorization-code flow: the user logs in at the CleverReach consent screen and the returned code is exchanged for an access token.
- The authorization request must include the extra parameter grant=basic alongside client_id, response_type=code, and redirect_uri.
- Access tokens are long-lived (expires_in in the token response, for example 31536000 seconds) and a refresh_token is issued for renewing them via grant_type=refresh_token.
- Each OAuth token is scoped to the CleverReach account that authorized the app; the app’s permissions are configured on the OAuth app itself rather than via per-request scopes.
Tools
| Tool | Access | Description |
|---|---|---|
| List Groups | Read | List CleverReach groups (recipient lists) so agents can find a group ID before reading or adding recipients |
| List Group Receivers | Read | List the receivers (recipients) of a CleverReach group, with paging and email filters |
| Add Receiver | Write | Add (subscribe) a new receiver to a CleverReach group |
| List Mailings | Read | List CleverReach mailings (email campaigns) filtered by state, such as drafts or finished mailings |
| Create Mailing Draft | Write | Create a new CleverReach mailing as a draft with subject, sender, and HTML/text content; sending is triggered separately |
| Get Mailing | Read | Get a single mailing by ID, e.g. to inspect a draft created with Create Mailing Draft |
| Deactivate Receiver | Write | Deactivate (unsubscribe) a receiver in a group by ID or email - the counterpart to Add Receiver for unsubscribe handling |
| Get Group Stats | Read | Get list health statistics for a group: active, inactive, and bounced receiver counts |
Example prompts
- List my CleverReach groups and summarize each list, then show the most recent receivers of the largest group.
- Create a CleverReach mailing draft for my main recipient group with a subject and HTML content I describe, and report the draft ID.