# BulkNeo API

> Send WhatsApp messages from your own numbers with a simple HTTP API.

## Docs

- [Create a number slot](https://apidoc.bulkneo.com/api-reference/instances/create.md): POST /v1/instances — create an instance to connect a new WhatsApp number to.
- [Disconnect or delete a number](https://apidoc.bulkneo.com/api-reference/instances/delete.md): DELETE /v1/instances/{id} — sign WhatsApp out, or remove the instance entirely.
- [List your numbers](https://apidoc.bulkneo.com/api-reference/instances/list.md): GET /v1/instances — every number on your account and whether it can send.
- [Get a QR code](https://apidoc.bulkneo.com/api-reference/instances/qr.md): GET /v1/instances/{id}/qr — a fresh pairing QR for a number.
- [Poll while someone scans](https://apidoc.bulkneo.com/api-reference/instances/qr-status.md): GET /v1/instances/{id}/qr-status — current QR, rotation count, and whether the scan has landed.
- [Rename a number](https://apidoc.bulkneo.com/api-reference/instances/rename.md): PATCH /v1/instances/{id} — change the label on one of your numbers.
- [Check one number](https://apidoc.bulkneo.com/api-reference/instances/status.md): GET /v1/instances/{id}/status — the live connection state of one number.
- [API reference](https://apidoc.bulkneo.com/api-reference/introduction.md): Base URL, request shape, response shape, and the fields every endpoint shares.
- [Send a voice note](https://apidoc.bulkneo.com/api-reference/messages/audio.md): POST /v1/messages/audio — audio that arrives as a voice note.
- [Send buttons](https://apidoc.bulkneo.com/api-reference/messages/buttons.md): POST /v1/messages/buttons — up to three tappable buttons.
- [Send a contact card](https://apidoc.bulkneo.com/api-reference/messages/contact.md): POST /v1/messages/contact — one or more contact cards the recipient can save or call.
- [Send a document](https://apidoc.bulkneo.com/api-reference/messages/document.md): POST /v1/messages/document — any file, sent as an attachment.
- [Send an image](https://apidoc.bulkneo.com/api-reference/messages/image.md): POST /v1/messages/image — an image from a public link, with an optional caption.
- [Send a list menu](https://apidoc.bulkneo.com/api-reference/messages/list.md): POST /v1/messages/list — a tappable menu grouped into sections.
- [Send a location](https://apidoc.bulkneo.com/api-reference/messages/location.md): POST /v1/messages/location — a pin on the map.
- [Send a poll](https://apidoc.bulkneo.com/api-reference/messages/poll.md): POST /v1/messages/poll — a poll the recipient can vote in.
- [React to a message](https://apidoc.bulkneo.com/api-reference/messages/reaction.md): POST /v1/messages/reaction — add or remove an emoji reaction.
- [Send a sticker](https://apidoc.bulkneo.com/api-reference/messages/sticker.md): POST /v1/messages/sticker — a sticker from a public link.
- [Send a text message](https://apidoc.bulkneo.com/api-reference/messages/text.md): POST /v1/messages/text — a plain text WhatsApp message.
- [Send a video](https://apidoc.bulkneo.com/api-reference/messages/video.md): POST /v1/messages/video — a video from a public link, with an optional caption.
- [Check numbers](https://apidoc.bulkneo.com/api-reference/numbers/check.md): POST /v1/numbers/check — which of these numbers are on WhatsApp?
- [Health check](https://apidoc.bulkneo.com/api-reference/service/health.md): GET /health — is the API up?
- [Authentication](https://apidoc.bulkneo.com/authentication.md): How API keys work, where to put them, and how to rotate one without downtime.
- [Errors](https://apidoc.bulkneo.com/errors.md): Every error the API can return, what causes it, and what to do next.
- [Checking numbers before you send](https://apidoc.bulkneo.com/guides/checking-numbers.md): Why it saves money and protects your number, and how to pace a large list.
- [If your number disconnects](https://apidoc.bulkneo.com/guides/disconnects.md): What a 409 really means, why retrying never fixes it, and how to reconnect without changing a line of code.
- [Buttons and lists are best-effort](https://apidoc.bulkneo.com/guides/interactive-messages.md): Why a 200 on an interactive message does not mean the buttons appeared, and what to do instead.
- [What is not available yet](https://apidoc.bulkneo.com/guides/not-available-yet.md): The things people reasonably expect from a WhatsApp API that this one does not do.
- [Replying to a message](https://apidoc.bulkneo.com/guides/replies.md): Quote an earlier message so your reply appears attached to it in the chat.
- [Sending media](https://apidoc.bulkneo.com/guides/sending-media.md): There is no upload endpoint — you host the file, we fetch the link. What makes a link work, and what makes it fail.
- [BulkNeo WhatsApp API](https://apidoc.bulkneo.com/index.md): Send WhatsApp messages from your own numbers, straight from your software.
- [Quickstart](https://apidoc.bulkneo.com/quickstart.md): Connect a number, create a key, and send your first WhatsApp message.

## OpenAPI Specs

- [openapi](https://apidoc.bulkneo.com/api-reference/openapi.json)