Atlas APICampaigns

Update full campaign

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.
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.

Response

Campaign updated
PartitionKeystring
RowKeystring
Timestampdatetime
odata.etagstring
namestring
campaignTypestring
Modeboolean
BusinessNamestring
CallTypestring
CompanyNamestring
FirstMessagestring
IsActiveboolean
PhoneNumberIdstring
Positionstring
ScriptBasestring
ScriptNotesstring
StartDatedatetime
TimeWindowsstring

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

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
Collectionstring
IdleMessagesstring
ToolIdsstring
SMSTriggerstring
SMSBodystring
ForwardingPhoneNumberstring
PreScriptstring
PostScriptstring
FirstMessageModeenum
ChatPhoneNumberIdstring
IsOutboundChatActiveboolean
AIAssistantProviderenum or null
AI assistant runtime powering this campaign. Returns "atlas" when the campaign uses the Atlas runtime, or null otherwise.

Errors

400
Bad Request Error
404
Not Found Error
500
Internal Server Error