Stop a campaign
POST/api/v1/campaigns/:id/stop
Cancels the campaign for good. Contacts not yet called move to cancelled; calls already under way run to their end.
This is irreversible: a cancelled campaign cannot be restarted, you have to create a new one.
Required capability: CAMPAIGNS
Request
Responses
- 201
- 400
- 401
- 403
- 404
- 429
Done.
The campaign is not in a state that allows this action.
Missing or invalid API key.
A capability required by this endpoint is not enabled on your account. Ask your account manager to switch it on.
Not found, or not owned by your account.
Too many requests. Back off and retry.