Sign in

v2

latestOpenAPI 3.1.02026-07-273779120.8 KB
Campaigns

Campaign Action

Perform a lifecycle action on a campaign.

  • launch: Start processing calls. Campaign must be in 'pending' or 'paused' state.
  • pause: Suspend call processing. Campaign must be in 'processing' state.
  • resume: Resume a paused campaign.
  • abort: Cancel all pending/queued/ready calls and mark them as failed.
post/campaigns/v1/campaigns/{campaign_id}/action

Path parameters

campaign_idstring required
Example:5eb7cf5a86d9755df3a6c593

Campaign configuration ID

Request body

action'pause' | 'launch' | 'abort' | 'resume' required

Enum representing the actions that can be requested for a campaign. This enum is used to control the lifecycle of campaigns.

Response

Successful Response

messagestring required

Human-readable result message

Example response

{
  "message": "Operation completed successfully."
}