Skip to main content
POST
cURL (Windows)
The playground on this page is live. There is no test mode and no sandbox: pressing Send authenticates with the key you paste and really calls https://api.bulkneo.com — a send delivers a real WhatsApp message to the number you type, and an instance call really changes your account. Use your own number while you are exploring, and paste a key only from a machine you trust.Your browser remembers what you type into the playground, so a key you paste here is still in the Authorization box on your next visit. Nobody else sees it — it never leaves your machine and it is not part of this site — but on a shared or borrowed computer, clear the site data when you are done.
Creates an empty slot for a WhatsApp number and returns its instance_id. Nothing is connected yet — someone still has to scan a QR with the phone.
Most people never call this. Adding a number in the portal is easier, and it shows the QR for you. This endpoint exists for software that provisions numbers on its own.

Notes

  • label is optional, up to 60 characters. It is for your own reference only; nothing about sending depends on it.
  • The response may include a qrcode straight away. If qrcode is null, fetch one from GET /v1/instances/{id}/qr.
  • Creating an instance counts against your account’s number allowance. Over it, you get 403 instance_limit_reached with details.instance_limit. See Plans and limits.
  • This is the only instance endpoint that requires an active plan. Listing, checking, re-scanning, renaming and deleting all keep working when a plan has lapsed.

Connecting the number afterwards

1

Get a QR

Use the qrcode from this response, or call GET /v1/instances/{id}/qr.
2

Show it to the person holding the phone

qrcode.base64 is a data:image/png;base64,... string you can put straight into an <img src="...">.
3

They scan it

WhatsApp → Settings → Linked devices → Link a device.
4

Poll until it connects

Call GET /v1/instances/{id}/qr-status about every 2.5 seconds until connected is true.

Example

Save the instance_id somewhere durable. It is how you name this number in every send from now on, and it never changes for the life of the instance.

Authorizations

apikey
string
header
required

Your API key, sent in an apikey request header. Never in the URL, never as a Bearer token.

Body

application/json
label
string

Your own name for this number, for example "Sales". Up to 60 characters.

Maximum string length: 60
Example:

"Sales"

Response

Instance created.

success
boolean
data
object
request_id
string<uuid>