# Heyy Help Center

- [Heyy Help Center](https://docs.heyy.io/help/index.md): Find answers to all your Heyy-related questions.
- [Introduction](https://docs.heyy.io/help/ai-employees/index.md): What AI Employees are and how they fit into Heyy.
- [Hire an AI employee](https://docs.heyy.io/help/ai-employees/getting-started/hire-an-ai-employee.md): Create your first AI Employee and understand plan limits.
- [Run your first test conversation](https://docs.heyy.io/help/ai-employees/getting-started/run-your-first-test-conversation.md): Validate replies in the Playground before going live.
- [Connect to real customer traffic](https://docs.heyy.io/help/ai-employees/getting-started/connect-to-real-customer-traffic.md): Connect a channel and wire your AI Employee into an automation.
- [Identity setup](https://docs.heyy.io/help/ai-employees/identity-and-guidelines/identity-setup.md): Set name, brand, role, tone, and answer length for an AI Employee.
- [Write your guidelines](https://docs.heyy.io/help/ai-employees/identity-and-guidelines/write-your-guidelines.md): What guidelines are, how to add them, @mentions, and writing tips.
- [Identity & style](https://docs.heyy.io/help/ai-employees/identity-and-guidelines/identity-and-style.md): Guidelines for who your employee is and how they communicate.
- [Conversation flow & objectives](https://docs.heyy.io/help/ai-employees/identity-and-guidelines/conversation-flow-and-objectives.md): Guidelines for goals, content, actions, and assets in each chat.
- [Boundaries](https://docs.heyy.io/help/ai-employees/identity-and-guidelines/boundaries.md): Guidelines for limits, escalation, and what the AI must not do.
- [Other](https://docs.heyy.io/help/ai-employees/identity-and-guidelines/other.md): Guidelines for seasonal, partner, or one-off rules.
- [Add your website](https://docs.heyy.io/help/ai-employees/content/add-your-website.md): Crawl static pages so your employee answers from your site — and know when not to.
- [Upload documents](https://docs.heyy.io/help/ai-employees/content/upload-documents.md): Add PDFs and files as internal knowledge, smart-scanned for structure.
- [Add plain text knowledge](https://docs.heyy.io/help/ai-employees/content/add-plain-text-knowledge.md): Paste policies, scripts, or notes as searchable content, no file needed.
- [Build a Q&A knowledge base](https://docs.heyy.io/help/ai-employees/content/build-qa-knowledge-base.md): Add question-and-answer pairs for the exact phrasing customers use.
- [Keep knowledge accurate](https://docs.heyy.io/help/ai-employees/content/keep-knowledge-accurate.md): How automatic training works, what the status badges mean, and how quota is measured.
- [Choose which attributes to expose](https://docs.heyy.io/help/ai-employees/capabilities/choose-attributes-to-expose.md): Attributes are the contact fields your employee can read, share, or update — and why the three permissions are not the same.
- [Let your employee read contact fields](https://docs.heyy.io/help/ai-employees/capabilities/read-contact-fields.md): Grant read access so the employee can see and use contact data.
- [Let your employee update contact fields](https://docs.heyy.io/help/ai-employees/capabilities/update-contact-fields.md): Allow the AI to capture and save new contact data during a conversation.
- [Share files in chat](https://docs.heyy.io/help/ai-employees/capabilities/share-files-in-chat.md): Upload files your employee can send to contacts, and the security rule that comes with it.
- [Reference assets in guidelines](https://docs.heyy.io/help/ai-employees/capabilities/reference-assets-in-guidelines.md): Tell the employee exactly when to send a specific file.
- [Actions overview](https://docs.heyy.io/help/ai-employees/capabilities/actions-overview.md): Functions your employee can invoke during a conversation, not just knowledge it retrieves passively.
- [Call an external API](https://docs.heyy.io/help/ai-employees/capabilities/call-an-external-api.md): Set up a Custom API action so your employee can look up data or trigger work, not just reply with text.
- [Trigger an automation](https://docs.heyy.io/help/ai-employees/capabilities/trigger-an-automation.md): Let your employee start another automation for the contact, with input parameters.
- [Create exit points](https://docs.heyy.io/help/ai-employees/capabilities/create-exit-points.md): Every way a conversation can end — and why none of them work until selected in an automation.
- [Configure employee settings](https://docs.heyy.io/help/ai-employees/capabilities/employee-settings.md): The Typing Indicator toggle and retiring an AI Employee permanently.
- [How AI employees work in automations](https://docs.heyy.io/help/ai-employees/going-live/how-ai-employees-work-in-automations.md): Triggers, the AI Employee action, replies, exit points, and what happens next.
- [Test in the playground](https://docs.heyy.io/help/ai-employees/going-live/test-in-playground.md): Validate replies, actions, and exit points before an employee reaches a real customer.
- [Add an AI employee to an automation](https://docs.heyy.io/help/ai-employees/going-live/add-to-automation.md): Use the AI Employee action in the automation editor to put a tested employee to work.
- [Choose channel and extra guidelines for the step](https://docs.heyy.io/help/ai-employees/going-live/channel-and-context.md): Configure the channel, employee, and optional per-automation extra guidelines on the AI Employee action.
- [Use exit points in automations](https://docs.heyy.io/help/ai-employees/going-live/use-exit-points-in-automations.md): Select and map exit points on the AI Employee action so a workflow actually branches on them.
- [Hand off to a human teammate](https://docs.heyy.io/help/ai-employees/going-live/hand-off-to-human.md): Combine exit points, boundaries, and inbox routing to move a conversation from AI to your team.
- [Set reply timeouts](https://docs.heyy.io/help/ai-employees/going-live/reply-timeouts.md): Handle a contact who stops replying with the Contact Not Replied condition.
- [Override guidelines inside an automation](https://docs.heyy.io/help/ai-employees/going-live/automation-guideline-overrides.md): Per-automation instructions that supplement the employee's base guidelines, without cloning the employee.
- [Inbox tour](https://docs.heyy.io/help/inbox/inbox-tour.md): The layout of the Inbox and what each part of the screen does.
- [Start a new chat](https://docs.heyy.io/help/inbox/start-a-new-chat.md): Open a fresh conversation with an existing or new contact.
- [Send a message](https://docs.heyy.io/help/inbox/send-a-message.md): The composer: free-form text, media, emoji, and voice notes.
- [Use quick replies](https://docs.heyy.io/help/inbox/use-quick-replies.md): Save and reuse common responses instead of retyping them.
- [Message actions](https://docs.heyy.io/help/inbox/message-actions.md): Status indicators, resending, and working with a single message.
- [Chat actions](https://docs.heyy.io/help/inbox/chat-actions.md): The searchable Actions menu, plus Refresh, Close, and the More menu.
- [Contact card](https://docs.heyy.io/help/inbox/contact-card.md): Everything about the contact and conversation, without leaving the chat.
- [Global search](https://docs.heyy.io/help/inbox/find-and-organize/global-search.md): Find a conversation, contact, or message from a name, phrase, or detail.
- [Advanced filters](https://docs.heyy.io/help/inbox/find-and-organize/advanced-filters.md): Build precise, multi-condition filters on contact and chat data.
- [Saved inbox views](https://docs.heyy.io/help/inbox/find-and-organize/saved-inbox-views.md): Save filtered views of your chat list in the Inbox.
- [Team & user inboxes](https://docs.heyy.io/help/inbox/find-and-organize/team-and-user-inboxes.md): Organize conversations by department, and manage who has workspace access.
- [Search & filter chats](https://docs.heyy.io/help/inbox/find-and-organize/search-and-filter-chats.md): Status, sort, and the entry point into deeper filtering.
- [Quick actions](https://docs.heyy.io/help/inbox/find-and-organize/quick-actions.md): One-click actions on a single conversation, right from the list.
- [Bulk actions](https://docs.heyy.io/help/inbox/find-and-organize/bulk-actions.md): Act on many conversations at once instead of one at a time.
- [Chat lifecycle](https://docs.heyy.io/help/inbox/chat-fundamentals/chat-lifecycle.md): How a conversation moves between open, closed, and snoozed.
- [Contact subscription](https://docs.heyy.io/help/inbox/chat-fundamentals/contact-subscription.md): Subscription and consent on the contact record, often viewed from Inbox.
- [Conversation window](https://docs.heyy.io/help/inbox/chat-fundamentals/conversation-window.md): Why free-form replies stop working after a while on WhatsApp, Messenger, and Instagram — and how to fix it.
- [Sensitive chats](https://docs.heyy.io/help/inbox/chat-fundamentals/sensitive-chats.md): Flag a conversation that contains sensitive information.
- [Messaging channels](https://docs.heyy.io/help/messaging-channels/index.md): Connect a channel so your team or an AI Employee can receive real conversations.
- [Getting started](https://docs.heyy.io/help/messaging-channels/whatsapp/getting-started.md): Connect a WhatsApp number to Heyy with Cloud API or Coexistence.
- [WhatsApp templates](https://docs.heyy.io/help/messaging-channels/whatsapp/whatsapp-templates.md): Create and manage Meta-approved WhatsApp message templates for inbox and campaigns.
- [Guides](https://docs.heyy.io/help/messaging-channels/whatsapp/guides.md): Profile configuration, method migration, and ongoing WhatsApp management.
- [Common issues](https://docs.heyy.io/help/messaging-channels/whatsapp/common-issues.md): Fix a WhatsApp connection that won't complete or keeps failing.
- [Getting started](https://docs.heyy.io/help/messaging-channels/instagram/getting-started.md): Connect Instagram Direct to your Heyy Inbox.
- [Common issues](https://docs.heyy.io/help/messaging-channels/instagram/common-issues.md): Fix an Instagram connection that fails or won't finish.
- [Message errors](https://docs.heyy.io/help/messaging-channels/instagram/message-errors.md): Why a message to an Instagram contact might be blocked.
- [Getting started](https://docs.heyy.io/help/messaging-channels/facebook-messenger/getting-started.md): Connect your Facebook Page's Messenger to your Heyy Inbox.
- [Common issues](https://docs.heyy.io/help/messaging-channels/facebook-messenger/common-issues.md): Fix a Facebook Messenger connection that fails or won't finish.
- [Message errors](https://docs.heyy.io/help/messaging-channels/facebook-messenger/message-errors.md): Why a message to a Messenger contact might be blocked.
- [Getting started](https://docs.heyy.io/help/messaging-channels/live-chat/getting-started.md): Embed the Live Chat widget on your website and connect it to your Inbox.
- [Common issues](https://docs.heyy.io/help/messaging-channels/live-chat/common-issues.md): Fix a widget that won't load, won't match your brand, or won't reach the Inbox.
- [Message errors](https://docs.heyy.io/help/messaging-channels/live-chat/message-errors.md): Why a Live Chat message might not send or arrive.
- [Getting started](https://docs.heyy.io/help/messaging-channels/sms/getting-started.md): Connect a Twilio number to send and receive SMS through Heyy.
- [Common issues](https://docs.heyy.io/help/messaging-channels/sms/common-issues.md): Fix an SMS connection that won't send or receive.
- [Message errors](https://docs.heyy.io/help/messaging-channels/sms/message-errors.md): Character limits, segmentation, and carrier filtering.
- [Contacts tour](https://docs.heyy.io/help/contacts/mini-crm/contacts-tour.md): Layout of the Contacts mini-CRM page.
- [Column order & visible fields](https://docs.heyy.io/help/contacts/mini-crm/column-order-and-visible-fields.md): Reorder columns and show or hide built-in contact fields on the Contacts table.
- [Custom attributes (columns)](https://docs.heyy.io/help/contacts/mini-crm/custom-attributes-as-columns.md): Show workspace attributes as columns on the Contacts table and edit values on the record.
- [Labels](https://docs.heyy.io/help/contacts/mini-crm/labels.md): Tag contacts with labels on the Contacts table and contact profile.
- [Search contacts](https://docs.heyy.io/help/contacts/search-and-filters/search-contacts.md): Find contacts from the Contacts table search.
- [Advanced filters](https://docs.heyy.io/help/contacts/search-and-filters/advanced-filters.md): Filter the Contacts table by fields, labels, and attributes.
- [Saved contact views](https://docs.heyy.io/help/contacts/search-and-filters/saved-contact-views.md): Save filtered segments of your Contacts table.
- [Bulk actions](https://docs.heyy.io/help/contacts/search-and-filters/bulk-actions.md): Apply actions to multiple contacts at once on the Contacts page.
- [What is a contact?](https://docs.heyy.io/help/contacts/the-contact/what-is-a-contact.md): The foundational customer record in Heyy.
- [Contacts and channels](https://docs.heyy.io/help/contacts/the-contact/contacts-and-channels.md): One contact can have multiple chats across channels.
- [Contact subscription](https://docs.heyy.io/help/contacts/the-contact/contact-subscription.md): Messaging consent and subscription state on the contact record.
- [Contacts across Heyy](https://docs.heyy.io/help/contacts/the-contact/contacts-across-heyy.md): How the contact record connects to Inbox, automations, journeys, campaigns, and integrations.
- [Introduction](https://docs.heyy.io/help/automations/index.md): Automations run on contacts when triggers fire—then actions send messages, update data, call APIs, and more.
- [Triggers overview](https://docs.heyy.io/help/automations/triggers/overview.md): When automations start—choose a trigger that matches the moment you want Heyy to respond.
- [New incoming chat](https://docs.heyy.io/help/automations/triggers/new-incoming-chat.md): Automation trigger: New incoming chat.
- [Reopened chat](https://docs.heyy.io/help/automations/triggers/reopened-chat.md): Automation trigger: Reopened chat.
- [New & reopened chat](https://docs.heyy.io/help/automations/triggers/new-and-reopened-chat.md): Automation trigger: New & reopened chat.
- [New incoming message](https://docs.heyy.io/help/automations/triggers/new-incoming-message.md): Automation trigger: New incoming message.
- [Chat closed](https://docs.heyy.io/help/automations/triggers/chat-closed.md): Automation trigger: Chat closed.
- [Chat assigned](https://docs.heyy.io/help/automations/triggers/chat-assigned.md): Automation trigger: Chat assigned.
- [Chat moved](https://docs.heyy.io/help/automations/triggers/chat-moved.md): Automation trigger: Chat moved.
- [Contact created](https://docs.heyy.io/help/automations/triggers/contact-created.md): Automation trigger: Contact created.
- [Contact attribute updated](https://docs.heyy.io/help/automations/triggers/contact-attribute-updated.md): Automation trigger: Contact attribute updated.
- [Label added](https://docs.heyy.io/help/automations/triggers/label-added.md): Automation trigger: Label added.
- [Label removed](https://docs.heyy.io/help/automations/triggers/label-removed.md): Automation trigger: Label removed.
- [New Instagram comment](https://docs.heyy.io/help/automations/triggers/new-instagram-comment.md): Automation trigger: New Instagram comment.
- [Webhook received](https://docs.heyy.io/help/automations/triggers/webhook-received.md): Automation trigger: Webhook received.
- [Manual trigger](https://docs.heyy.io/help/automations/triggers/manual-trigger.md): Automation trigger: Manual trigger.
- [Live Chat Actions](https://docs.heyy.io/help/automations/live-chat-actions.md)
- [WhatsApp Actions](https://docs.heyy.io/help/automations/whatsapp-actions.md)
- [Instagram Actions](https://docs.heyy.io/help/automations/instagram-actions.md)
- [Facebook Actions](https://docs.heyy.io/help/automations/facebook-actions.md)
- [AI Actions](https://docs.heyy.io/help/automations/ai-actions.md)
- [Logic Actions](https://docs.heyy.io/help/automations/logic-actions.md)
- [Contacts Actions](https://docs.heyy.io/help/automations/contacts-actions.md)
- [Chats Actions](https://docs.heyy.io/help/automations/chats-actions.md)
- [Notifications Actions](https://docs.heyy.io/help/automations/notifications-actions.md)
- [Campaigns Actions](https://docs.heyy.io/help/automations/campaigns-actions.md)
- [Apps Actions](https://docs.heyy.io/help/automations/apps-actions.md)
- [What is a journey?](https://docs.heyy.io/help/automations/journeys/what-is-a-journey.md): Timed automation paths for contacts with scheduled steps and waits.
- [Build a journey](https://docs.heyy.io/help/automations/journeys/build-a-journey.md): Create journey steps, waits, and linked automations.
- [Activity log overview](https://docs.heyy.io/help/automations/activity-log/overview.md): Review automation and journey activity in your workspace.
- [View runs & debug](https://docs.heyy.io/help/automations/activity-log/view-runs-and-debug.md): Inspect automation runs and fix issues from the Activity log.
- [Use cases](https://docs.heyy.io/help/automations/use-cases/coming-soon.md): Example automation and journey recipes—coming soon.
- [Campaigns tour](https://docs.heyy.io/help/campaigns-and-outreach/build/campaigns-tour.md): Overview of campaigns in Heyy and how to create one.
- [Audience & recipients](https://docs.heyy.io/help/campaigns-and-outreach/build/audience-and-recipients.md): Choose which contacts receive a campaign.
- [Message & templates](https://docs.heyy.io/help/campaigns-and-outreach/build/message-and-templates.md): Set campaign message content and channel requirements.
- [Start & monitor a campaign](https://docs.heyy.io/help/campaigns-and-outreach/run/start-and-monitor.md): Launch a campaign and follow execution progress.
- [Delivery & failures](https://docs.heyy.io/help/campaigns-and-outreach/run/delivery-and-failures.md): Understand campaign delivery status per contact.
- [Export & bulk actions](https://docs.heyy.io/help/campaigns-and-outreach/run/export-and-bulk-actions.md): Export campaign results and update contacts from the execution page.
- [Profile](https://docs.heyy.io/help/managing-your-profile/profile.md): Set your name, photo, phone number, and message notifications.
- [Security](https://docs.heyy.io/help/managing-your-profile/security.md): Update your email and turn on two-factor authentication.
- [How to invite teammates](https://docs.heyy.io/help/managing-your-workspace/workspace-members/how-to-invite-teammates.md): Bring your team into Heyy and choose the right role for each person.
- [How to invite partners](https://docs.heyy.io/help/managing-your-workspace/workspace-members/how-to-invite-partners.md): Bring in an external collaborator without giving them full workspace access.
- [Workspace roles](https://docs.heyy.io/help/managing-your-workspace/workspace-roles.md): What Member, Manager, and Admin can each do in Heyy.
- [Heyy API Documentation - REST API Reference & Guides](https://docs.heyy.io/api-reference/v3/overview.md): ‘Heyy API documentation. Build with our REST API to send messages, manage contacts, automate workflows, and integrate Heyy with your existing tools.’
- [Authentication](https://docs.heyy.io/api-reference/v3/authentication.md): How to authenticate requests to the Heyy API v3.
- [Versioning](https://docs.heyy.io/api-reference/v3/versioning.md): How Heyy versions its public API and deprecates older versions.
- [Query](https://docs.heyy.io/api-reference/v3/query.md): Filter list results with structured query expressions on search endpoints.
- [Sort By](https://docs.heyy.io/api-reference/v3/sort-by.md): Order search results with sortBy expressions.
- [Search](https://docs.heyy.io/api-reference/v3/search.md): Full-text search on list endpoints using the search request body field.
- [Pagination](https://docs.heyy.io/api-reference/v3/pagination.md): Page through search results with pagination in the request and response.
- [Rate Limiting](https://docs.heyy.io/api-reference/v3/rate-limiting.md): How API rate limits work and how to handle 429 responses.
- [Error Handling](https://docs.heyy.io/api-reference/v3/error-handling.md): How the Heyy API reports errors and how to handle them.
- [Search attributes](https://docs.heyy.io/api-reference/search-attributes.md): Search attributes.
- [Create attribute](https://docs.heyy.io/api-reference/create-attribute.md): Create attribute.
- [Update attribute](https://docs.heyy.io/api-reference/update-attribute.md): Update attribute.
- [Get attribute](https://docs.heyy.io/api-reference/get-attribute.md): Get attribute.
- [Delete attribute](https://docs.heyy.io/api-reference/delete-attribute.md): Delete attribute.
- [Search automations](https://docs.heyy.io/api-reference/search-automations.md): Search automations.
- [Get automation](https://docs.heyy.io/api-reference/get-automation.md): Get automation.
- [Pause automation](https://docs.heyy.io/api-reference/pause-automation.md): Pause automation.
- [Unpause automation](https://docs.heyy.io/api-reference/unpause-automation.md): Unpause automation.
- [Trigger automation](https://docs.heyy.io/api-reference/trigger-automation.md): Trigger automation.
- [Search campaigns](https://docs.heyy.io/api-reference/search-campaigns.md): Search campaigns.
- [Create campaign](https://docs.heyy.io/api-reference/create-campaign.md): Create campaign.
- [Update campaign](https://docs.heyy.io/api-reference/update-campaign.md): Update campaign.
- [Get campaign](https://docs.heyy.io/api-reference/get-campaign.md): Get campaign.
- [Delete campaign](https://docs.heyy.io/api-reference/delete-campaign.md): Delete campaign.
- [Add recipients](https://docs.heyy.io/api-reference/add-recipients.md): Add recipients.
- [Remove recipients](https://docs.heyy.io/api-reference/remove-recipients.md): Remove recipients.
- [Start campaign](https://docs.heyy.io/api-reference/start-campaign.md): Start campaign.
- [Search channels](https://docs.heyy.io/api-reference/search-channels.md): Search channels.
- [Get channel](https://docs.heyy.io/api-reference/get-channel.md): Get channel.
- [Search chats](https://docs.heyy.io/api-reference/search-chats.md): Search chats.
- [Get chat](https://docs.heyy.io/api-reference/get-chat.md): Get chat.
- [Delete chat](https://docs.heyy.io/api-reference/delete-chat.md): Delete chat.
- [Change chat status](https://docs.heyy.io/api-reference/change-chat-status.md): Change chat status.
- [Assign chat to team](https://docs.heyy.io/api-reference/assign-chat-to-team.md): Assign chat to team.
- [Assign chat to user](https://docs.heyy.io/api-reference/assign-chat-to-user.md): Assign chat to user.
- [Mark chat as sensitive](https://docs.heyy.io/api-reference/mark-chat-as-sensitive.md): Mark chat as sensitive.
- [Mark chat as not sensitive](https://docs.heyy.io/api-reference/mark-chat-as-not-sensitive.md): Mark chat as not sensitive.
- [Mark chat as read](https://docs.heyy.io/api-reference/mark-chat-as-read.md): Mark chat as read.
- [Mark chat as unread](https://docs.heyy.io/api-reference/mark-chat-as-unread.md): Mark chat as unread.
- [Search contacts](https://docs.heyy.io/api-reference/search-contacts.md): Search contacts.
- [Create contact](https://docs.heyy.io/api-reference/create-contact.md): Create contact.
- [Upsert contact](https://docs.heyy.io/api-reference/upsert-contact.md): Upsert contact.
- [Update contact](https://docs.heyy.io/api-reference/update-contact.md): Updates contact profile fields (first name, last name, and custom attributes). Phone number and email cannot be changed here — use upsert to create or match by identifier.
- [Get contact](https://docs.heyy.io/api-reference/get-contact.md): Get contact.
- [Delete contact](https://docs.heyy.io/api-reference/delete-contact.md): Delete contact.
- [Add labels to contact](https://docs.heyy.io/api-reference/add-labels-to-contact.md): Add labels to contact.
- [Remove labels from contact](https://docs.heyy.io/api-reference/remove-labels-from-contact.md): Remove labels from contact.
- [Subscribe contact](https://docs.heyy.io/api-reference/subscribe-contact.md): Subscribe contact.
- [Unsubscribe contact](https://docs.heyy.io/api-reference/unsubscribe-contact.md): Unsubscribe contact.
- [Bulk upsert contacts](https://docs.heyy.io/api-reference/bulk-upsert-contacts.md): Bulk upsert contacts.
- [Upload file](https://docs.heyy.io/api-reference/upload-file.md): Upload file.
- [Get file](https://docs.heyy.io/api-reference/get-file.md): Get file.
- [Get public file URL](https://docs.heyy.io/api-reference/get-public-file-url.md): Returns a stable public URL for an uploaded file, creating one if it does not exist yet. Use this URL when referencing the file by URL (for example, in automation template media overrides). The URL does not expire.
- [Search journeys](https://docs.heyy.io/api-reference/search-journeys.md): Search journeys.
- [Get journey](https://docs.heyy.io/api-reference/get-journey.md): Get journey.
- [Subscribe contacts to journey](https://docs.heyy.io/api-reference/subscribe-contacts-to-journey.md): Subscribe contacts to journey.
- [Unsubscribe contacts from journey](https://docs.heyy.io/api-reference/unsubscribe-contacts-from-journey.md): Unsubscribe contacts from journey.
- [Search labels](https://docs.heyy.io/api-reference/search-labels.md): Search labels.
- [Create label](https://docs.heyy.io/api-reference/create-label.md): Create label.
- [Update label](https://docs.heyy.io/api-reference/update-label.md): Update label.
- [Get label](https://docs.heyy.io/api-reference/get-label.md): Get label.
- [Delete label](https://docs.heyy.io/api-reference/delete-label.md): Delete label.
- [Send message](https://docs.heyy.io/api-reference/send-message.md): Send a message to a contact on a connected channel.
- [Send template message](https://docs.heyy.io/api-reference/send-template-message.md): Send a template message to a contact on a connected channel.
- [Search message templates](https://docs.heyy.io/api-reference/search-message-templates.md): Search message templates.
- [Create message template](https://docs.heyy.io/api-reference/create-message-template.md): Create message template.
- [Update message template](https://docs.heyy.io/api-reference/update-message-template.md): Update message template.
- [Get message template](https://docs.heyy.io/api-reference/get-message-template.md): Get message template.
- [Delete message template](https://docs.heyy.io/api-reference/delete-message-template.md): Delete message template.
- [Search teams](https://docs.heyy.io/api-reference/search-teams.md): Search teams.
- [Create team](https://docs.heyy.io/api-reference/create-team.md): Create team.
- [Update team](https://docs.heyy.io/api-reference/update-team.md): Update team.
- [Get team](https://docs.heyy.io/api-reference/get-team.md): Get team.
- [Delete team](https://docs.heyy.io/api-reference/delete-team.md): Delete team.
- [Get users](https://docs.heyy.io/api-reference/get-users.md): Get users.
- [Get user](https://docs.heyy.io/api-reference/get-user.md): Get user.
- [Get workspace](https://docs.heyy.io/api-reference/get-workspace.md): Returns the workspace associated with the API key.
- [Overview](https://docs.heyy.io/api-reference/v2/overview.md): Welcome to the Heyy Developer Guide! Whether you’re integration a simple API or building complex integrations, this guide will help you implement our API.
- [Authentication](https://docs.heyy.io/api-reference/v2/authentication.md): How to authenticate requests to the Heyy API.
- [Versioning](https://docs.heyy.io/api-reference/v2/versioning.md): How Heyy versions its public API and deprecates older versions.
- [Rate Limiting](https://docs.heyy.io/api-reference/v2/rate-limiting.md): How API rate limits work and how to handle 429 responses.
- [Error Handling](https://docs.heyy.io/api-reference/v2/error-handling.md): How the Heyy API reports errors and how to handle them.
- [Get attributes](https://docs.heyy.io/api-reference/v2/get-attributes.md)
- [Create attribute](https://docs.heyy.io/api-reference/v2/post-attributes.md)
- [Delete attribute](https://docs.heyy.io/api-reference/v2/delete-attributes-attributeid.md)
- [Get automations](https://docs.heyy.io/api-reference/v2/get-channelid-workflows.md)
- [Trigger automation](https://docs.heyy.io/api-reference/v2/post-channelid-workflows-workflowid.md)
- [Get broadcasts](https://docs.heyy.io/api-reference/v2/get-channelid-broadcasts.md)
- [Create broadcast](https://docs.heyy.io/api-reference/v2/post-channelid-broadcasts.md)
- [Get broadcast by id](https://docs.heyy.io/api-reference/v2/get-channelid-broadcasts-broadcastid.md)
- [Update broadcast](https://docs.heyy.io/api-reference/v2/put-channelid-broadcasts-broadcastid.md)
- [Delete broadcast](https://docs.heyy.io/api-reference/v2/delete-channelid-broadcasts-broadcastid.md)
- [Start broadcast](https://docs.heyy.io/api-reference/v2/post-channelid-broadcasts-broadcastid-start.md)
- [Get broadcast recipients](https://docs.heyy.io/api-reference/v2/get-channelid-broadcasts-broadcastid-recipients.md)
- [Add recipients to broadcast](https://docs.heyy.io/api-reference/v2/post-channelid-broadcasts-broadcastid-recipients.md)
- [Remove recipients from broadcast](https://docs.heyy.io/api-reference/v2/delete-channelid-broadcasts-broadcastid-recipients.md)
- [Get business](https://docs.heyy.io/api-reference/v2/get-business.md)
- [Get channels](https://docs.heyy.io/api-reference/v2/get-channels.md)
- [Get channel by id](https://docs.heyy.io/api-reference/v2/get-channels-channelid.md)
- [Get chats](https://docs.heyy.io/api-reference/v2/get-channelid-chats.md)
- [Get chat by id](https://docs.heyy.io/api-reference/v2/get-channelid-chats-chatid.md)
- [Update chat](https://docs.heyy.io/api-reference/v2/put-channelid-chats-chatid.md)
- [Get contacts](https://docs.heyy.io/api-reference/v2/get-contacts.md)
- [Create contact](https://docs.heyy.io/api-reference/v2/post-contacts.md)
- [Get contact by id](https://docs.heyy.io/api-reference/v2/get-contacts-contactid.md)
- [Update contact](https://docs.heyy.io/api-reference/v2/put-contacts-contactid.md)
- [Delete contact](https://docs.heyy.io/api-reference/v2/delete-contacts-contactid.md)
- [Add contact attribute](https://docs.heyy.io/api-reference/v2/post-contacts-contactid-attributes.md)
- [Remove contact attribute](https://docs.heyy.io/api-reference/v2/delete-contacts-contactid-attributes.md)
- [Upload file](https://docs.heyy.io/api-reference/v2/post-upload_file.md)
- [Get labels](https://docs.heyy.io/api-reference/v2/get-labels.md)
- [Create label](https://docs.heyy.io/api-reference/v2/post-labels.md)
- [Delete label](https://docs.heyy.io/api-reference/v2/delete-labels-labelid.md)
- [Get message templates](https://docs.heyy.io/api-reference/v2/get-message_templates.md)
- [Send WhatsApp message](https://docs.heyy.io/api-reference/v2/post-channelid-whatsapp_messages-send.md)
- [Introduction](https://docs.heyy.io/webhooks/overview.md): Use webhooks to get real-time notifications on events happening across your Heyy workspace.
- [Event types](https://docs.heyy.io/webhooks/event-types.md): Supported webhook event types and their payload structure.
- [message.received](https://docs.heyy.io/webhooks/events/message-received.md): Occurs when a new inbound message is received on one of your channels.
- [message.sent](https://docs.heyy.io/webhooks/events/message-sent.md): Occurs when a new outbound message is created and sent from Heyy.
- [message.updated](https://docs.heyy.io/webhooks/events/message-updated.md): Occurs when an existing message changes, such as a delivery status update.
- [Create API webhook](https://docs.heyy.io/api-reference/create-api-webhook.md): Create API webhook.
- [Update API webhook](https://docs.heyy.io/api-reference/update-api-webhook.md): Update API webhook.
- [Delete API webhook](https://docs.heyy.io/api-reference/delete-api-webhook.md): Delete API webhook.
- [Search API webhooks](https://docs.heyy.io/api-reference/search-api-webhooks.md): Search API webhooks.
- [Product updates](https://docs.heyy.io/changelog/index.md): Stay up to date with Heyy product updates, new features, improvements, and bug fixes.
- [Campaigns & outreach](https://docs.heyy.io/help/campaigns-and-outreach/index.md): Send outbound messages to contact audiences on connected channels.
- [Deleting a workspace](https://docs.heyy.io/help/managing-your-workspace/additional-guides/deleting-workspace.md)
- [Switching workspaces](https://docs.heyy.io/help/managing-your-workspace/additional-guides/switching-workspaces.md)
- [Free 14-day trial](https://docs.heyy.io/help/managing-your-workspace/billing-and-subscription/free-trial.md)
- [Cancelling your subscription](https://docs.heyy.io/help/managing-your-workspace/billing-and-subscription/how-to-cancel-subscription.md)
- [Updating billing information](https://docs.heyy.io/help/managing-your-workspace/billing-and-subscription/how-to-change-billing-information.md)
- [Downloading your invoice](https://docs.heyy.io/help/managing-your-workspace/billing-and-subscription/how-to-download-invoice.md)
- [Workspace & profile](https://docs.heyy.io/help/managing-your-workspace/index.md): Your Heyy account, workspace team, billing, and workspace lifecycle.

## OpenAPI Specs

- [openapi-v2](/api-reference/openapi-v2.json)
- [openapi-v3](/api-reference/openapi-v3.json)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.