Update campaign | Atlas | Documentation

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.

namestringRequired

Required. Human-readable campaign name.

campaignTypeenumRequired

Required. Channel family. "1" = phone (inbound or outbound — set direction with CallType). "0" = non-phone (voice bubble or Messages/SMS — distinguished by MessagesCampaign).

TemplateIdstringRequired

Required. ID of a starter template. See the catalog tables in the Create campaign endpoint description — pick the row matching the user’s language and the campaign channel (outbound, inbound, web for voice bubble, messages for SMS) and pass its Template ID here.

CallTypeenumOptional

Required when campaignType is "1", omit otherwise. Phone direction: "1" = inbound, "2" = outbound.

MessagesCampaignbooleanOptional

Optional. Set true (with campaignType: "0") to create a Messages/SMS campaign. Omit for voice bubble.

PositionenumOptional

Required for voice bubble (campaignType: "0" with MessagesCampaign omitted). Voice bubble position on the host page. Omit for phone and Messages campaigns.

CompanyNamestringOptional

Optional. Injected as {{companyName}} in the script.

BusinessNamestringOptional

Optional. Display name shown to callers/visitors.

IsActivebooleanOptional

Optional. Whether the campaign is enabled at creation.

ModebooleanOptional

Optional.

StartDatedatetimeOptional

Optional. Outbound-only — first date the agent may begin dialing. Ignored for inbound, voice bubble, and Messages campaigns.

TimeWindowsstringOptional

Optional. Outbound-only. JSON-encoded array of time-window objects. Each object must contain startHour (0–23), startMinute (0–59), endHour (0–23), and endMinute (0–59). Example: [{“startHour”:9,“startMinute”:0,“endHour”:17,“endMinute”:0}]. Ignored for inbound, voice bubble, and Messages campaigns.

FirstMessagestringOptional

Optional. Greeting the agent speaks at the start of every call.

PreScriptstringOptional

Optional. Prepended to the agent prompt.

PostScriptstringOptional

Optional. Appended to the agent prompt.

ScriptBasestringOptional

Optional. The agent's conversation script.

ScriptNotesstringOptional

Optional. Additional script guidance.

FeatureRescheduleCallEnabledbooleanOptional

Optional. Outbound-only — allow agent to reschedule calls.

FeatureEnrichmentInfoEnabledbooleanOptional

Optional. Toggle caller-info enrichment.

FeatureAppendPreviousSummaryEnabledbooleanOptional

Optional. Inbound-only — append previous call summary to context.

EnrichmentInfoProviderenumOptional

Optional. Provider used for caller enrichment.

EnrichmentInfoSettingsstringOptional

Optional. JSON string of enrichment settings.

TimezonestringOptional

Optional. IANA timezone, e.g. America/New_York.

TimezoneFriendlyNamestringOptional

Optional. Human-readable timezone label.

StatusenumOptional

Optional. Lifecycle state.

CollectionstringOptional

Optional. Collection/group identifier.

ToolIdsstringOptional

Optional. Comma-separated tool IDs.

SMSTriggerstringOptional

Optional. Trigger phrase that fires an SMS during a call.

SMSBodystringOptional

Optional. SMS body associated with the trigger.

FirstMessageModeenumOptional

Optional. Who speaks first at call start.

EndCallMessagestringOptional

Optional. Message the agent says before hanging up.

VoicemailMessagestringOptional

Optional. Message left on voicemail.

AnalysisPlanSummaryPromptstringOptional

Optional. Prompt used to summarize calls for analysis.

FeatureEndCallWhenVoicemailbooleanOptional

Optional. End the call when voicemail is detected.

FeatureRedialOnNoResponsebooleanOptional

Optional. Retry call when there's no answer.

RedialSettingsstringOptional

Optional. JSON string of redial settings.

FeatureDoubleCallbooleanOptional

Optional. Place two concurrent attempts.

DailyCallLimitintegerOptional

Optional. Maximum calls per day.

