# Superchat Documentation

> Programmatically send messages on WhatsApp, SMS, Instagram, Facebook Messenger, Telegram and E-Mail via the Superchat API.

## Guides
- [Get started](https://developers.superchat.com/docs/become-a-tech-partner.md): Build and grow with us
- [Welcome to guides](https://developers.superchat.com/docs/welcome-to-guides.md)
- [Getting Started](https://developers.superchat.com/docs/getting-started-send-your-first-message.md): This guide provides everything you need to know about sending messages on WhatsApp, Instagram, SMS, and email. It includes guidance on how to update contacts in Superchat, too.
- [Message channels](https://developers.superchat.com/docs/message-channels.md): Learn more about how the different message channels work.
- [Messaging errors](https://developers.superchat.com/docs/messaging-errors.md): Learn about errors that might occur when sending messages via any of our connected channels.
- [Introduction](https://developers.superchat.com/docs/introduction.md): Learn more about the Superchat Web Widget SDK.
- [Web Widget Embed](https://developers.superchat.com/docs/webchat-widget.md): Learn how to integrate our webchat widget.
- [Web Widget SDK](https://developers.superchat.com/docs/widget-sdk.md): Get full control over the Web Widget using our Javascript SDK.

## API Reference
- [Authentication](https://developers.superchat.com/reference/authentication.md)
- [Rate Limiting](https://developers.superchat.com/reference/rate-limiting.md): Learn about how we apply rate limits to your API requests
- [Welcome](https://developers.superchat.com/reference/welcome.md): Get started with the Superchat API in minutes.
- [Get a channel](https://developers.superchat.com/reference/get_channels-channelid.md): Returns a single channel by ID.
- [List all channels](https://developers.superchat.com/reference/get_channels.md): Lists all channels in workspace. You can specify a limit of objects to be returned in one response, as well as set a *next* or *previous* value to navigate through the object stream. Objects are sorted descendingly by their *created_at* value. Please mind, you can only specify *next* or *previous* at once.
- [Channels](https://developers.superchat.com/reference/channels.md): Channels are the core piece through which messages are sent and received.
- [Get a contact list](https://developers.superchat.com/reference/get_contact-lists-contactlistid.md): Returns a single contact lists
- [List contact lists](https://developers.superchat.com/reference/get_contact-lists.md): Returns all contact lists for a workspace.
- [Remove contact from contact list](https://developers.superchat.com/reference/delete_contacts-contactid-contact-lists-contactlistid.md): Deletes a single contact from a contact list
- [Delete a contact](https://developers.superchat.com/reference/delete_contacts-contactid.md): Deletes a contact in a workspace.
- [List contact lists for contact](https://developers.superchat.com/reference/get_contacts-contactid-contact-lists.md): Returns all contact lists a contact is part of.
- [Get conversations for a contact](https://developers.superchat.com/reference/get_contacts-contactid-conversations.md): Returns all conversations a contact has
- [Get a contact](https://developers.superchat.com/reference/get_contacts-contactid.md): Returns a single contact
- [List all contacts](https://developers.superchat.com/reference/get_contacts.md): Lists all contacts in workspace. You can specify a limit of objects to be returned in one response, as well as set a *next* or *previous* value to navigate through the object stream. Objects are sorted descendingly by their *created_at* value. Please mind, you can only specify *next* or *previous* at once.
- [Contacts](https://developers.superchat.com/reference/contacts.md): Create, update or delete contacts in Superchat.
- [Update a contact](https://developers.superchat.com/reference/patch_contacts-contactid.md): Updates a contact in your Superchat workspace.
- [Add contact to contact list](https://developers.superchat.com/reference/post_contacts-contactid-contact-lists.md): Adds a contact to a single contact list.
- [Search all contacts](https://developers.superchat.com/reference/post_contacts-search.md): Search a contact by any field.
- [Create a contact](https://developers.superchat.com/reference/post_contacts.md): Creates a new contact in your Superchat workspace.
- [Get a conversation export](https://developers.superchat.com/reference/get_conversations-conversationid-export-conversationexportid.md): Retrieve an export of a conversation.
- [Conversation Exports](https://developers.superchat.com/reference/conversation-exports.md)
- [Create a conversation export](https://developers.superchat.com/reference/post_conversations-conversationid-export.md): Creates a conversation export job
- [Delete a conversation](https://developers.superchat.com/reference/delete_conversations-id.md): Deletes a conversation
- [Get conversation messages](https://developers.superchat.com/reference/get_conversations-id-messages.md): List all messages for a conversation. This endpoint is available for enterprise customers only. Contact your account manager to get access.
- [Get a conversation](https://developers.superchat.com/reference/get_conversations-id.md): Returns a single conversation
- [List all conversations](https://developers.superchat.com/reference/get_conversations.md): Returns all conversations.
- [Conversations](https://developers.superchat.com/reference/conversations.md)
- [Update a conversation](https://developers.superchat.com/reference/patch_conversations-id.md): Updates data of a conversation
- [Delete a custom attribute](https://developers.superchat.com/reference/delete_custom-attributes-id.md): Deletes a custom contact attribute.
- [List all custom attributes](https://developers.superchat.com/reference/get_custom-attributes.md): Returns all custom contact attributes.
- [Create a custom attribute](https://developers.superchat.com/reference/post_custom-attributes.md): Creates a new custom contact attribute.
- [Update a custom attribute](https://developers.superchat.com/reference/put_custom-attributes-id.md): Update a custom contact attribute.
- [Delete a file](https://developers.superchat.com/reference/delete_files-fileid.md): Deletes a file in a workspace.
- [Get a file](https://developers.superchat.com/reference/get_files-fileid.md): Returns a single file in a workspace.
- [List all files](https://developers.superchat.com/reference/get_files.md): Lists all files in workspace. You can specify a limit of objects to be returned in one response, as well as set a *next* or *previous* value to navigate through the object stream. Objects are sorted descendingly by their *created_at* value. Please mind, you can only specify *next* or *previous* at once.
- [Upload a file](https://developers.superchat.com/reference/post_files.md): Upload a new file to the Superchat servers.
- [Get an inbox](https://developers.superchat.com/reference/get_inboxes-inboxid.md): Returns a single inbox for a workspace.
- [List all inboxes](https://developers.superchat.com/reference/get_inboxes.md): Returns all inboxes for a workspace.
- [Get a label](https://developers.superchat.com/reference/get_labels-labelid.md): Returns a single label by ID.
- [List all labels](https://developers.superchat.com/reference/get_labels.md): Returns all conversation labels for a workspace.
- [Labels](https://developers.superchat.com/reference/labels.md)
- [Fetch message analytics](https://developers.superchat.com/reference/get_analytics-messages.md): Returns engagement analytics for multiple messages. Request body specifies message IDs. Each result includes message_id and the analytics object with nullable ISO-8601 timestamps for each engagement event. Missing or inaccessible message IDs are omitted from results.
- [Messages](https://developers.superchat.com/reference/messages.md): Send messages on any of our connected platforms.
- [Send a message](https://developers.superchat.com/reference/post_messages.md): Send a message on the specified channel (`from` object) to a new or existing contact (`to` object).
- [Delete conversation note](https://developers.superchat.com/reference/delete_conversations-conversationid-notes-noteid.md): Delete a note from a conversation.
- [Get a conversation note](https://developers.superchat.com/reference/get_conversations-conversationid-notes-noteid.md): Return a single note in a conversation.
- [Get conversation notes](https://developers.superchat.com/reference/get_conversations-id-notes.md): Lists all notes in a conversation.
- [Create conversation note](https://developers.superchat.com/reference/post_conversations-id-notes.md): Create a note in a conversation.
- [Update conversation note](https://developers.superchat.com/reference/put_conversations-conversationid-notes-noteid.md): Update a note in a conversation.
- [Delete a template folder](https://developers.superchat.com/reference/delete_template-folders-id.md): Delete a template folder
- [Get a template folder](https://developers.superchat.com/reference/get_template-folders-id.md): Get a template folder
- [List all template folders](https://developers.superchat.com/reference/get_template-folders.md): List all template folders
- [Create a template folder](https://developers.superchat.com/reference/post_template-folders.md): Create a template folder
- [Update a template folder](https://developers.superchat.com/reference/put_template-folders-id.md): Update a template folder
- [Delete a template](https://developers.superchat.com/reference/delete_templates-id.md): Deletes a template in a workspace.
- [Fetch template aggregated analytics](https://developers.superchat.com/reference/get_analytics-templates.md): Returns aggregated engagement counts and rates for multiple templates within the specified date range. Request body specifies template IDs and from/to. Each result includes template_id and the analytics object with period, absolute counts, and rates. Missing or inaccessible template IDs are omitted from results.
- [Get a template](https://developers.superchat.com/reference/get_templates-id.md): Return a single template by ID
- [List all templates](https://developers.superchat.com/reference/get_templates.md): List all templates for a workspace
- [Templates](https://developers.superchat.com/reference/templates.md): Fetch templates for WhatsApp and other channels - and check their variable data.
- [Update a template](https://developers.superchat.com/reference/patch_templates-id.md): Update a template name or move it into a template folder.
- [Create a template](https://developers.superchat.com/reference/post_templates.md): Create a new template in a workspace
- [Get current user](https://developers.superchat.com/reference/get_me.md): Retrieve the information about yourself as a Superchat user
- [Get a user](https://developers.superchat.com/reference/get_users-userid.md): Returns a single user for a workspace.
- [List all users](https://developers.superchat.com/reference/get_users.md): List all users for a workspace.
- [Users](https://developers.superchat.com/reference/users.md)
- [Delete a webhook subscription](https://developers.superchat.com/reference/delete_webhooks-subscriptionid.md): Delete a webhook subscription
- [Get a webhook subscription](https://developers.superchat.com/reference/get_webhooks-subscriptionid.md): Get a webhook subscription
- [List all webhook subscriptions](https://developers.superchat.com/reference/get_webhooks.md): List all webhook subscriptions
- [Create a webhook subscription](https://developers.superchat.com/reference/post_webhooks.md): Create a webhook subscription
- [Update a webhook subscription](https://developers.superchat.com/reference/put_webhooks-subscriptionid.md): Update a webhook subscription