Skip to main content

StopCampaign ends a campaign.

POST 

/api/v1/voice/campaigns/:id/stop

Permanently stops the campaign. Cannot be resumed.

Parameters

  • id: Required, campaign to stop

Side Effects

  • Sets status to stopped
  • Records stopped_at timestamp
  • Terminates dialing engine

Errors

  • NOT_FOUND: Campaign does not exist
  • FAILED_PRECONDITION: Campaign already stopped
  • PERMISSION_DENIED: Caller lacks voice:campaign:control permission

Request

Responses

A successful response.