Waplix
Docs

Create Instance

Supported & Tested

Create a new WhatsApp instance linked to the authenticated user account.

POSThttps://api.waplix.io/api/v1/instances/create
Authentication
Authorization: Bearer YOUR_API_KEY
Parameters Specification
name
stringReq

Display name for the new instance slot

webhook_url
stringOpt

Optional target webhook callback URL

Usage Notes
Instance ID is generated automatically. Sending instance_id inside request payload triggers VALIDATION_ERROR.
Request Payload Example
Request 
curl -X POST "https://api.waplix.io/api/v1/instances/create" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Demo Instance",
  "webhook_url": "https://example.com/webhook"
}'
Success Response
Response · 200 OK
{
  "success": true,
  "message": "Instance created",
  "data": {
    "instance_id": "demo_instance",
    "name": "Demo Instance",
    "status": "created",
    "qr_url": "https://api.waplix.io/api/v1/client/qr?instance_id=demo_instance",
    "status_url": "https://api.waplix.io/api/v1/instances/status?instance_id=demo_instance"
  },
  "error": null
}
Previous List InstancesNext Instance Status
Was this page helpful?