Welcome to the SendZen API reference. This page provides an overview of our API's core concepts and structure, orienting you before you dive into individual endpoints.
Base URL#
All production API requests should be directed to:For security, SendZen's production API strictly uses HTTPS.
Authentication#
All requests to the SendZen API must be authenticated.Header: Authorization: Bearer YOUR_API_KEY
Accelerate your integration with SendZen's official SDKs and developer tools:Quick Start: Use cURL for direct API calls, or our SDKs for Node.js and Python to get started even faster.
Code Examples: All examples throughout this reference are provided for cURL, Node.js, and Python, making them reproducible out of the box.
Real-time Logs: View detailed request and response logs in your SendZen dashboard for efficient debugging and monitoring.
Core Resources#
Below are the primary resource categories you will find in the navigation, each with dedicated endpoints and functionalities:Messages#
Send various message types, including plain text, rich media, structured templates, utility notifications, and authentication OTPs. Receive delivery and read receipts via your configured webhook.Endpoints: POST /v1/messages and related resources for managing message status and history.
Supported Formats: JPEG, PNG
Supported Formats: .3gp, .mp4
Supported Formats: .txt, .xls, .xlsx, .doc, .docx, .ppt, .pptx, .pdf
Supported Formats: .aac, .amr, .mp3, .ogg, .m4a
Templates#
Create and manage your WhatsApp message templates programmatically via the API. This includes submitting, retrieving, and updating templates.Webhooks#
Subscribe to critical events such as message.sent, message.delivered, message.read, and inbound messages. Our webhook system supports automatic retries for transient issues, ensuring reliable event delivery.Voice#
Utilize WhatsApp Voice capabilities through our API. This includes initiating and managing voice calls. (Elaborate further if there are specific voice endpoints or features, e.g., "Endpoints: POST /v1/voice/calls")Accounts & Onboarding#
Integrate and manage your WhatsApp Business Accounts. SendZen supports WhatsApp Business App numbers, and Embedded Signup is available for streamlined onboarding and account management.
All API requests and responses utilize the application/json content type. Ensure your request bodies are valid JSON.
Webhooks#
Configure a webhook endpoint in your SendZen dashboard to receive asynchronous event notifications for message lifecycle and inbound messages.Response Requirement: Your endpoint should respond with a 2xx HTTP status code promptly (within X seconds, e.g., 3 seconds) to acknowledge receipt of the event.
Retries: SendZen automatically retries webhook deliveries with an exponential backoff strategy if your endpoint times out or returns a 5xx status code.
Test Mode: Simulate webhook events without impacting real users, facilitating safe testing and development of your webhook handlers.
Signature Verification: Always verify webhook signatures to confirm the authenticity and integrity of incoming events from SendZen and protect against spoofing.
Errors#
The SendZen API provides clear, structured error responses for easy debugging.Client Errors: 4xx HTTP status codes indicate issues with your request (e.g., invalid parameters, missing authentication, rate limits exceeded).
Server Errors: 5xx HTTP status codes indicate an issue on the SendZen server.
Error Structure: Responses include a human-readable message and a stable code for programmatic handling. Additional details for specific fields might also be included.
{
"error": {
"code": "invalid_parameter",
"message": "The 'to' number format is invalid.",
"details": { "field": "to" }
}
}
X-Request-ID header value found in the response to help us quickly locate and troubleshoot your request.
Support#
SendZen offers comprehensive support to ensure your success and smooth operation:Community & Email Support: Available for general integration questions, best practices, and non-urgent inquiries.
Priority Support: Paying customers receive expedited assistance and dedicated live chat support for critical issues.
Enterprise Onboarding: Dedicated support and tailored onboarding programs for larger deployments and complex integrations.
Modified at 2025-10-07 06:33:11
