Skip to main content

Marejeleo ya API v2

Toleo la sasa la API lenye utendakazi ulioboreshwa, ushughulikiaji bora wa makosa na vipengele vipya.

Current Version

Quick Start

1. Get Your API Key

Generate an API key in Settings → API Keys. Keep it secure and never share it.

2. Make Your First Request

curl -X GET https://api.beecastly.com/v2/contacts \
  -H "Authorization: Bearer YOUR_API_KEY"

3. Read the Docs

Explore the endpoint reference below to learn what you can build.

API Endpoints

Messages

POST
/v2/messages/send

Send a message via WhatsApp, SMS, or Email

GET
/v2/messages/:id

Get message details and delivery status

GET
/v2/messages

List messages with filtering and pagination

Contacts

POST
/v2/contacts

Create a new contact

GET
/v2/contacts/:id

Get contact details

GET
/v2/contacts

List all contacts with search and filters

PUT
/v2/contacts/:id

Update contact information

DELETE
/v2/contacts/:id

Delete a contact

Campaigns

POST
/v2/campaigns

Create a new campaign

GET
/v2/campaigns/:id

Get campaign details and stats

POST
/v2/campaigns/:id/send

Send campaign to audience

PUT
/v2/campaigns/:id

Update campaign settings

Webhooks

POST
/v2/webhooks

Register a webhook endpoint

GET
/v2/webhooks

List registered webhooks

DELETE
/v2/webhooks/:id

Delete a webhook

Authentication

All API requests require Bearer token authentication. Include your API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

Rate Limiting

• Free Plan: 100 requests/hour

• Pro Plan: 1,000 requests/hour

• Agency Plan: 10,000 requests/hour

• Enterprise: Custom limits

Related Resources