Delete a campaign
Delete a DRAFT, COMPLETED or CANCELLED campaign along with its recipient list and per-recipient results. A scheduled, running or paused campaign can't be deleted: cancel it first. Its calls stay in the workspace's call history. This can't be undone.
Authorization
bearerAuth A personal access token from Settings > API tokens.
In: header
Path Parameters
Workspace slug (GET /me lists yours).
Query Parameters
Must be true to perform this action. It deletes something, publishes, or changes what live callers get straight away, so confirm with the user first.
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
curl -X DELETE "https://example.com/workspaces/string/campaigns/string"{
"deleted": "string",
"property1": null,
"property2": null
}{
"type": "http://example.com",
"title": "string",
"status": 0,
"detail": "string",
"code": "string",
"errors": [
{
"path": "string",
"message": "string"
}
],
"estimate": {},
"retryAfterSeconds": 0
}{
"type": "http://example.com",
"title": "string",
"status": 0,
"detail": "string",
"code": "string",
"errors": [
{
"path": "string",
"message": "string"
}
],
"estimate": {},
"retryAfterSeconds": 0
}{
"type": "http://example.com",
"title": "string",
"status": 0,
"detail": "string",
"code": "string",
"errors": [
{
"path": "string",
"message": "string"
}
],
"estimate": {},
"retryAfterSeconds": 0
}{
"type": "http://example.com",
"title": "string",
"status": 0,
"detail": "string",
"code": "string",
"errors": [
{
"path": "string",
"message": "string"
}
],
"estimate": {},
"retryAfterSeconds": 0
}{
"type": "http://example.com",
"title": "string",
"status": 0,
"detail": "string",
"code": "string",
"errors": [
{
"path": "string",
"message": "string"
}
],
"estimate": {},
"retryAfterSeconds": 0
}{
"type": "http://example.com",
"title": "string",
"status": 0,
"detail": "string",
"code": "string",
"errors": [
{
"path": "string",
"message": "string"
}
],
"estimate": {},
"retryAfterSeconds": 0
}{
"type": "http://example.com",
"title": "string",
"status": 0,
"detail": "string",
"code": "string",
"errors": [
{
"path": "string",
"message": "string"
}
],
"estimate": {},
"retryAfterSeconds": 0
}Create a campaign POST
Create a DRAFT outbound campaign and return it. A draft never dials: add recipients with add_campaign_recipients or an audience, then launch_campaign. The touches are a sequence of call and SMS steps: pick a template or pass a whole sequence, and change it later with set_campaign_sequence. voicemail, doubleDial, maxAttempts and retryDelayMinutes change its first call step, and convertedOutcomes which of its outcomes count as a conversion. Caller numbers can also be picked at launch.
Duplicate a campaign POST
Copy a campaign of any status into a new DRAFT named '<name> (copy)', with the same agent, brief, opener, caller number, calling window, voicemail, double dial, limits, dialling rules and converted outcomes, and no scheduled start. recipients picks what else comes across: none (the default, settings only), all (every recipient), or unreached (everyone the campaign didn't speak to, except recipients that were stopped or removed by a do-not-call check). Copied recipients keep their variables, notes, time zone and state, and pass the do-not-call list again. Returns the new campaign and, unless recipients is none, { inserted, skipped, suppressed, invalid }. The copy dials nothing until launch_campaign.