Create a number slot
Instances
Create a number slot
POST /v1/instances — create an instance to connect a new WhatsApp number to.
POST
Create a number slot
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.
Notes
labelis optional, up to 60 characters. It is for your own reference only; nothing about sending depends on it.- The response may include a
qrcodestraight away. Ifqrcodeisnull, fetch one fromGET /v1/instances/{id}/qr. - Creating an instance counts against your account’s number allowance. Over it, you get
403 instance_limit_reachedwithdetails.instance_limit. - This is the only instance endpoint that requires an active plan.
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
cURL
Authorizations
Your API key, sent in an apikey request header. Never in the URL, never as a Bearer token.
Body
application/json
Your own name for this number, for example "Sales". Up to 60 characters.
Maximum string length:
60Example:
"Sales"

