# HelpCrunch API Documentation

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

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

## HelpCrunch actions

- POST `add-customer-event` Add Customer Event
- PUT `batch-update-customers` Batch Update Customers
- POST `create-agent-message` Create Agent Message
- POST `create-chat` Create Chat
- POST `create-customer` Create Customer
- POST `create-customer-message` Create Customer Message
- DELETE `delete-customer` Delete Customer
- GET `get-chat` Get Chat
- GET `get-customer` Get Customer
- GET `get-team-availability-status` Get Team Availability Status
- GET `list-applications` List Applications
- GET `list-chat-messages` List Chat Messages
- GET `list-chats` List Chats
- GET `list-customers` List Customers
- GET `list-departments` List Departments
- GET `list-team-members` List Team Members
- PUT `mark-chat-as-read-by-agent` Mark Chat As Read By Agent
- PUT `mark-chat-as-read-by-customer` Mark Chat As Read By Customer
- PUT `patch-customer` Patch Customer
- PUT `rate-chat` Rate Chat
- GET `search-chats` Search Chats
- GET `search-customers` Search Customers
- PUT `snooze-chat` Snooze Chat
- PUT `tag-customer` Tag Customer
- PUT `unsubscribe-team-member` Unsubscribe Team Member
- PUT `untag-customer` Untag Customer
- PUT `update-chat-assignee` Update Chat Assignee
- PUT `update-chat-department` Update Chat Department
- PUT `update-chat-status` Update Chat Status
- PUT `update-customer` Update Customer