API Reference · Campaigns

Delete a campaign

Permanently deletes a campaign and its contact list. A running campaign must be paused first.

DELETE/campaigns/{campaign_id}

https://calling.ubiqproject.com/api/v1/campaigns/{campaign_id} · Auth: API key (full access)

Request

Path parameters

campaign_idstring (UUID)required

The campaign's ID.

Request

curl -X DELETE https://calling.ubiqproject.com/api/v1/campaigns/9b4e6f12-8a3c-4d71-b05e-2f6a8c1d7e93 \
  -H "Authorization: Bearer vk_live_YOUR_KEY"

204 No Content, with an empty body.

Responses

Pause the campaign before deleting it409

The campaign is running. Pause it, then delete.

Campaign not found404

No campaign with this ID in your company.

Invalid id400

campaign_id isn't a UUID.

This can't be undone

The contact list and each contact's results go with it. Export the results first if you need them.