API Reference
Reference documentation for Bulkit endpoints, request schemas, responses, and error behavior.
Last updated · Markdown version
The API reference documents Bulkit’s production endpoints in an implementation-focused format.
Use this section when you need:
- endpoint URLs and methods
- request payloads
- response examples
- validation rules
- common error messages
Endpoint groups
Account
SMS
- How to Send SMS
- Send SMS Using Header Authorization
- Send SMS Using URL Params
- Send a Single SMS
- Send Customized SMS
- How to Setup SMS Webhook
- Shortcode Inbox SMS Webhook
- Keyword Inbox SMS Webhook
- How to Get Delivery Reports
- SMS API Error Messages
Contacts
- WhatsApp API Overview
- Send WhatsApp Message
- Send Media & Attachments
- Send Bulk WhatsApp Broadcast
- Inbox & Message History
- Connection Status
Webhooks
Conventions
Bulkit API follows these conventions:
- JSON request and response bodies for
POSTendpoints - API key authentication for all endpoints
- stable validation messages for common errors
- timezone-aware scheduling where scheduling is supported
Common response format
Successful responses typically look like this:
JSON
{
"status": "success",
"message": "Request processed successfully",
"data": {}
}Error responses typically look like this:
JSON
{
"status": "error",
"message": "Invalid credentials"
}