For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
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).
Allowed values:
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.
Allowed values:
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.
Allowed values:
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.
Optional. Inbound-only — append previous call summary to context.
EnrichmentInfoProviderenumOptional
Optional. Provider used for caller enrichment.
Allowed values:
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.
Allowed values:
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.
Allowed values:
EndCallMessagestringOptional
Optional. Message the agent says before hanging up.
VoicemailMessagestringOptional
Optional. Message left on voicemail.
AnalysisPlanSummaryPromptstringOptional
Optional. Prompt used to summarize calls for analysis.
AnalysisPlanSuccessEvaluationPromptstringOptional
Optional. Prompt used to evaluate whether the call achieved its goal.
AnalysisPlanStructuredDataPromptstringOptional
Optional. Prompt used to extract structured data from calls.
FeatureEndCallWhenVoicemailbooleanOptional
Optional. End the call when voicemail is detected.
VoicemailDropMechanismenumOptional
Optional. Voicemail drop strategy. audio-detection detects voicemail via audio analysis and drops a pre-recorded message. ringless delivers a voicemail without ringing the recipient’s phone.
Allowed values:
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).
Voicemail drop strategy. audio-detection detects voicemail via audio analysis and drops a pre-recorded message. ringless delivers a voicemail without ringing the recipient’s phone.
Allowed values:
FeatureRedialOnNoResponsebooleanOptional
RedialSettingsstringOptional
JSON string of redial attempt configuration
FeatureDoubleCallbooleanOptional
TimezonestringOptional
TimezoneFriendlyNamestringOptional
StatusenumOptional
Allowed values:
CollectionstringOptional
IdleMessagesstringOptional
ToolIdsstringOptional
SMSTriggerstringOptional
SMSBodystringOptional
ForwardingPhoneNumberstringOptional
PreScriptstringOptional
PostScriptstringOptional
FirstMessageModeenumOptional
Allowed values:
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.
