POST
Start Campaign
Triggers the Redis Streams background worker to begin dispatching queued messages.
HTTP Endpoint
POSThttps://api-wa.hidessh.com/api/v1/campaigns/{campaignId}/start
Authentication
This endpoint requires Bearer authentication via your secret API Key.
| Header Key | Value | Required |
|---|---|---|
| Authorization | Bearer <your_api_key> | Required |
| Content-Type | application/json | Required |
Request Parameters
The request body must be formatted as JSON with the following parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
campaignId | string | Required | ULID of campaign to launch. example: 01M1CP002 |
Code Examples
request.sh
curl -X POST "https://api-wa.hidessh.com/api/v1/campaigns/01M1CP002/start" \
-H "Authorization: Bearer YOUR_API_KEY"Response Formats
Campaign started.
application/json • 200 OK
On this page