POST

Create Campaign

Configures a new broadcast queue with rate limits, jitter, and target contact tags.

HTTP Endpoint

POSThttps://api-wa.hidessh.com/api/v1/campaigns

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
`name`	string	Required	Campaign display name. example: Weekend Flash Sale 50%
`message_template`	string	Required	Message template with variables like {{name}} and Spintax. example: {Hi\|Hello} {{name}}, our flash sale is live!
`tag_ids`	array	Required	List of contact tag IDs to target for broadcast. example: ["01M1TAG01"]
`min_delay_seconds`	integer	Optional	Minimum jitter delay between outbound dispatches (anti-ban). default: 5
`max_delay_seconds`	integer	Optional	Maximum jitter delay between dispatches. default: 15

Code Examples

request.sh

curl -X POST "https://api-wa.hidessh.com/api/v1/campaigns" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Weekend Flash Sale",
    "message_template": "Hello {{name}}, sale is active!",
    "tag_ids": ["01M1TAG01"],
    "min_delay_seconds": 5,
    "max_delay_seconds": 15
  }'

Response Formats

Campaign created in DRAFT state.

application/json • 201 Created

{
  "success": true,
  "message": "campaign created successfully",
  "payload": {
    "id": "01M1CP002",
    "name": "Weekend Flash Sale",
    "status": "DRAFT"
  }
}

On this page