Create campaign | Atlas | Documentation

curl -X POST https://api.youratlas.com/v1/api/campaign \
     -H "api-key: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "campaignType": "outbound",
  "name": "Spring Sales Campaign"
}'

{
  "PartitionKey": "campaigns",
  "RowKey": "c1234567-89ab-4def-0123-456789abcdef",
  "Timestamp": "2024-01-15T09:30:00Z",
  "odata.etag": "W/\"datetime'2024-01-15T09%3A30%3A00.0000000Z'\"",
  "name": "Spring Sales Campaign",
  "campaignType": "outbound",
  "Mode": true,
  "BusinessName": "Acme Corp",
  "CallType": "cold-call",
  "CompanyName": "Acme Corporation",
  "FirstMessage": "Hello, this is an important update from Acme Corp.",
  "IsActive": true,
  "PhoneNumberId": "phone-9876543210",
  "Position": "Sales Representative",
  "ScriptBase": "Welcome to our Spring Sales Campaign. How can I assist you today?",
  "ScriptNotes": "Focus on new product features and discounts.",
  "StartDate": "2024-01-15T09:30:00Z",
  "TimeWindows": "[{\"start\":\"09:00\",\"end\":\"17:00\",\"days\":[\"Mon\",\"Tue\",\"Wed\",\"Thu\",\"Fri\"]}]",
  "SuccessRequest": 150,
  "TemplateId": "template-abc123",
  "TotalRequest": 200,
  "TotalTransfers": 25,
  "DailyCallLimit": 50,
  "KnowledgeBaseId": "kb-2024-spring",
  "KnowledgeBaseDataSetId": "dataset-001",
  "FeatureAppendPreviousSummaryEnabled": true,
  "PhoneNumberProvider": "Twilio",
  "FeatureRescheduleCallEnabled": true,
  "EnrichmentInfoSettings": "{\"fields\":[\"customerName\",\"lastPurchaseDate\"]}",
  "EnrichmentInfoProvider": "hubspot",
  "FeatureEnrichmentInfoEnabled": true,
  "EndCallMessage": "Thank you for your time. Have a great day!",
  "VoicemailMessage": "Hi, this is Acme Corp calling about our Spring Sales. Please call us back.",
  "AnalysisPlanSummaryPrompt": "Summarize the customer's interest and next steps.",
  "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": "[\"Are you still there?\",\"Please let me know if you have any questions.\"]",
  "ToolIds": "tool-123,tool-456",
  "SMSTrigger": "onMissedCall",
  "SMSBody": "Sorry we missed you! Reply to schedule a call.",
  "ForwardingPhoneNumber": "+12345678901",
  "PreScript": "Introduce yourself and the campaign purpose.",
  "PostScript": "Confirm next steps and thank the customer.",
  "FirstMessageMode": "assistant-speaks-first",
  "ChatPhoneNumberId": "chat-5551234",
  "IsOutboundChatActive": true
}

Authentication

api-keystring

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

Request

This endpoint expects an object.

campaignTypeenumRequired

Allowed values:

namestringRequired

CallTypestringOptional

TemplateIdstringOptional

CompanyNamestringOptional

Injected as {{companyName}} in the script

PositionstringOptional

IsActivebooleanOptional

ModebooleanOptional

BusinessNamestringOptional

StartDatedatetimeOptional

TimeWindowsstringOptional

JSON string of time windows

FirstMessagestringOptional

Greeting the agent speaks at the start of every call

PreScriptstringOptional

PostScriptstringOptional

ScriptBasestringOptional

The agent's conversation script

ScriptNotesstringOptional

FeatureRescheduleCallEnabledbooleanOptional

FeatureEnrichmentInfoEnabledbooleanOptional

FeatureAppendPreviousSummaryEnabledbooleanOptional

EnrichmentInfoProviderenumOptional

Allowed values:

EnrichmentInfoSettingsstringOptional

JSON string of enrichment settings

TimezonestringOptional

TimezoneFriendlyNamestringOptional

StatusenumOptional

Allowed values:

CollectionstringOptional

ToolIdsstringOptional

Comma-separated tool IDs

SMSTriggerstringOptional

SMSBodystringOptional

FirstMessageModeenumOptional

Allowed values:

EndCallMessagestringOptional

VoicemailMessagestringOptional

AnalysisPlanSummaryPromptstringOptional

FeatureEndCallWhenVoicemailbooleanOptional

FeatureRedialOnNoResponsebooleanOptional

RedialSettingsstringOptional

JSON string of redial settings

FeatureDoubleCallbooleanOptional

DailyCallLimitintegerOptional

IdleMessagesstringOptional

JSON string of idle messages

IsOutboundChatActivebooleanOptional

Response

Campaign created

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

400

Bad Request Error

500

Internal Server Error