# CloudContactAI API Documentation

This is the complete API documentation for connecting to the CloudContactAI 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 **CloudContactAI connection** — create or choose one in [Connections](https://app.mindcloud.co/credentials). Note its `connectionId`.

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

## CloudContactAI actions

- POST `batch-create-contacts` Batch Create Contacts
- POST `create-campaign` Create Campaign
- POST `create-client` Create Client
- POST `create-client-campaign` Create Client Campaign
- POST `create-collection-campaign` Create Collection Campaign
- POST `create-contact` Create Contact
- POST `create-direct-campaign` Create Direct Campaign
- DELETE `delete-campaign-by-id` Delete Campaign by ID
- DELETE `delete-client-by-id` Delete Client by ID
- DELETE `delete-contact-by-id` Delete Contact by ID
- GET `get-campaign-contact-message` Get Campaign Contact Message
- GET `get-campaign-message-stats` Get Campaign Message Stats
- GET `get-client-by-id` Get Client by ID
- GET `get-collection-client-settings` Get Collection Client Settings
- GET `get-collection-debtor-by-track-id` Get Collection Debtor by Track ID
- GET `get-contact-by-id` Get Contact by ID
- GET `get-contact-call-record` Get Contact Call Record
- GET `get-message-by-id` Get Message by ID
- GET `list-campaigns` List Campaigns
- GET `list-client-campaigns` List Client Campaigns
- GET `list-clients` List Clients
- GET `list-contacts` List Contacts
- GET `list-contacts-with-email` List Contacts with Email
- GET `list-contacts-with-phone` List Contacts with Phone
- GET `list-contacts-without-call-record` List Contacts without Call Record
- GET `list-incoming-messages` List Incoming Messages
- GET `list-messages-by-campaign` List Messages by Campaign
- GET `list-messages-by-contact` List Messages by Contact
- GET `list-sent-messages` List Sent Messages
- PUT `patch-client-by-id` Patch Client by ID
- PUT `requeue-campaign` Requeue Campaign
- POST `send-campaign-messages` Send Campaign Messages
- POST `send-contact-message` Send Contact Message
- PUT `update-client-by-id` Update Client by ID
- PUT `update-client-campaign` Update Client Campaign
- PUT `update-collection-client-settings` Update Collection Client Settings
- PUT `update-contact-by-id` Update Contact by ID