# Heymarket API Documentation

## Docs

- [Batch create contacts](https://developers.heymarket.com/api-reference/contacts/bulk.md): Create multiple contacts with the legacy v1 batch endpoint.
- [Bulk delete contacts (v2)](https://developers.heymarket.com/api-reference/contacts/bulk-delete-v2.md): Bulk delete v2 contacts by UUID.
- [Bulk create contacts (v2)](https://developers.heymarket.com/api-reference/contacts/bulk-v2.md): Bulk create or update v2 contacts.
- [Create contact channel](https://developers.heymarket.com/api-reference/contacts/channels.md): Add a phone, email, or other channel to a v2 contact.
- [Delete contact channel](https://developers.heymarket.com/api-reference/contacts/channels-delete.md): Delete a channel from a v2 contact.
- [Get contact channel](https://developers.heymarket.com/api-reference/contacts/channels-get.md): Get one channel from a v2 contact.
- [List contact channels](https://developers.heymarket.com/api-reference/contacts/channels-list.md): List all channels for a v2 contact.
- [Update contact channel](https://developers.heymarket.com/api-reference/contacts/channels-update.md): Update a channel on a v2 contact.
- [List contact fields](https://developers.heymarket.com/api-reference/contacts/contact-fields.md): List custom contact fields for your team.
- [Count contacts](https://developers.heymarket.com/api-reference/contacts/count.md): Get the count of contacts that match the pagination filters.
- [Create contact](https://developers.heymarket.com/api-reference/contacts/create.md): Create a contact with the v1 phone-number-based endpoint.
- [Create contact (v2)](https://developers.heymarket.com/api-reference/contacts/create-v2.md): Create a contact with v2 contact channels.
- [Delete contact](https://developers.heymarket.com/api-reference/contacts/delete.md): Delete a contact by integer ID.
- [Delete contact (v2)](https://developers.heymarket.com/api-reference/contacts/delete-v2.md): Delete a contact by UUID.
- [Get contact](https://developers.heymarket.com/api-reference/contacts/get.md): Get a contact by integer ID.
- [Get contact by phone or ID](https://developers.heymarket.com/api-reference/contacts/get-by-phone-or-id.md): Get a contact by phone number or integer ID.
- [Get contact (v2)](https://developers.heymarket.com/api-reference/contacts/get-v2.md): Get a contact by UUID.
- [List contacts](https://developers.heymarket.com/api-reference/contacts/list.md): Paginate contacts with the v1 cursor-based endpoint.
- [List contacts (v2)](https://developers.heymarket.com/api-reference/contacts/list-v2.md): List contacts with v2 pagination.
- [Contacts API overview](https://developers.heymarket.com/api-reference/contacts/overview.md): Manage contacts in Heymarket: create, retrieve, update, delete, search, and control opt-out and block status across v1 and v2 endpoints.
- [Search contacts](https://developers.heymarket.com/api-reference/contacts/search.md): Search contacts by channel value, such as phone number or email address.
- [Set contact status](https://developers.heymarket.com/api-reference/contacts/set-status.md): Update a contact's messaging status.
- [Get contact status](https://developers.heymarket.com/api-reference/contacts/status.md): Get a contact's messaging status.
- [Update contact](https://developers.heymarket.com/api-reference/contacts/update.md): Update a v1 contact by integer ID.
- [Update contact (v2)](https://developers.heymarket.com/api-reference/contacts/update-v2.md): Update a v2 contact by UUID.
- [Close conversation](https://developers.heymarket.com/api-reference/conversations/close.md): Mark a conversation as closed.
- [Count conversations](https://developers.heymarket.com/api-reference/conversations/count.md): Get the count of conversations matching the provided filters.
- [Get conversation](https://developers.heymarket.com/api-reference/conversations/get.md): Get a conversation by ID.
- [List conversations](https://developers.heymarket.com/api-reference/conversations/list.md): Paginate conversations across one or more inboxes.
- [Mark conversation as read](https://developers.heymarket.com/api-reference/conversations/mark-read.md): Mark a conversation as read for a user.
- [Mark conversation as unread](https://developers.heymarket.com/api-reference/conversations/mark-unread.md): Mark a conversation as unread for a user.
- [Open conversation](https://developers.heymarket.com/api-reference/conversations/open-close.md): Mark a conversation as open.
- [Reassign conversation](https://developers.heymarket.com/api-reference/conversations/reassign.md): Reassign a conversation to another user.
- [Transfer conversation](https://developers.heymarket.com/api-reference/conversations/transfer.md): Transfer a conversation to another inbox.
- [Get inboxes](https://developers.heymarket.com/api-reference/inboxes.md): Retrieve inboxes available to your team.
- [Create list](https://developers.heymarket.com/api-reference/lists/create.md): Create a contact list with the v2 list endpoint.
- [Delete list](https://developers.heymarket.com/api-reference/lists/delete.md): Delete a v2 list.
- [Lists API overview](https://developers.heymarket.com/api-reference/lists/overview.md): Organize contacts into named lists for broadcast messaging. Each contact receives messages individually and can reply privately to your team.
- [Update list](https://developers.heymarket.com/api-reference/lists/update.md): Update a v2 list by adding, removing, or replacing recipients.
- [Count messages](https://developers.heymarket.com/api-reference/messages/count.md): Get the count of team messages that match the pagination filters.
- [Get message history from a conversation](https://developers.heymarket.com/api-reference/messages/get-history.md): Get the 50 most recent messages from a conversation by phone number and inbox.
- [List all messages](https://developers.heymarket.com/api-reference/messages/list-all.md): Paginate messages across your team.
- [Send SMS and MMS messages](https://developers.heymarket.com/api-reference/messages/send.md): Send individual SMS or MMS, broadcast to a contact list, or post a private internal comment.
- [Send email messages](https://developers.heymarket.com/api-reference/messages/send-email.md): Send email from a Heymarket inbox or reply in an existing email conversation.
- [Create scheduled message](https://developers.heymarket.com/api-reference/schedule.md): Schedule a message for future delivery.
- [Delete scheduled message](https://developers.heymarket.com/api-reference/schedule-delete.md): Delete a scheduled message by ID.
- [Get scheduled message](https://developers.heymarket.com/api-reference/schedule-get.md): Get a scheduled message by ID.
- [Update scheduled message](https://developers.heymarket.com/api-reference/schedule-update.md): Update a scheduled message by ID.
- [List surveys](https://developers.heymarket.com/api-reference/surveys.md): Paginate surveys.
- [Get survey](https://developers.heymarket.com/api-reference/surveys-get.md): Get a survey by ID.
- [List tags](https://developers.heymarket.com/api-reference/tags.md): Paginate contact tags.
- [Create tag](https://developers.heymarket.com/api-reference/tags-create.md): Create a contact tag.
- [Delete tag](https://developers.heymarket.com/api-reference/tags-delete.md): Delete a contact tag by ID.
- [Get tag](https://developers.heymarket.com/api-reference/tags-get.md): Get a contact tag by ID.
- [Get team](https://developers.heymarket.com/api-reference/team.md): Retrieve the current team and its members.
- [Create template](https://developers.heymarket.com/api-reference/templates/create.md): Create a reusable message template.
- [Delete template](https://developers.heymarket.com/api-reference/templates/delete.md): Delete a template by ID.
- [Get template](https://developers.heymarket.com/api-reference/templates/get.md): Get a template by ID.
- [List templates](https://developers.heymarket.com/api-reference/templates/list.md): Paginate message templates.
- [Template operations](https://developers.heymarket.com/api-reference/templates/manage.md): Use the split template operation pages for generated request and response details.
- [Templates API overview and objects](https://developers.heymarket.com/api-reference/templates/overview.md): Understand the Template object, merge token syntax, and the full set of endpoints for creating and managing reusable message templates.
- [Update template](https://developers.heymarket.com/api-reference/templates/update.md): Update a template by ID.
- [Get users](https://developers.heymarket.com/api-reference/users.md): Look up team users by phone or email.
- [Update users](https://developers.heymarket.com/api-reference/users-update.md): Update team user fields and roles.
- [Receive webhook event](https://developers.heymarket.com/api-reference/webhooks.md): Schema for the Heymarket webhook event callback.
- [Authenticate with the Heymarket API](https://developers.heymarket.com/authentication.md): Create API Secrets, generate short-lived JWTs, and authenticate Heymarket API requests.
- [Contacts](https://developers.heymarket.com/concepts/contacts.md): Understand how Heymarket contacts store customer identity, channels, custom fields, tags, ownership, and messaging status.
- [Conversations](https://developers.heymarket.com/concepts/conversations.md): Understand how Heymarket conversations group messages by contact, inbox, assignment, read state, and open or closed status.
- [Inboxes](https://developers.heymarket.com/concepts/inboxes.md): Understand how Heymarket inboxes map to team channels, phone numbers, member access, and sender IDs used by message requests.
- [Lists, templates, and scheduled sends](https://developers.heymarket.com/concepts/lists-templates-scheduling.md): Understand the reusable Heymarket objects that support broadcasts, personalized messages, scheduled delivery, tags, and surveys.
- [Messages](https://developers.heymarket.com/concepts/messages.md): Understand Heymarket message types, send targets, media, templates, broadcasts, scheduled sends, and private comments.
- [Webhooks](https://developers.heymarket.com/concepts/webhooks.md): Understand how Heymarket webhooks send real-time event notifications to your integration.
- [Send broadcast messages](https://developers.heymarket.com/guides/broadcast-messages.md): Create contact lists and send broadcast messages where each recipient gets an individual thread in Heymarket.
- [Create and manage contacts](https://developers.heymarket.com/guides/manage-contacts.md): Create, update, search, list, and delete Heymarket contacts, including custom fields, tags, and channel-based lookup.
- [Send SMS and MMS messages](https://developers.heymarket.com/guides/send-message.md): Send individual messages, MMS attachments, templates, broadcasts, and private comments with POST /v1/message/send.
- [Receive webhook events](https://developers.heymarket.com/guides/webhooks.md): Configure a webhook receiver for Heymarket events, validate the payload token, and acknowledge deliveries quickly.
- [Heymarket API](https://developers.heymarket.com/index.md): Use the Heymarket REST API to send messages, manage contacts, organize conversations, and connect Heymarket with your own systems.
- [Get started with the Heymarket API](https://developers.heymarket.com/introduction.md): An overview of the Heymarket REST API: what it is, what you can build with it, the base URL, JSON encoding requirements, and mandatory HTTPS.
- [Rate limits and request IDs](https://developers.heymarket.com/rate-limits.md): Understand the Heymarket API's 500 req/min rate limit, how to use X-Request-Id when contacting support, and how to handle HTTP error codes.

## OpenAPI Specs

- [heymarket-openapi-3.1.2](https://developers.heymarket.com/api-reference/openapi/heymarket-openapi-3.1.2.yaml)