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.
Stops the campaign and cancels calls waiting to be placed. A call in progress finishes. Stopping a stopped campaign is allowed and changes nothing.
X-API-Key<token>Create in the console: Settings → API & webhooks.
campaign_id*stringCampaign ID.
uuidOK
application/json- response
The campaign is stopped.
campaign?|The campaign.
cancelledJobs?|Scheduled dial rounds that were cancelled.
message?|Human-readable confirmation.
success?|Always true.
[key: string]?anycurl -X POST 'https://api.callmitra.ai/api/v1/campaigns/497f6eca-6276-4993-bfeb-53cbbbba6f08/stop'{ "campaign": { "id": "3f6c1b2a-7d4e-4a1b-9c2d-5e6f7a8b9c0d", "isActive": false }, "cancelledJobs": 1, "message": "Campaign stopped", "success": true}Start a campaign POST
Starts dialing. Calls are placed only inside the dial window and up to the daily limit. The campaign must have an agent whose prompt the leads can fill and a number that can place calls; otherwise nothing changes and the error says what to fix.
Update a campaign PUT
Send only the fields to change. `settings` is merged into the current settings. Changing dialing rules on a running campaign re-plans its next dial round.