curl --request POST \
--url https://app.hypersender.com/api/whatsapp/v2/create-instance \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"phone": "+201234567890",
"name": "MyInstanceName",
"webhook_url": "https://yourdomain.com/webhooks/whatsapp"
}
'import requests
url = "https://app.hypersender.com/api/whatsapp/v2/create-instance"
payload = {
"phone": "+201234567890",
"name": "MyInstanceName",
"webhook_url": "https://yourdomain.com/webhooks/whatsapp"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
phone: '+201234567890',
name: 'MyInstanceName',
webhook_url: 'https://yourdomain.com/webhooks/whatsapp'
})
};
fetch('https://app.hypersender.com/api/whatsapp/v2/create-instance', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.hypersender.com/api/whatsapp/v2/create-instance",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'phone' => '+201234567890',
'name' => 'MyInstanceName',
'webhook_url' => 'https://yourdomain.com/webhooks/whatsapp'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.hypersender.com/api/whatsapp/v2/create-instance"
payload := strings.NewReader("{\n \"phone\": \"+201234567890\",\n \"name\": \"MyInstanceName\",\n \"webhook_url\": \"https://yourdomain.com/webhooks/whatsapp\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://app.hypersender.com/api/whatsapp/v2/create-instance")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"phone\": \"+201234567890\",\n \"name\": \"MyInstanceName\",\n \"webhook_url\": \"https://yourdomain.com/webhooks/whatsapp\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.hypersender.com/api/whatsapp/v2/create-instance")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"phone\": \"+201234567890\",\n \"name\": \"MyInstanceName\",\n \"webhook_url\": \"https://yourdomain.com/webhooks/whatsapp\"\n}"
response = http.request(request)
puts response.read_body{
"id": "c9a1dd76-5678-4f9d-9012-a5b78de100c3",
"name": "MyInstanceName",
"phone": "+201234567890",
"service_type": "whatsapp",
"status": "SCAN_QR_CODE",
"qr_code": "iVBORw0KGgoAAAANSUhEUgAAA...",
"access_token": "234|3uB2pBST2H6If8twXIeUaeNu23VJ8XassYoOVJuva48388e1",
"created_at": "2025-05-26T10:12:45"
}{
"message": "The given data was invalid.",
"errors": {
"phone": [
"The phone field is required."
],
"name": [
"The name field is required."
]
},
"statusCode": 422
}{
"message": "Too many requests. Please try again later."
}Create Instance
Create a new WhatsApp instance with a phone number, name, and optional webhook URL for receiving events.
curl --request POST \
--url https://app.hypersender.com/api/whatsapp/v2/create-instance \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"phone": "+201234567890",
"name": "MyInstanceName",
"webhook_url": "https://yourdomain.com/webhooks/whatsapp"
}
'import requests
url = "https://app.hypersender.com/api/whatsapp/v2/create-instance"
payload = {
"phone": "+201234567890",
"name": "MyInstanceName",
"webhook_url": "https://yourdomain.com/webhooks/whatsapp"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
phone: '+201234567890',
name: 'MyInstanceName',
webhook_url: 'https://yourdomain.com/webhooks/whatsapp'
})
};
fetch('https://app.hypersender.com/api/whatsapp/v2/create-instance', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.hypersender.com/api/whatsapp/v2/create-instance",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'phone' => '+201234567890',
'name' => 'MyInstanceName',
'webhook_url' => 'https://yourdomain.com/webhooks/whatsapp'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.hypersender.com/api/whatsapp/v2/create-instance"
payload := strings.NewReader("{\n \"phone\": \"+201234567890\",\n \"name\": \"MyInstanceName\",\n \"webhook_url\": \"https://yourdomain.com/webhooks/whatsapp\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://app.hypersender.com/api/whatsapp/v2/create-instance")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"phone\": \"+201234567890\",\n \"name\": \"MyInstanceName\",\n \"webhook_url\": \"https://yourdomain.com/webhooks/whatsapp\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.hypersender.com/api/whatsapp/v2/create-instance")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"phone\": \"+201234567890\",\n \"name\": \"MyInstanceName\",\n \"webhook_url\": \"https://yourdomain.com/webhooks/whatsapp\"\n}"
response = http.request(request)
puts response.read_body{
"id": "c9a1dd76-5678-4f9d-9012-a5b78de100c3",
"name": "MyInstanceName",
"phone": "+201234567890",
"service_type": "whatsapp",
"status": "SCAN_QR_CODE",
"qr_code": "iVBORw0KGgoAAAANSUhEUgAAA...",
"access_token": "234|3uB2pBST2H6If8twXIeUaeNu23VJ8XassYoOVJuva48388e1",
"created_at": "2025-05-26T10:12:45"
}{
"message": "The given data was invalid.",
"errors": {
"phone": [
"The phone field is required."
],
"name": [
"The name field is required."
]
},
"statusCode": 422
}{
"message": "Too many requests. Please try again later."
}Rate Limit
This endpoint is limited to 5 requests per minute to prevent abuse.Request Body
phone(required) - Phone number in E.164 format (e.g., +201234567890)name(required) - Instance name (max 50 characters, must be unique per user per service)webhook_url(optional) - HTTPS webhook URL to receive WhatsApp events
Response
Upon successful creation, you’ll receive:- Instance details (id, name, phone, service_type, status)
qr_code- Base64-encoded PNG QR code for WhatsApp authenticationaccess_token- Bearer token for authenticating API requestscreated_at- Creation timestamp
QR Code Display
The QR code is returned as a base64-encoded PNG without the data URI prefix. To display it in HTML:<img src="data:image/png;base64,{qr_code}" alt="WhatsApp QR Code" />
Next Steps
After creating the instance:- Display the QR code to the user
- Open WhatsApp on the mobile device
- Go to Settings > Linked Devices
- Scan the QR code
- Wait for the instance status to change to
WORKING
Validation Errors
Common validation errors (422 status):- Missing
phoneornamefield - Invalid phone number format
- Instance name already exists
- Invalid webhook URL (must be HTTPS)
- Name exceeds 50 characters
Authorizations
Bearer token authentication. Example: Bearer 234|3uB2pBST2H6If8twXIeUaeNu23VJ8XassYoOVJuva48388e1
Headers
application/json
"application/json"
application/json
"application/json"
Body
E.164 format phone number (e.g. +201234567890)
"+201234567890"
Instance name (max 50 characters, must be unique per user per service)
50"MyInstanceName"
Optional webhook URL (must be a valid https URL)
"https://yourdomain.com/webhooks/whatsapp"
Response
Instance created successfully
Instance UUID
"fa3d01c4-1234-4c0d-a12f-df319b612f8c"
Instance name
"MyInstanceName"
Phone number in E.164 format
"+201234567890"
Service type
"whatsapp"
Instance status
STOPPED, STARTING, WORKING, SCAN_QR_CODE, FAILED, PENDING "WORKING"
Access token for the instance
"234|3uB2pBST2H6If8twXIeUaeNu23VJ8XassYoOVJuva48388e1"
Creation timestamp
"2025-05-26T10:12:45"
Base64-encoded PNG QR code (without data:image/png;base64, prefix). You must prepend it manually when displaying: [Image blocked: No description]
"iVBORw0KGgoAAAANSUhEUgAAA..."