API Documentation

Sendpler is local-first. Contacts and message logs reside on your device. Organizational setups may enable optional server integration.

Base URL

Configure SENDPLER_API_BASE_URL to target your organization server if applicable.

SENDPLER_API_BASE_URL= https://api.sendpler.com

Send Message

POST https://api.sendpler.com/api/send

Headers:


x-api-key        : YOUR_API_KEY_HERE
Content-Type     : application/json
              

Body:


{
  "phones": "09123456789,09998887777",
  "message": "Hello from Sendpler"
}
              

cURL:


# Linux / macOS
curl -X POST "https://api.sendpler.com/api/send" \
  -H "x-api-key: YOUR_API_KEY_HERE" \
  -H "Content-Type: application/json" \
  -d "{"phones":"09123456789,09998887777","message":"Hello from Sendpler"}"
              

JavaScript:


await fetch(`https://api.sendpler.com/api/send`, {
  method: "POST",
  headers: {
    "x-api-key": process.env.SENDPLER_API_KEY,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    phones: "09123456789,09998887777",
    message: "Hello from Sendpler"
  })
});
              
See Privacy Policy for data handling and permissions.