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

Contacts

WhatsApp

Webhooks

Conventions

Bulkit API follows these conventions:

  • JSON request and response bodies for POST endpoints
  • 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"
}