⚠️ API v1 is deprecated

This version of the API is no longer actively maintained and may be discontinued in the future.

Please migrate to API v3 which uses OAuth authentication and provides enhanced features and better REST compliance.

⚠️ API v2 is deprecated

This version of the API is no longer actively maintained and may be discontinued in the future.

Please migrate to API v3 which uses OAuth authentication and provides enhanced features and better REST compliance.

Using the CleverReach REST API  v1  v2  v3


Not sure how to use our API?
Click here to get a brief tour and some REST examples.
Sending the Accces Token
In addition to sending the access token via the GET parameter, you can also send the access token as the Authorization HTTP Header
(example: Authorization: Bearer h0lYjW770KeNi4m847m4N...)

v3: 

Type Date Description
IMPORTANT - Make sure you use a REST V3 token to use REST V3!
IMPORTANT - Token is only to be retrieved using OAuth (How do I use OAuth?)
CHANGE - Return types: To be more REST compliant, always return the correct and same data type
NEW - Section debug containing the ttl and whoami funcionality
NEW - Token scopes. V3 tokens contain scopes to limit usage to certain parts of the API
NEW - GET /v3/clients/{id}/receivercount: get count of receivers of a certain client
NEW - GET /v3/clients/{id}/activereceivercount: get count of active receivers of a certain client
NEW - GET /v3/clients/{id}/contingent: get available amount of mails to send for a client
NEW - GET /v3/clients/{id}/invoiceaddress: gets invoice address of a client
NEW - GET /v3/clients/{id}/nextinvoicedate: gets date of the next invoice as timestamp
NEW - GET /v3/clients/{id}/plan: gets the name of the current plan of the client
NEW - POST /v3/clients/createAccount: create an account within your agency account *
NEW - POST /v3/blacklist/validate: filter list of emails to valid ones
NEW - PUT /v3/blacklist: update an entry of blacklist
NEW - POST /v3/forms/{group_id}/createfromtemplate/{type}: creates a form by using a template
NEW - GET /v3/receivers/bounced: get all bounces of the account
NEW - POST /v3/receivers/{id}/clone: clone a receiver and change the email of the clone
NEW - PUT /v3/receivers/{id}/email: change email of a receiver
NEW - PUT /v3/receivers/{pool_id}/orders/{id}: update an order item
NEW - POST /v3/mailings/{id}/release: release a mailing to be sent *
NEW - POST /v3/mailings/{id}/stop: stop a released mailing if not already sent *
NEW - POST /v3/groups/{group_id}/receivers/upsertplus: like upsert but with manipulation certain data values
NEW - DELETE /v3/groups/{id}/clear: clears the given group
NEW 2024/11 GET /v3/receivers/bounced: now supports and enforces pagination
NEW 2025/06 POST /v3/groups/{id}/get_receivers: alternative route for /groups/{id}/receivers to handle big email_list/id_list parameters
CHANGE 2026/02 POST /v3/mailings/, PUT /v3/mailings/{id}, POST /v3/mailings/template: new email editor (setup_v2) is now the default
* needs special permission by CleverReach

v2:

Method Endpoint Description
DELETE /v2/groups/{id}/receivers DISABLED because missing pool_id in DELETE /v2/groups/{id}/receivers/{pool_id} could clear a whole group.
DELETE /v2/groups/{id}/truncate New function: clear a whole group
GET /v2/clients/ Change: Always return a array
GET /v2/clients/whoami New function: Get Information about the current client
GET /v2/clients/{id}/token New function: Get JWT token for the desired client

v1:

First Release

 
Imprint