POST

Pause Campaign

Halts dispatching temporarily without losing queue index.

HTTP Endpoint

POSThttps://api-wa.hidessh.com/api/v1/campaigns/{campaignId}/pause

Authentication

This endpoint requires Bearer authentication via your secret API Key.
Header KeyValueRequired
AuthorizationBearer <your_api_key>Required
Content-Typeapplication/jsonRequired

Request Parameters

The request body must be formatted as JSON with the following parameters:

ParameterTypeRequiredDescription
campaignId
stringRequired

ULID of campaign to pause.

example: 01M1CP002

Code Examples

request.sh
curl -X POST "https://api-wa.hidessh.com/api/v1/campaigns/01M1CP002/pause" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response Formats

Campaign paused.

application/json • 200 OK
{ "success": true, "message": "campaign paused" }