Update full campaign | Atlas

curl -X PUT https://api.youratlas.com/v1/api/campaign/id/all \
     -H "api-key: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "campaign": {
    "name": "Spring Sale Campaign",
    "campaignType": "0",
    "TemplateId": "tpl_9876543210"
  }
}'

{
  "PartitionKey": "campaigns",
  "RowKey": "spring-sale-2024",
  "Timestamp": "2024-01-15T09:30:00Z",
  "odata.etag": "W/\"datetime'2024-01-15T09%3A30%3A00.0000000Z'\"",
  "name": "Spring Sale Campaign",
  "campaignType": "0",
  "Mode": true,
  "BusinessName": "Springfield Retail",
  "CallType": "",
  "CompanyName": "Springfield Retail Inc.",
  "FirstMessage": "Hello, thank you for contacting Springfield Retail. How can I assist you today?",
  "IsActive": true,
  "PhoneNumberId": "phn_1234567890",
  "Position": "bottom-right",
  "ScriptBase": "Welcome to our Spring Sale! Let me know if you have any questions about our products.",
  "ScriptNotes": "Focus on highlighting discounts and limited-time offers.",
  "StartDate": "2024-03-01T08:00:00Z",
  "TimeWindows": "[{\"startHour\":9,\"startMinute\":0,\"endHour\":17,\"endMinute\":0}]",
  "SuccessRequest": 150,
  "TemplateId": "tpl_9876543210",
  "TotalRequest": 200,
  "TotalTransfers": 10,
  "DailyCallLimit": 50,
  "KnowledgeBaseId": "kb_2024_spring",
  "KnowledgeBaseDataSetId": "dataset_001",
  "FeatureAppendPreviousSummaryEnabled": true,
  "PhoneNumberProvider": "twilio",
  "FeatureRescheduleCallEnabled": true,
  "EnrichmentInfoSettings": "{\"includeEmail\":true,\"includePurchaseHistory\":true}",
  "EnrichmentInfoProvider": "hubspot",
  "FeatureEnrichmentInfoEnabled": true,
  "EndCallMessage": "Thank you for your time. Have a great day!",
  "VoicemailMessage": "Hi, this is Springfield Retail. Please leave a message and we will get back to you shortly.",
  "AnalysisPlanSummaryPrompt": "Summarize the key points discussed during the call.",
  "FeatureEndCallWhenVoicemail": true,
  "FeatureRedialOnNoResponse": true,
  "RedialSettings": "{\"maxAttempts\":3,\"intervalMinutes\":15}",
  "FeatureDoubleCall": true,
  "Timezone": "America/New_York",
  "TimezoneFriendlyName": "Eastern Time (US & Canada)",
  "Status": "active",
  "Collection": "seasonal_campaigns",
  "IdleMessages": "[\"Are you still there?\",\"Let me know if you have any questions.\"]",
  "ToolIds": "tool_123,tool_456",
  "SMSTrigger": "SendPromo",
  "SMSBody": "Don't miss our Spring Sale! Visit our website for exclusive deals.",
  "ForwardingPhoneNumber": "+12345678901",
  "PreScript": "Please greet the customer warmly and confirm their interest in our Spring Sale.",
  "PostScript": "Thank the customer and offer additional assistance if needed.",
  "FirstMessageMode": "assistant-speaks-first",
  "ChatPhoneNumberId": "chatphn_7890",
  "IsOutboundChatActive": true,
  "ChatReplyPacingEnabled": true,
  "ChatReplyPacingSeconds": 5,
  "AIAssistantProvider": "atlas",
  "TotalBooked": 75.5,
  "AtlasKnowledgeBaseId": "atlas_kb_2024",
  "MarketplaceAgentId": "agent_2024_01",
  "AgentType": "virtual",
  "language": "en-US",
  "voiceId": "voice_en_us_001"
}

Update campaign with all associated data

Authentication

api-keystring

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

Path parameters

idstringRequired

The campaign ID

Request

This endpoint expects an object.

campaignobjectRequired

agentobjectOptional

Response

Campaign updated

PartitionKeystringOptional

RowKeystringOptional

TimestampdatetimeOptional

odata.etagstringOptional

namestringOptional

campaignTypestringOptional

ModebooleanOptional

BusinessNamestringOptional

CallTypestringOptional

CompanyNamestringOptional

FirstMessagestringOptional

IsActivebooleanOptional

PhoneNumberIdstringOptional

PositionstringOptional

ScriptBasestringOptional

ScriptNotesstringOptional

StartDatedatetimeOptional

TimeWindowsstringOptional

JSON-encoded array of time-window objects. Each object contains startHour (0–23), startMinute (0–59), endHour (0–23), and endMinute (0–59).

SuccessRequestintegerOptional

TemplateIdstringOptional

TotalRequestintegerOptional

TotalTransfersintegerOptional

DailyCallLimitintegerOptional

KnowledgeBaseIdstringOptional

KnowledgeBaseDataSetIdstringOptional

Knowledge base dataset identifier

FeatureAppendPreviousSummaryEnabledbooleanOptional

PhoneNumberProviderstringOptional

FeatureRescheduleCallEnabledbooleanOptional

EnrichmentInfoSettingsstringOptional

EnrichmentInfoProviderstringOptional

FeatureEnrichmentInfoEnabledbooleanOptional

EndCallMessagestringOptional

VoicemailMessagestringOptional

AnalysisPlanSummaryPromptstringOptional

FeatureEndCallWhenVoicemailbooleanOptional

FeatureRedialOnNoResponsebooleanOptional

RedialSettingsstringOptional

JSON string of redial attempt configuration

FeatureDoubleCallbooleanOptional

TimezonestringOptional

TimezoneFriendlyNamestringOptional

StatusenumOptional

CollectionstringOptional

IdleMessagesstringOptional

ToolIdsstringOptional

SMSTriggerstringOptional

SMSBodystringOptional

ForwardingPhoneNumberstringOptional

PreScriptstringOptional

PostScriptstringOptional

FirstMessageModeenumOptional

ChatPhoneNumberIdstringOptional

IsOutboundChatActivebooleanOptional

ChatReplyPacingEnabledbooleanOptional

Whether AI chat reply pacing is enabled. When true, reply bubbles are sent with a typing indicator and a short delay, making conversations feel more natural. Messages campaigns only.

ChatReplyPacingSecondsintegerOptional

Fixed per-bubble typing duration in seconds (1–60). When absent or 0 the duration is auto-calculated based on message length. Messages campaigns only.

AIAssistantProviderenum or nullOptional

AI assistant runtime powering this campaign. Returns "atlas" when the campaign uses the Atlas runtime, or null otherwise.

TotalBookeddoubleOptional

AtlasKnowledgeBaseIdstringOptional

MarketplaceAgentIdstringOptional

AgentTypestringOptional

languagestringOptional

voiceIdstringOptional

Errors

400

Bad Request Error

404

Not Found Error

500

Internal Server Error