Cancel a Campaign

PUT

campaigns

{campaignId}

cancel

curl --request PUT \
  --url https://my.cald.ai/client/api/v1/campaigns/{campaignId}/cancel \
  --header 'Authorization: <api-key>'

{
  "status": "<string>"
}

This will cancel a campaign and cancel all scheduled calls, however, it will not cancel any calls that are currently in progress.

Authorization

string

header

required

Your API key, e.g. caldLiveDe39a3accb206dd615f30d118e519df0

campaignId

string

required

The campaign ID of the campaign

200

application/json

Success response with campaign details

status

string

Whether the campaign was successfully cancelled, can be either success or failed

curl --request PUT \
  --url https://my.cald.ai/client/api/v1/campaigns/{campaignId}/cancel \
  --header 'Authorization: <api-key>'

{
  "status": "<string>"
}