Skip to main content
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.
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.
  • 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
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>