Partner API

These endpoints are exclusive for partner accounts. Partners have post-paid subscriptions and can create and manage instances programmatically.

Partner Access Required

All endpoints in this section require your account to have partner status. If you're interested in becoming a partner, please contact our sales team.

Create Instance

Creates a new WhatsApp instance. This endpoint is only available for partners with post-paid subscriptions.

POST /api/instances

Request Body

{
  "name": "My New Instance"
}

Field	Type	Required	Description
name	string	Yes	Name for the new instance (3-100 characters)

Response

{
  "instanceId": "550e8400-e29b-41d4-a716-446655440000",
  "name": "My New Instance",
  "status": "created"
}

Field	Type	Description
instanceId	string	Unique identifier for the created instance (UUID)
name	string	Name of the instance
status	string	Initial status of the instance (created)

Error Responses

Status Code	Description
400	Bad request - Invalid input data
401	Unauthorized - Invalid or missing API key
403	Forbidden - Partner access required

Example

curl -X POST "https://api.zapyapi.com/api/instances" \
  -H "x-api-key: YOUR_PARTNER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "My New Instance"
  }'

Next Steps

After creating an instance, you'll need to:

1. Get the QR Code - Call GET /api/instances/{instanceId}/qr to get the QR code
2. Scan the QR Code - Scan the QR code with your WhatsApp mobile app
3. Configure Webhooks - Set up webhooks to receive events from your instance

See the Instances API for more details on these endpoints.

---

Partner vs Regular Users

Feature	Regular Users	Partners
Create instances	Via dashboard only	Via API
Billing	Pre-paid (pay before use)	Post-paid (pay after use)
Instance limits	Based on subscription	Custom limits
API access	Standard endpoints	Standard + Partner endpoints

---

Becoming a Partner

If you're interested in becoming a partner, you'll get access to:

• Programmatic instance creation - Create instances via API
• Post-paid billing - Pay at the end of the billing cycle
• Custom limits - Higher instance limits based on your needs
• Priority support - Dedicated support channel

Contact our sales team for more information.