Delete campaign | Atlas | Documentation

curl -X DELETE https://api.youratlas.com/v1/api/campaign/id \
     -H "api-key: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{}'

{
  "PartitionKey": "campaigns",
  "RowKey": "c1234567-89ab-cdef-0123-456789abcdef",
  "Timestamp": "2024-01-15T09:30:00Z",
  "odata.etag": "W/\"datetime'2024-01-15T09%3A30%3A00.0000000Z'\"",
  "name": "Spring Sale Campaign",
  "campaignType": "voice",
  "Mode": true,
  "BusinessName": "GreenTech Solutions",
  "CallType": "outbound",
  "CompanyName": "GreenTech Solutions Inc.",
  "FirstMessage": "Hello, this is a reminder about our spring sale!",
  "IsActive": true,
  "PhoneNumberId": "pn-9876543210",
  "Position": "Manager",
  "ScriptBase": "Welcome script for spring campaign",
  "ScriptNotes": "Use friendly tone, mention discounts",
  "StartDate": "2024-01-15T09:30:00Z",
  "TimeWindows": "09:00-17:00",
  "SuccessRequest": 150,
  "TemplateId": "tmpl-2024spring",
  "TotalRequest": 200,
  "TotalTransfers": 25,
  "DailyCallLimit": 50,
  "KnowledgeBaseId": "kb-2024-spring",
  "KnowledgeBaseDataSetId": "dataset-001",
  "FeatureAppendPreviousSummaryEnabled": true,
  "PhoneNumberProvider": "Twilio",
  "FeatureRescheduleCallEnabled": true,
  "EnrichmentInfoSettings": "{\"includeCallerInfo\":true}",
  "EnrichmentInfoProvider": "Clearbit",
  "FeatureEnrichmentInfoEnabled": true,
  "EndCallMessage": "Thank you for your time, have a great day!",
  "VoicemailMessage": "Please call us back at your convenience.",
  "AnalysisPlanSummaryPrompt": "Summarize call outcomes for analysis",
  "FeatureEndCallWhenVoicemail": true,
  "FeatureRedialOnNoResponse": true,
  "RedialSettings": "{\"maxAttempts\":3,\"intervalMinutes\":15}",
  "FeatureDoubleCall": true,
  "Timezone": "America/New_York",
  "TimezoneFriendlyName": "Eastern Standard Time",
  "Status": "archived",
  "Collection": "spring_campaigns",
  "IdleMessages": "No calls currently active",
  "ToolIds": "tool-voice-001,tool-analytics-002",
  "SMSTrigger": "onMissedCall",
  "SMSBody": "Sorry we missed you, please call back!",
  "ForwardingPhoneNumber": "+12345678901",
  "PreScript": "Verify customer identity",
  "PostScript": "Log call details",
  "FirstMessageMode": "assistant-speaks-first",
  "ChatPhoneNumberId": "chatpn-1234567890",
  "IsOutboundChatActive": true
}

Authentication

api-keystring

Your Atlas API key. Get it from the Atlas Portal under Settings > API Keys.

Path parameters

idstringRequired

The campaign ID

Response

Campaign deleted

PartitionKeystring

RowKeystring

Timestampdatetime

odata.etagstring

namestring

campaignTypestring

Modeboolean

BusinessNamestring

CallTypestring

CompanyNamestring

FirstMessagestring

IsActiveboolean

PhoneNumberIdstring

Positionstring

ScriptBasestring

ScriptNotesstring

StartDatedatetime

TimeWindowsstring

SuccessRequestinteger

TemplateIdstring

TotalRequestinteger

TotalTransfersinteger

DailyCallLimitinteger

KnowledgeBaseIdstring

KnowledgeBaseDataSetIdstring

Knowledge base dataset identifier

FeatureAppendPreviousSummaryEnabledboolean

PhoneNumberProviderstring

FeatureRescheduleCallEnabledboolean

EnrichmentInfoSettingsstring

EnrichmentInfoProviderstring

FeatureEnrichmentInfoEnabledboolean

EndCallMessagestring

VoicemailMessagestring

AnalysisPlanSummaryPromptstring

FeatureEndCallWhenVoicemailboolean

FeatureRedialOnNoResponseboolean

RedialSettingsstring

JSON string of redial attempt configuration

FeatureDoubleCallboolean

Timezonestring

TimezoneFriendlyNamestring

Statusenum

Allowed values:

Collectionstring

IdleMessagesstring

ToolIdsstring

SMSTriggerstring

SMSBodystring

ForwardingPhoneNumberstring

PreScriptstring

PostScriptstring

FirstMessageModeenum

Allowed values:

ChatPhoneNumberIdstring

IsOutboundChatActiveboolean

Errors

404

Not Found Error

500

Internal Server Error