# Heyy API Documentation

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

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

## Heyy actions

- PUT `add-contact-attribute` Add Contact Attribute
- PUT `add-recipients-to-broadcast` Add Recipients To Broadcast
- POST `create-api-webhook` Create API Webhook
- POST `create-attribute` Create Attribute
- POST `create-broadcast` Create Broadcast
- POST `create-contact` Create Contact
- POST `create-label` Create Label
- DELETE `delete-api-webhook` Delete API Webhook
- DELETE `delete-attribute` Delete Attribute
- DELETE `delete-broadcast` Delete Broadcast
- DELETE `delete-contact` Delete Contact
- DELETE `delete-label` Delete Label
- GET `get-broadcast-by-id` Get Broadcast by ID
- GET `get-business` Get Business
- GET `get-channel-by-id` Get Channel by ID
- GET `get-chat-by-id` Get Chat by ID
- GET `get-contact-by-id` Get Contact by ID
- GET `list-api-webhooks` List API Webhooks
- GET `list-attributes` List Attributes
- GET `list-automations` List Automations
- GET `list-broadcast-recipients` List Broadcast Recipients
- GET `list-broadcasts` List Broadcasts
- GET `list-channels` List Channels
- GET `list-chats` List Chats
- GET `list-contacts` List Contacts
- GET `list-labels` List Labels
- GET `list-message-templates` List Message Templates
- PUT `remove-contact-attribute` Remove Contact Attribute
- PUT `remove-recipients-from-broadcast` Remove Recipients From Broadcast
- POST `send-whats-app-message` Send WhatsApp Message
- PUT `start-broadcast` Start Broadcast
- POST `trigger-automation` Trigger Automation
- PUT `update-api-webhook` Update API Webhook
- PUT `update-broadcast` Update Broadcast
- PUT `update-chat` Update Chat
- PUT `update-contact` Update Contact
- POST `upload-file` Upload File