IdleMessagesstringOptional

Optional. JSON string of idle messages.

IsOutboundChatActivebooleanOptional

Optional. Whether outbound chat is enabled.

ChatReplyPacingEnabledbooleanOptional

Optional. Messages campaigns only. When true, AI chat reply bubbles are paced with a typing indicator and a short delay before each send, making conversations feel more natural.

ChatReplyPacingSecondsintegerOptional1-60

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

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

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

1	{
2	"PartitionKey": "campaigns",
3	"RowKey": "campaign_123456789",
4	"Timestamp": "2024-01-15T09:30:00Z",
5	"odata.etag": "W/\"datetime'2024-01-15T09%3A30%3A00.0000000Z'\"",
6	"name": "Spring Sale Campaign",
7	"campaignType": "0",
8	"Mode": false,
9	"BusinessName": "Acme Corp",
10	"CallType": "",
11	"CompanyName": "Acme Corporation",
12	"FirstMessage": "Hello, thank you for contacting Acme Corp. How can I assist you today?",
13	"IsActive": true,
14	"PhoneNumberId": "phone_12345",
15	"Position": "bottom-right",
16	"ScriptBase": "Welcome to our spring sale! Let me know if you have any questions.",
17	"ScriptNotes": "Focus on highlighting discounts and limited-time offers.",
18	"StartDate": "2024-03-01T08:00:00Z",
19	"TimeWindows": "[{\"startHour\":9,\"startMinute\":0,\"endHour\":17,\"endMinute\":0}]",
20	"SuccessRequest": 150,
21	"TemplateId": "tpl_987654321",
22	"TotalRequest": 200,
23	"TotalTransfers": 25,
24	"DailyCallLimit": 100,
25	"KnowledgeBaseId": "kb_123456",
26	"KnowledgeBaseDataSetId": "dataset_7890",
27	"FeatureAppendPreviousSummaryEnabled": false,
28	"PhoneNumberProvider": "twilio",
29	"FeatureRescheduleCallEnabled": true,
30	"EnrichmentInfoSettings": "{\"includeEmail\":true,\"includeLocation\":true}",
31	"EnrichmentInfoProvider": "hubspot",
32	"FeatureEnrichmentInfoEnabled": true,
33	"EndCallMessage": "Thank you for your time. Have a great day!",
34	"VoicemailMessage": "Hi, this is Acme Corp. Please call us back at your convenience.",
35	"AnalysisPlanSummaryPrompt": "Summarize the key points discussed during the call.",
36	"FeatureEndCallWhenVoicemail": true,
37	"FeatureRedialOnNoResponse": true,
38	"RedialSettings": "{\"maxAttempts\":3,\"intervalMinutes\":15}",
39	"FeatureDoubleCall": false,
40	"Timezone": "America/New_York",
41	"TimezoneFriendlyName": "Eastern Time (US & Canada)",
42	"Status": "active",
43	"Collection": "spring_campaigns",
44	"IdleMessages": "[\"Are you still there?\",\"Let me know if you have any questions.\"]",
45	"ToolIds": "tool_1,tool_2",
46	"SMSTrigger": "send info",
47	"SMSBody": "Thank you for your interest! Visit our website for more details.",
48	"ForwardingPhoneNumber": "+1234567890",
49	"PreScript": "Please greet the customer warmly.",
50	"PostScript": "Remind the customer about the ongoing sale.",
51	"FirstMessageMode": "assistant-speaks-first",
52	"ChatPhoneNumberId": "chat_67890",
53	"IsOutboundChatActive": true,
54	"ChatReplyPacingEnabled": true,
55	"ChatReplyPacingSeconds": 5,
56	"AIAssistantProvider": "atlas",
57	"TotalBooked": 75.5,
58	"AtlasKnowledgeBaseId": "atlas_kb_001",
59	"MarketplaceAgentId": "agent_123",
60	"AgentType": "virtual",
61	"language": "en-US",
62	"voiceId": "voice_abc123"
63	}