Account and Instances
Create Instance
Creates a new WhatsApp instance. Automatically debits the balance (activation fee + prorated amount). The name must contain only letters, numbers, _ and -.
POST
https://api.zapzapapi.com/api/v1/instancesAuthentication with the x-api-key and x-api-secret headers.
Parameters
| Name | Type | In | Required | Description |
|---|---|---|---|---|
name | text | body | Yes | Instance name |
systemName | text | body | No | System name (displayed on WhatsApp) |
metadata | text | body | No | Free-form data (JSON): link it to your system (e.g. clientId, plan) |
Request example
curl
curl -X POST "https://api.zapzapapi.com/api/v1/instances" \
-H "x-api-key: YOUR_API_KEY" \
-H "x-api-secret: YOUR_API_SECRET" \
-H "Content-Type: application/json" \
-d '{"name":"minha-instancia"}'Node.js
const res = await fetch("https://api.zapzapapi.com/api/v1/instances", {
method: "POST",
headers: {
"x-api-key": "YOUR_API_KEY",
"x-api-secret": "YOUR_API_SECRET",
"Content-Type": "application/json",
},
body: JSON.stringify({
"name": "minha-instancia"
}),
});
console.log(await res.json());Python
import requests
res = requests.post(
"https://api.zapzapapi.com/api/v1/instances",
headers={"x-api-key": "YOUR_API_KEY", "x-api-secret": "YOUR_API_SECRET"},
json={"name":"minha-instancia"},
)
print(res.json())Response example
JSON
{
"instance": {
"id": "uuid",
"name": "minha-instancia",
"status": "PENDING"
},
"billing": {
"charged": 10.5
}
}Values are illustrative; the fields follow the real response format.
Other endpoints in this category
Get your API keys
Create your account, connect a number in minutes and start using the API. R$15 per active number/month, with a welcome credit when you create the account, subject to the current campaign.