TouchBasePro API Documentation
This is the complete API documentation for connecting to the TouchBasePro API using MindCloud's Universal API. If you are new to MindCloud, start with the Introduction to see how one API can sit in front of many different apps.
MindCloud is an integration company that offers one normalized API to access 3,100+ apps from a single place. It cleans up provider-specific quirks, keeps requests and responses consistent, and centralizes authentication so you do not need to manage separate flows for every app. Browse other apps.
Meet TouchBasePro: Manage email campaigns, SMS messaging, and email validation. Keep reading to get started.
Quickstart
Before you run your first TouchBasePro request, you need three things:
- A MindCloud account — sign in or create an account at MindCloud.
- A MindCloud API Key — create one in API Keys. Keep it on your server.
- At least one TouchBasePro connection — create or choose one in Connections. Note its
connectionId.
Every TouchBasePro action uses the same URL pattern:
https://connect.mindcloud.co/v1/universal/touchBasePro/latest/actions/{actionSlug}You need a MindCloud API Key and a TouchBasePro connection. Then call an action such as Download Validation Result:
curl --request GET \
--url "https://connect.mindcloud.co/v1/universal/touchBasePro/latest/actions/download-validation-result" \
--header "Authorization: Bearer $MINDCLOUD_API_KEY" \
--get \
--data-urlencode "connectionId=$CONNECTION_ID"Every response comes back in the same envelope, with your rows in a data array:
{
"success": true,
"data": [
{ "id": "1042", "name": "Ava" }
],
"meta": {}
}After your first request works, use Shape your requests to control arguments, pagination, filtering, fields, and errors.
Authentication
Authentication has two layers. Your MindCloud API Key authenticates the request to MindCloud, sent as a Bearer token in the Authorization header. The connectionId selects the connected TouchBasePro account that should run the action. MindCloud stores and refreshes the TouchBasePro credentials behind that connection, so you never send provider tokens with your requests.
Pass connectionId in the query string for GET and DELETE actions, and in the JSON body for POST, PUT, and PATCH actions. Keep your MindCloud API Key on your server; do not ship it in browser code, mobile apps, public repositories, or logs.
TouchBasePro actions
All 124 published actions for this TouchBasePro version. Each page documents the endpoint, arguments, and response controls.
- PUTActivate Webhook
- POSTAdd Rule Group To Segment
- POSTCreate Campaign From Template
- POSTCreate Custom Field
- POSTCreate Draft Campaign
- POSTCreate Email List
- POSTCreate Email Subscriber
- POSTCreate Email Template
- POSTCreate Segment
- POSTCreate SMS Campaign Webhook
- POSTCreate SMS List
- POSTCreate SMS List Webhook
- POSTCreate SMS Message Webhook
- POSTCreate SMS Subscriber
- POSTCreate Webhook
- PUTDeactivate Webhook
- DELETEDelete Campaign
- DELETEDelete Custom Field
- DELETEDelete Email List
- DELETEDelete Email Template
- DELETEDelete Segment
- DELETEDelete Segment Rules
- DELETEDelete SMS Campaign Webhook
- DELETEDelete SMS List
- DELETEDelete SMS List Webhook
- DELETEDelete SMS Message Webhook
- DELETEDelete SMS Subscriber
- DELETEDelete Subscriber
- DELETEDelete Webhook
- GETDownload Validation Result
- GETGet Campaign Email Client Usage
- GETGet Campaign Lists And Segments
- GETGet Campaign Summary
- GETGet Current Time
- GETGet Email Client
- GETGet Email Credit Balance
- GETGet Email List
- GETGet Email Statistics
- GETGet Email Template
- GETGet List Stats
- GETGet Lists For Email
- GETGet Message
- GETGet Message Timeline
- GETGet Segment
- GETGet Smart Email Details
- GETGet Smart Email List
- GETGet SMS Campaign
- GETGet SMS Campaign Report
- GETGet SMS Campaign Webhook
- GETGet SMS Credit Balance
- GETGet SMS List
- GETGet SMS List Webhook
- GETGet SMS Message
- GETGet SMS Message Status Webhook
- GETGet SMS Reply Forward
- GETGet SMS Subscriber
- GETGet Subscriber
- GETGet Subscriber History
- GETGet Suppression List
- GETGet Validation Credit Balance
- GETGet Validation List Status
- POSTImport SMS Subscribers
- POSTImport Subscribers
- GETList Active Subscribers in List
- GETList Active Subscribers in Segment
- GETList Bounced Subscribers in List
- GETList Campaign Bounces
- GETList Campaign Clicks
- GETList Campaign Opens
- GETList Campaign Recipients
- GETList Campaign Spam Complaints
- GETList Campaign Unsubscribers
- GETList Client Templates
- GETList Countries
- GETList Custom Fields
- GETList Deleted Subscribers in List
- GETList Draft Campaigns
- GETList Email Client Segments
- GETList Email Lists
- GETList Scheduled Campaigns
- GETList Segments
- GETList Sent Campaigns
- GETList Smart Email Groups
- GETList SMS Campaign Webhooks
- GETList SMS Campaigns
- GETList SMS List Webhooks
- GETList SMS Lists
- GETList SMS Message Webhooks
- GETList SMS Subscribers
- GETList Time Zones
- GETList Unconfirmed Subscribers in List
- GETList Unsubscribed Subscribers in List
- GETList Webhooks
- POSTResend Email Message
- POSTSend Campaign Preview
- POSTSend Classic Email
- POSTSend Draft Campaign
- POSTSend Smart Email
- POSTSend SMS
- POSTSet SMS Reply Forward
- POSTSuppress Email Addresses
- GETTest Webhook
- PUTUnschedule Campaign
- PUTUnsubscribe Subscriber
- PUTUnsuppress Email Address
- PUTUpdate Custom Field
- PUTUpdate Custom Field Options
- PUTUpdate Email List
- PUTUpdate Email Template
- PUTUpdate Segment
- PUTUpdate SMS Campaign Webhook
- PUTUpdate SMS List
- PUTUpdate SMS List Webhook
- PUTUpdate SMS Message Webhook
- PUTUpdate SMS Subscriber
- PUTUpdate Subscriber
- GETValidate Email Address
- POSTValidate Email List
- POSTWhatsApp Create Template
- GETWhatsApp Get Users
- POSTWhatsApp Send Text Message
- POSTWhatsApp Track Events
- POSTWhatsApp Track User
- POSTWhatsApp Upload Media
Related apps
More Marketing apps on the Universal API, behind the same REST shape. Or browse all apps.