Skip to main content
POST
Force complete campaign
Use this endpoint to force complete a running campaign immediately, halting all pending audience calls.

Endpoint

POST /campaign-force-completed Content-Type: application/json Authentication: Required (workspace auth)

Request Body

Campaign Status Values

Response

Behavior

  • Maps the string campaign_status to its internal numeric code before processing.
  • When set to force_completed: all audience records with status fresh or inqueue are immediately set to halted.
  • This action is irreversible — the campaign cannot be resumed after force completion.

Example cURL

Headers

token
string
required

API token for authentication

Body

application/json
campaign_id
integer
required

ID of the campaign to force complete

campaign_status
enum<string>
required

Must be force_completed to mark as Force Completed

Available options:
force_completed

Response

Campaign force completed successfully

message
string