Skip to main content
GET
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.
Checks the connection live and updates our stored record to match.

Notes

  • Use this before a batch run, or right after a send returned 409 instance_not_connected, to confirm whether the number is really down.
  • It costs one upstream check, so it is slower than GET /v1/instances. Do not call it in a tight loop for every message — check once before the batch.
  • phone_number is learned the first time we see the number connected, so it may be null on a number that has never paired.
  • If it turns out the same WhatsApp number is already connected on another of your instances, this returns 409 number_already_connected — the session that was already up keeps working.
Status values

Example

Node.js — check before a batch
If the messaging service cannot be reached, this returns 502 upstream_unavailable rather than guessing. That means “we do not know”, not “your number is down”.

Authorizations

apikey
string
header
required

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

Path Parameters

id
string<uuid>
required

The instance_id of one of your numbers.

Response

Live status.

success
boolean
data
object
request_id
string<uuid>