Campaigns
Cancel campaign
Permanently terminate an in-flight, paused, or scheduled outbound campaign
POST
Permanently cancel a campaign that is currently
scheduled, sending, or paused. If scheduled in TaskIQ, its background schedule is un-registered from Redis. In-flight messages that have already been sent to WhatsApp will complete, but no further recipients in the queue will be processed.
Authentication
This endpoint requires Bearer token authentication.Input parameters
string
required
Unique UUID identifier of the campaign to cancel. Example:
e4a2e584-3672-4d69-b541-6e9f1a238491.string
required
Bearer token for authentication. Format:
Bearer <token>.Response Fields
Returns the updated CampaignResponse object with status changed tocancelled.
string
UUID of the cancelled campaign.
string
Operational status:
cancelled.number
Total contacts originally queued.
number
Messages dispatched prior to cancellation.
number
Count of failed deliveries.
‹ PreviousNext ›
Delete campaign
