# Chatforma API Documentation

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

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

## Chatforma actions

- POST `add-user-to-segment` Add User To Segment
- POST `create-bot-variable` Create Bot Variable
- POST `create-dispatch-to-segment` Create Dispatch To Segment
- POST `create-dispatch-to-user` Create Dispatch To User
- POST `create-user-variable` Create User Variable
- DELETE `delete-bot-variable` Delete Bot Variable
- GET `get-current-account` Get Current Account
- GET `get-notification-sample` Get Notification Sample
- GET `get-user-variable` Get User Variable
- GET `list-bot-messages` List Bot Messages
- GET `list-bot-users` List Bot Users
- GET `list-bot-variables` List Bot Variables
- GET `list-bots` List Bots
- GET `list-forms` List Forms
- GET `list-notifications` List Notifications
- GET `list-open-dialog-users` List Open Dialog Users
- GET `list-segment-users` List Segment Users
- GET `list-segments` List Segments
- GET `list-user-messages` List User Messages
- DELETE `remove-user-from-segment` Remove User From Segment
- POST `send-existing-message-to-segment` Send Existing Message To Segment
- POST `send-existing-message-to-user` Send Existing Message To User
- POST `send-message-to-dialog-user` Send Message To Dialog User
- POST `subscribe-to-notifications` Subscribe To Notifications
- DELETE `unsubscribe-from-notifications` Unsubscribe From Notifications