# TouchBasePro API Documentation

This is the complete API documentation for connecting to the TouchBasePro API using MindCloud's Universal API.

MindCloud offers one normalized API to access 3,400+ apps from a single place. It centralizes authentication and normalizes app APIs so they are easier and more consistent to use.

## Quickstart

1. A **MindCloud account** — sign in or create an account at [MindCloud](https://app.mindcloud.co).
2. A **MindCloud API Key** — create one in [API Keys](https://app.mindcloud.co/user/api-keys). Keep it on your server.
3. At least one **TouchBasePro connection** — create or choose one in [Connections](https://app.mindcloud.co/credentials). Note its `connectionId`.

```text
POST https://connect.mindcloud.co/v2/universal/apps/touchBasePro/actions/{actionSlug}/run
```

## TouchBasePro actions

- PUT `activate-webhook` Activate Webhook
- POST `add-rule-group-to-segment` Add Rule Group To Segment
- POST `create-campaign-from-template` Create Campaign From Template
- POST `create-custom-field` Create Custom Field
- POST `create-draft-campaign` Create Draft Campaign
- POST `create-email-list` Create Email List
- POST `create-email-subscriber` Create Email Subscriber
- POST `create-email-template` Create Email Template
- POST `create-segment` Create Segment
- POST `create-sms-campaign-webhook` Create SMS Campaign Webhook
- POST `create-sms-list` Create SMS List
- POST `create-sms-list-webhook` Create SMS List Webhook
- POST `create-sms-message-webhook` Create SMS Message Webhook
- POST `create-sms-subscriber` Create SMS Subscriber
- POST `create-webhook` Create Webhook
- PUT `deactivate-webhook` Deactivate Webhook
- DELETE `delete-campaign` Delete Campaign
- DELETE `delete-custom-field` Delete Custom Field
- DELETE `delete-email-list` Delete Email List
- DELETE `delete-email-template` Delete Email Template
- DELETE `delete-segment` Delete Segment
- DELETE `delete-segment-rules` Delete Segment Rules
- DELETE `delete-sms-campaign-webhook` Delete SMS Campaign Webhook
- DELETE `delete-sms-list` Delete SMS List
- DELETE `delete-sms-list-webhook` Delete SMS List Webhook
- DELETE `delete-sms-message-webhook` Delete SMS Message Webhook
- DELETE `delete-sms-subscriber` Delete SMS Subscriber
- DELETE `delete-subscriber` Delete Subscriber
- DELETE `delete-webhook` Delete Webhook
- GET `download-validation-result` Download Validation Result
- GET `get-campaign-email-client-usage` Get Campaign Email Client Usage
- GET `get-campaign-lists-and-segments` Get Campaign Lists And Segments
- GET `get-campaign-summary` Get Campaign Summary
- GET `get-current-time` Get Current Time
- GET `get-email-client` Get Email Client
- GET `get-email-credit-balance` Get Email Credit Balance
- GET `get-email-list` Get Email List
- GET `get-email-statistics` Get Email Statistics
- GET `get-email-template` Get Email Template
- GET `get-list-stats` Get List Stats
- GET `get-lists-for-email` Get Lists For Email
- GET `get-message` Get Message
- GET `get-message-timeline` Get Message Timeline
- GET `get-segment` Get Segment
- GET `get-smart-email-details` Get Smart Email Details
- GET `get-smart-email-list` Get Smart Email List
- GET `get-sms-campaign` Get SMS Campaign
- GET `get-sms-campaign-report` Get SMS Campaign Report
- GET `get-sms-campaign-webhook` Get SMS Campaign Webhook
- GET `get-sms-credit-balance` Get SMS Credit Balance
- GET `get-sms-list` Get SMS List
- GET `get-sms-list-webhook` Get SMS List Webhook
- GET `get-sms-message` Get SMS Message
- GET `get-sms-message-status-webhook` Get SMS Message Status Webhook
- GET `get-sms-reply-forward` Get SMS Reply Forward
- GET `get-sms-subscriber` Get SMS Subscriber
- GET `get-subscriber` Get Subscriber
- GET `get-subscriber-history` Get Subscriber History
- GET `get-suppression-list` Get Suppression List
- GET `get-validation-credit-balance` Get Validation Credit Balance
- GET `get-validation-list-status` Get Validation List Status
- POST `import-sms-subscribers` Import SMS Subscribers
- POST `import-subscribers` Import Subscribers
- GET `list-active-subscribers-in-list` List Active Subscribers in List
- GET `list-active-subscribers-in-segment` List Active Subscribers in Segment
- GET `list-bounced-subscribers-in-list` List Bounced Subscribers in List
- GET `list-campaign-bounces` List Campaign Bounces
- GET `list-campaign-clicks` List Campaign Clicks
- GET `list-campaign-opens` List Campaign Opens
- GET `list-campaign-recipients` List Campaign Recipients
- GET `list-campaign-spam-complaints` List Campaign Spam Complaints
- GET `list-campaign-unsubscribers` List Campaign Unsubscribers
- GET `list-client-templates` List Client Templates
- GET `list-countries` List Countries
- GET `list-custom-fields` List Custom Fields
- GET `list-deleted-subscribers-in-list` List Deleted Subscribers in List
- GET `list-draft-campaigns` List Draft Campaigns
- GET `list-email-client-segments` List Email Client Segments
- GET `list-email-lists` List Email Lists
- GET `list-scheduled-campaigns` List Scheduled Campaigns
- GET `list-segments` List Segments
- GET `list-sent-campaigns` List Sent Campaigns
- GET `list-smart-email-groups` List Smart Email Groups
- GET `list-sms-campaign-webhooks` List SMS Campaign Webhooks
- GET `list-sms-campaigns` List SMS Campaigns
- GET `list-sms-list-webhooks` List SMS List Webhooks
- GET `list-sms-lists` List SMS Lists
- GET `list-sms-message-webhooks` List SMS Message Webhooks
- GET `list-sms-subscribers` List SMS Subscribers
- GET `list-time-zones` List Time Zones
- GET `list-unconfirmed-subscribers-in-list` List Unconfirmed Subscribers in List
- GET `list-unsubscribed-subscribers-in-list` List Unsubscribed Subscribers in List
- GET `list-webhooks` List Webhooks
- POST `resend-email-message` Resend Email Message
- POST `send-campaign-preview` Send Campaign Preview
- POST `send-classic-email` Send Classic Email
- POST `send-draft-campaign` Send Draft Campaign
- POST `send-smart-email` Send Smart Email
- POST `send-sms` Send SMS
- POST `set-sms-reply-forward` Set SMS Reply Forward
- POST `suppress-email-addresses` Suppress Email Addresses
- GET `test-webhook` Test Webhook
- PUT `unschedule-campaign` Unschedule Campaign
- PUT `unsubscribe-subscriber` Unsubscribe Subscriber
- PUT `unsuppress-email-address` Unsuppress Email Address
- PUT `update-custom-field` Update Custom Field
- PUT `update-custom-field-options` Update Custom Field Options
- PUT `update-email-list` Update Email List
- PUT `update-email-template` Update Email Template
- PUT `update-segment` Update Segment
- PUT `update-sms-campaign-webhook` Update SMS Campaign Webhook
- PUT `update-sms-list` Update SMS List
- PUT `update-sms-list-webhook` Update SMS List Webhook
- PUT `update-sms-message-webhook` Update SMS Message Webhook
- PUT `update-sms-subscriber` Update SMS Subscriber
- PUT `update-subscriber` Update Subscriber
- GET `validate-email-address` Validate Email Address
- POST `validate-email-list` Validate Email List
- POST `whatsapp-create-template` WhatsApp Create Template
- GET `whatsapp-get-users` WhatsApp Get Users
- POST `whatsapp-send-text-message` WhatsApp Send Text Message
- POST `whatsapp-track-events` WhatsApp Track Events
- POST `whatsapp-track-user` WhatsApp Track User
- POST `whatsapp-upload-media` WhatsApp Upload Media