Skip to Content
CallMitraDocs
API referenceCampaigns

Stop a campaign

Stops the campaign and cancels calls waiting to be placed. A call in progress finishes. Stopping a stopped campaign is allowed and changes nothing.

POST
/api/v1/campaigns/{campaign_id}/stop

Stops the campaign and cancels calls waiting to be placed. A call in progress finishes. Stopping a stopped campaign is allowed and changes nothing.

Authorization

headerX-API-Key<token>

Create in the console: Settings → API & webhooks.

Path Parameters

campaign_id*string

Campaign ID.

Formatuuid

Response Body

OK

application/json
  1. response

The campaign is stopped.

campaign?|

The campaign.

cancelledJobs?|

Scheduled dial rounds that were cancelled.

message?|

Human-readable confirmation.

success?|

Always true.

[key: string]?any
Example Request
curl -X POST 'https://api.callmitra.ai/api/v1/campaigns/497f6eca-6276-4993-bfeb-53cbbbba6f08/stop'
Example Response
{  "campaign": {    "id": "3f6c1b2a-7d4e-4a1b-9c2d-5e6f7a8b9c0d",    "isActive": false  },  "cancelledJobs": 1,  "message": "Campaign stopped",  "success": true}