# MsgFlash

## Docs

- [GET Legacy usage compatibility](https://docs.msgflash.com/api-reference/billing/legacy-usage.md): Legacy alias for public usage under `/api/v1/usage`.
- [GET Payment history](https://docs.msgflash.com/api-reference/billing/payments.md): Paginated list of account payments.
- [GET List plans](https://docs.msgflash.com/api-reference/billing/plans.md): Return the catalog of active MsgFlash plans.
- [GET Current subscription](https://docs.msgflash.com/api-reference/billing/subscription.md): Return the current subscription, portal usage, and current period.
- [GET Extended billing usage](https://docs.msgflash.com/api-reference/billing/usage.md): Return plan, limits, features, usage, and current period.
- [POST Create a campaign](https://docs.msgflash.com/api-reference/campaigns/create.md): Create and schedule a messaging campaign.
- [GET Retrieve a campaign](https://docs.msgflash.com/api-reference/campaigns/get.md): Retrieve campaign details.
- [POST Pause a campaign](https://docs.msgflash.com/api-reference/campaigns/pause.md): Pause a campaign when its status allows it.
- [POST Resume a campaign](https://docs.msgflash.com/api-reference/campaigns/resume.md): Resume a paused campaign.
- [GET Campaign statistics](https://docs.msgflash.com/api-reference/campaigns/stats.md): Retrieve campaign statistics and execution timeline.
- [POST Add members](https://docs.msgflash.com/api-reference/contact-groups/add-members.md): Add multiple contacts to a group.
- [GET List groups for a contact](https://docs.msgflash.com/api-reference/contact-groups/contact-groups.md): List the groups a contact belongs to.
- [POST Create a group](https://docs.msgflash.com/api-reference/contact-groups/create.md): Create a contact group.
- [DELETE Delete a group](https://docs.msgflash.com/api-reference/contact-groups/delete.md): Delete a contact group.
- [GET Retrieve a group](https://docs.msgflash.com/api-reference/contact-groups/get.md): Retrieve contact group details.
- [GET List groups](https://docs.msgflash.com/api-reference/contact-groups/list.md): List your account contact groups with cursor pagination and optional search.
- [GET List group members](https://docs.msgflash.com/api-reference/contact-groups/list-members.md): List group members with pagination and search.
- [DELETE Remove members](https://docs.msgflash.com/api-reference/contact-groups/remove-members.md): Remove multiple contacts from a group.
- [PUT Update a group](https://docs.msgflash.com/api-reference/contact-groups/update.md): Update a contact group.
- [POST Bulk delete contacts](https://docs.msgflash.com/api-reference/contacts/bulk-delete.md): Delete multiple contacts in a single request.
- [POST Cancel bulk contact job](https://docs.msgflash.com/api-reference/contacts/bulk-jobs-cancel.md): Cancel a pending or processing asynchronous bulk contact job.
- [GET Bulk contact job](https://docs.msgflash.com/api-reference/contacts/bulk-jobs-get.md): Return details for one asynchronous bulk contact job.
- [GET List bulk contact jobs](https://docs.msgflash.com/api-reference/contacts/bulk-jobs-list.md): List recent asynchronous bulk jobs triggered from contact bulk operations.
- [GET Bulk contact job progress](https://docs.msgflash.com/api-reference/contacts/bulk-jobs-progress.md): Return the current progress and partial summary for an asynchronous bulk contact job.
- [POST Create a contact](https://docs.msgflash.com/api-reference/contacts/create.md): Create a contact in your MsgFlash directory.
- [DELETE Delete a contact](https://docs.msgflash.com/api-reference/contacts/delete.md): Delete a contact from your account.
- [GET Retrieve a contact](https://docs.msgflash.com/api-reference/contacts/get.md): Retrieve contact details.
- [GET List contacts](https://docs.msgflash.com/api-reference/contacts/list.md): List your account contacts with cursor pagination and optional search.
- [PUT Update a contact](https://docs.msgflash.com/api-reference/contacts/update.md): Update an existing contact.
- [GET Retrieve an instance](https://docs.msgflash.com/api-reference/instances/get.md): Retrieve instance details by ID.
- [GET Instance health](https://docs.msgflash.com/api-reference/instances/health.md): Return an instance warmup and safety state to guide message sends.
- [GET List instances](https://docs.msgflash.com/api-reference/instances/list.md): List all active WhatsApp instances for your account.
- [GET Live instance state](https://docs.msgflash.com/api-reference/instances/state.md): Query a live instance connection state from the provider.
- [API reference](https://docs.msgflash.com/api-reference/introduction.md): Base URL, authentication, rate limiting, response format, and complete MsgFlash public API surface.
- [GET Retrieve a message](https://docs.msgflash.com/api-reference/messages/get.md): Retrieve message details by message ID.
- [GET List messages](https://docs.msgflash.com/api-reference/messages/list.md): List messages with cursor-based pagination.
- [POST Schedule a message](https://docs.msgflash.com/api-reference/messages/schedule.md): Schedule a future message in direct mode or with a template.
- [POST Send a message](https://docs.msgflash.com/api-reference/messages/send.md): Send an immediate message in direct mode or with a template.
- [POST Cancel a lookup](https://docs.msgflash.com/api-reference/number-lookups/cancel.md): Cancel a pending or processing async number lookup.
- [POST Create a number lookup](https://docs.msgflash.com/api-reference/number-lookups/create.md): Check one or more WhatsApp numbers synchronously or asynchronously depending on volume.
- [GET Lookup details](https://docs.msgflash.com/api-reference/number-lookups/get.md): Return status, metrics, and results for a number lookup.
- [POST Import matched numbers as contacts](https://docs.msgflash.com/api-reference/number-lookups/import-contacts.md): Create or update MsgFlash contacts from numbers detected on WhatsApp.
- [GET List lookups](https://docs.msgflash.com/api-reference/number-lookups/list.md): List number lookups already created on your account.
- [GET Lookup progress](https://docs.msgflash.com/api-reference/number-lookups/progress.md): Return the current progress and intermediate counters for an async number lookup.
- [POST Publish a status](https://docs.msgflash.com/api-reference/statuses/create.md): Publish a text or image WhatsApp status.
- [Team context](https://docs.msgflash.com/api-reference/teams/team-context.md): How X-Team-Id selects the team workspace for the public API (team keys) and the console API (JWT).
- [POST Create a template](https://docs.msgflash.com/api-reference/templates/create.md): Create a text or media template. Variables are recalculated automatically.
- [DELETE Delete a template](https://docs.msgflash.com/api-reference/templates/delete.md): Delete a template from your account.
- [GET Retrieve a template](https://docs.msgflash.com/api-reference/templates/get.md): Retrieve template details.
- [GET List templates](https://docs.msgflash.com/api-reference/templates/list.md): List account templates with simple pagination.
- [POST Preview a template](https://docs.msgflash.com/api-reference/templates/preview.md): Render a template with the provided context without sending a message.
- [PUT Update a template](https://docs.msgflash.com/api-reference/templates/update.md): Update an existing template and recalculate its variables.
- [POST Create a webhook](https://docs.msgflash.com/api-reference/webhooks/create.md): Create a webhook endpoint and return its secret.
- [DELETE Delete a webhook](https://docs.msgflash.com/api-reference/webhooks/delete.md): Delete an existing webhook endpoint.
- [GET List webhooks](https://docs.msgflash.com/api-reference/webhooks/list.md): List your MsgFlash webhook endpoints.
- [Authentication](https://docs.msgflash.com/authentication.md): How to authenticate requests for the dashboard and the public MsgFlash API.
- [Fundamentals](https://docs.msgflash.com/fundamentals.md): Core concepts to understand MsgFlash before integrating the API.
- [Billing](https://docs.msgflash.com/guides/billing.md): Read your current plan, usage, and billing history from the public API.
- [Campaigns](https://docs.msgflash.com/guides/campaigns.md): Create scheduled campaigns, track progress, and control execution.
- [Contacts and groups](https://docs.msgflash.com/guides/contacts.md): Manage MsgFlash contacts, contact groups, and bulk deletions through the public API.
- [Dashboard authentication](https://docs.msgflash.com/guides/dashboard-auth.md): Sign in, sign up, Google OAuth, and email verification flows for the MsgFlash console.
- [WhatsApp instances](https://docs.msgflash.com/guides/instances.md): Understand WhatsApp instances and query their state through the public API.
- [Temporary media uploads](https://docs.msgflash.com/guides/media-uploads.md): Prepare temporary media before sending direct messages from the MsgFlash console.
- [Verify WhatsApp numbers](https://docs.msgflash.com/guides/number-lookups.md): Check whether one or more numbers are on WhatsApp, then import matched numbers as contacts.
- [Schedule a message](https://docs.msgflash.com/guides/schedule-message.md): Schedule a future send in direct mode or with a template.
- [Send a message](https://docs.msgflash.com/guides/send-message.md): Send any WhatsApp message type in direct mode or using a MsgFlash template.
- [WhatsApp statuses](https://docs.msgflash.com/guides/statuses.md): Publish text or image WhatsApp statuses from a connected instance.
- [Teams & workspaces](https://docs.msgflash.com/guides/teams-workspaces.md): Pro and Plus teams, invitations, team API keys, and X-Team-Id for the public API.
- [Templates](https://docs.msgflash.com/guides/templates.md): Manage MsgFlash templates and preview their rendered output with variables.
- [Webhooks](https://docs.msgflash.com/guides/webhooks.md): Manage webhook endpoints and verify signed events sent by MsgFlash.
- [Introduction](https://docs.msgflash.com/introduction.md): MsgFlash is a WhatsApp automation API for messages, campaigns, contacts, templates, webhooks, and billing.
- [Quickstart](https://docs.msgflash.com/quickstart.md): Send your first WhatsApp message through MsgFlash in a few minutes.
- [Error codes](https://docs.msgflash.com/resources/error-codes.md): Main error codes returned by the MsgFlash public API.
- [FAQ](https://docs.msgflash.com/resources/faq.md): Common questions about MsgFlash, plans, API keys, and webhooks.
- [Message types](https://docs.msgflash.com/resources/message-types.md): Reference of message types supported by MsgFlash, their fields, and how they are used with templates.
- [Plans and quotas](https://docs.msgflash.com/resources/plans-and-quotas.md): MsgFlash plan comparison and usage tracking through the public API.

## OpenAPI Specs

- [openapi](https://docs.msgflash.com/api-reference/openapi.json)