Create campaign
Creates a campaign of one of four types: outbound phone, inbound phone,
voice bubble (web), or Messages/SMS. The channel is set via the
combination of campaignType, CallType, MessagesCampaign, and
Position:
Next step — create an agent. A campaign on its own is just the shell (channel, language, phone numbers, schedule). The voice, scripts, model, and conversational behavior all live on an agent attached to the campaign. After this request returns the campaign ID, call
POST /agent/new/{campaignId}(template-driven) orPOST /agent/{campaignId}(inline configuration) to attach an agent. Without an agent, the campaign cannot place or receive calls/messages.
Picking a TemplateId
TemplateId is required. Pick one from the catalog below — match
on the user’s selected language and on the campaign channel (type
column maps to the channel: outbound, inbound, web for voice
bubble, messages for SMS). Pass the chosen Template ID as
TemplateId in the request body.
Supported languages: en-US (English), es-US (Spanish), de
(German), ro-RO (Romanian), fr-FR (French), hi-IN (Hindi),
he-IL (Hebrew), tr-TR (Turkish), multilanguage (Multilingual).
English (en-US)
Spanish (es-US)
German (de)
Romanian (ro-RO)
French (fr-FR)
Hindi (hi-IN)
Hebrew (he-IL)
Turkish (tr-TR)
Multilingual (multilanguage)
Outbound phone
Inbound phone
Inbound is always-on — drop StartDate, TimeWindows, and
FeatureRescheduleCallEnabled. FeatureAppendPreviousSummaryEnabled
is inbound-only.
Voice bubble (web)
campaignType: "0", no CallType, add Position. Drop phone-only
schedule fields and summary append.
Messages / SMS
campaignType: "0" + MessagesCampaign: true. No CallType,
no schedule windows (text is async).
Authentication
Your Atlas API key. Get it from the Atlas Portal under Settings > API Keys.
Request
Required. Human-readable campaign name.
Required. Channel family. "1" = phone (inbound or outbound — set direction with CallType). "0" = non-phone (voice bubble or Messages/SMS — distinguished by MessagesCampaign).
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.
Required when campaignType is "1", omit otherwise. Phone direction: "1" = inbound, "2" = outbound.
Optional. Set true (with campaignType: "0") to create a Messages/SMS campaign. Omit for voice bubble.
Required for voice bubble (campaignType: "0" with MessagesCampaign omitted). Voice bubble position on the host page. Omit for phone and Messages campaigns.
Optional. Injected as {{companyName}} in the script.
Optional. Display name shown to callers/visitors.
Optional. Outbound-only — first date the agent may begin dialing. Ignored for inbound, voice bubble, and Messages campaigns.
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.
Optional. Outbound-only — allow agent to reschedule calls.
Optional. Toggle caller-info enrichment.
Optional. Inbound-only — append previous call summary to context.
Optional. IANA timezone, e.g. America/New_York.
Optional. Human-readable timezone label.
Optional. Collection/group identifier.
Optional. Comma-separated tool IDs.
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.
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
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.
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.