{"docsConfig":{"theme":"almond","$schema":"https://mintlify.com/docs.json","name":"AgentCallback Documentation","description":"Learn how AgentCallback works, build and deploy AI voice agents, and manage your team.","colors":{"primary":"#2563EB","light":"#60A5FA","dark":"#1D4ED8"},"favicon":"https://mintcdn.com/agentcallback/ljTEvtVqYOxAk7VB/favicon.ico?fit=max\u0026auto=format\u0026n=ljTEvtVqYOxAk7VB\u0026q=85\u0026s=d4d1c20bd57c5f99813cc4b56e32e5e4","navbar":{"links":[],"primary":{"type":"button","label":"Dashboard","href":"https://agentcallback.com/sign-in"}},"icons":{"library":"lucide"},"styling":{"eyebrows":"breadcrumbs","latex":false},"contextual":{"options":["copy","view","assistant","mcp","add-mcp"],"display":"header"},"navigation":{"global":{"anchors":[{"anchor":"Home","icon":"house","href":"/"},{"anchor":"Get started","icon":"rocket","href":"/platform/quickstart"}]},"directory":"card","pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"agentcallback","hasAudioNarration":false,"actualSubdomain":"agentcallback","customDomains":["docs.agentcallback.com"],"gitSource":{"type":"github","owner":"agentcallback","repo":"agentcallbackai","deployBranch":"main","contentDirectory":"apps/docs","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6ac3374edd58520b5d1e187a","clientVersion":"0.0.4088","searchFilterCounts":[{"language":"default","tag":"API Reference","count":34},{"language":"default","tag":"Endpoints","count":33},{"language":"default","tag":"Documentation","count":28},{"language":"default","tag":"Campaigns","count":20},{"language":"default","tag":"Build voice agents","count":9},{"language":"default","tag":"Voice Agents","count":6},{"language":"default","tag":"Deploy","count":5},{"language":"default","tag":"Voices","count":5},{"language":"default","tag":"Calls","count":4},{"language":"default","tag":"Monitoring","count":3}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":true},"customCss":[{"filePath":"style.css","content":":root{--default-border-color: var(--gray-200)}.dark{--default-border-color: var(--gray-800)}#sidebar .nav-dropdown-trigger{border:none!important;background:transparent!important;box-shadow:none!important;padding-left:0.375rem}#sidebar .nav-dropdown-trigger:hover{background-color:rgb(0 0 0 / 0.04)!important}.dark #sidebar .nav-dropdown-trigger:hover{background-color:rgb(255 255 255 / 0.06)!important}#sidebar .nav-dropdown-trigger .nav-dropdown-item-icon{border:none!important;background:transparent!important;height:auto!important;width:auto!important;padding:0!important}.nav-dropdown-content{}.nav-dropdown-content .nav-dropdown-item{}.nav-dropdown-content .nav-dropdown-item-icon{border:none!important;background:transparent!important;height:auto!important;width:auto!important;padding:0!important}.nav-dropdown-content .nav-dropdown-item-description{display:none!important}#sidebar .nav-anchor span{font-family:ui-monospace, SFMono-Regular, Menlo, Monaco, Consolas, monospace;font-size:12px;font-weight:500;letter-spacing:-0.02em;text-transform:uppercase}body:has([data-product-guide-index]) #sidebar a.nav-anchor[href=\"/\"]{color:rgb(var(--primary))!important;font-weight:600!important}body:has([data-product-guide-index]) #sidebar a.nav-anchor[href=\"/\"] span{color:inherit!important}body:has([data-product-guide-index]) #sidebar a.nav-anchor[href=\"/\"] svg{background-color:rgb(var(--primary))!important}.dark body:has([data-product-guide-index]) #sidebar a.nav-anchor[href=\"/\"]{color:rgb(var(--primary-light)/var(--tw-text-opacity,1))!important}.dark body:has([data-product-guide-index]) #sidebar a.nav-anchor[href=\"/\"] svg{background-color:rgb(var(--primary-light)/var(--tw-text-opacity,1))!important}:is(#content-area[data-current-path=\"/\"],[data-current-path=\"/\"] #content-area):has([data-product-guide-index]){background:transparent!important;padding:0!important}:is(#content-area[data-current-path=\"/\"],[data-current-path=\"/\"] #content-area):has([data-product-guide-index])>div:first-child{background:transparent!important;padding-right:0!important;padding-bottom:0!important;padding-left:0!important}[data-product-guide-index] a:not(.product-guide-feature-card){background-color:#fafafa!important}.dark [data-product-guide-index] a:not(.product-guide-feature-card){background-color:#09090b!important}.product-guide-feature-card{grid-column:1 / -1;display:flex!important;flex-direction:column!important;justify-content:space-between!important;min-height:260px;background:url('/images/sample-feature-light.png') center / cover no-repeat!important;border:none!important;box-shadow:none!important;color:white!important;.dark \u0026 {\n background-image: url('/images/sample-feature-dark.png') !important;\n }}.product-guide-feature-card>div{display:flex!important;flex:1;flex-direction:column!important;justify-content:space-between!important}.product-guide-feature-card :is(h2,h3,p,span,svg){color:white!important}.product-guide-feature-card :is(svg,[class*=\"icon\"]){background-color:white!important;width:2em!important;height:2em!important;margin-top:2px}.product-guide-feature-card-title{font-size:1.2em;font-weight:500}.product-guide-feature-card :is(h2,h3,p,span,svg).product-guide-feature-card-description{font-size:1.05em;font-weight:400;color:rgb(var(--gray-50) / 62.5%)!important;.dark \u0026 {\n color: rgb(var(--gray-50) / 50%) !important;\n }}img.nav-logo{max-width:220px;height:auto}"}],"page":{"pagePath":"api-reference/campaigns/create-campaign","slug":"/api-reference/campaigns/create-campaign","pageMetadata":{"title":"Create campaign","description":null,"deprecated":null,"version":null,"openapi":"/openapi.json post /api/campaigns","href":"/api-reference/campaigns/create-campaign","autogeneratedByOpenApi":true},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Create campaign","description":null,"deprecated":null,"version":null,"openapi":"/openapi.json post /api/campaigns","href":"/api-reference/campaigns/create-campaign","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Campaigns"],"summary":"Create campaign","security":["5c12105a-6160-4f72-a261-b0bf7230898c"],"parameters":[],"requestBody":"4cf7d4b0-cc87-4f54-aa1b-cdb2a98e1d93","responses":{"200":"b883f5b6-bdf6-44a0-b820-8f8dfe77b381","400":"a676c948-be01-49ba-885f-89fe893718d1","401":"5fdfc7a4-4458-4793-9824-c2463d18ade4","403":"9c40b2ba-b73c-4ead-b883-3dff766edbc0","404":"d0c87cb4-0862-47d5-af06-60a632d4d656","409":"f3d5cbd5-975d-40f0-9bf0-b9a8f2ee7d92","500":"86a651ef-7cf6-4fb8-863f-1ff98911f18b"},"method":"post","type":"path","servers":["8d8a2d8a-01a3-4b88-a28d-681948be19be"],"path":"/api/campaigns","baseUrlOptions":["https://www.agentcallback.com"],"title":"Create campaign","description":"","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"description":"Campaign configuration.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"properties":{"name":{"type":"string","isRequired":true,"uniqueKey":"name","typeLabel":"string"},"script_id":{"type":"string","isRequired":true,"uniqueKey":"script_id","typeLabel":"string"},"description":{"type":"string","uniqueKey":"description","typeLabel":"string"},"file_upload_id":{"type":"string","format":"uuid","description":"ID returned by POST /api/file-uploads.","uniqueKey":"file_upload_id","typeLabel":"string\u003cuuid>"},"variable_mappings":{"type":"object","additionalProperties":true,"uniqueKey":"variable_mappings","typeLabel":"object"},"from_phone_number":{"type":"string","uniqueKey":"from_phone_number","typeLabel":"string"},"routing_strategy":{"type":"string","enum":["single","geographic","random"],"uniqueKey":"routing_strategy","typeLabel":"enum\u003cstring>"},"campaign_timezone":{"type":"string","example":"America/Los_Angeles","uniqueKey":"campaign_timezone","typeLabel":"string"},"scheduled_date":{"type":"string","format":"date","description":"Provide with scheduled_time to create a scheduled campaign; omit both to create a draft.","uniqueKey":"scheduled_date","typeLabel":"string\u003cdate>"},"scheduled_time":{"type":"string","example":"09:00","description":"Provide with scheduled_date to create a scheduled campaign; omit both to create a draft.","uniqueKey":"scheduled_time","typeLabel":"string"},"scheduled_timezone_input":{"type":"string","example":"America/Los_Angeles","uniqueKey":"scheduled_timezone_input","typeLabel":"string"},"working_hours":{"oneOf":[{"type":"object","required":["weekly"],"properties":{"weekly":{"type":"object","additionalProperties":false,"properties":{"monday":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"start":{"type":"string","pattern":"^(?:[01]\\d|2[0-3]):[0-5]\\d$","example":"09:00","isRequired":true,"uniqueKey":"working_hours.oneOf.0.weekly.monday.items.[INDEX].start","typeLabel":"string"},"end":{"type":"string","pattern":"^(?:[01]\\d|2[0-3]):[0-5]\\d$","example":"17:00","isRequired":true,"uniqueKey":"working_hours.oneOf.0.weekly.monday.items.[INDEX].end","typeLabel":"string"}},"required":["start","end"],"uniqueKey":"working_hours.oneOf.0.weekly.monday.items.[INDEX]","typeLabel":"object"},"uniqueKey":"working_hours.oneOf.0.weekly.monday","typeLabel":"object[]"},"tuesday":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"start":{"type":"string","pattern":"^(?:[01]\\d|2[0-3]):[0-5]\\d$","example":"09:00","isRequired":true,"uniqueKey":"working_hours.oneOf.0.weekly.tuesday.items.[INDEX].start","typeLabel":"string"},"end":{"type":"string","pattern":"^(?:[01]\\d|2[0-3]):[0-5]\\d$","example":"17:00","isRequired":true,"uniqueKey":"working_hours.oneOf.0.weekly.tuesday.items.[INDEX].end","typeLabel":"string"}},"required":["start","end"],"uniqueKey":"working_hours.oneOf.0.weekly.tuesday.items.[INDEX]","typeLabel":"object"},"uniqueKey":"working_hours.oneOf.0.weekly.tuesday","typeLabel":"object[]"},"wednesday":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"start":{"type":"string","pattern":"^(?:[01]\\d|2[0-3]):[0-5]\\d$","example":"09:00","isRequired":true,"uniqueKey":"working_hours.oneOf.0.weekly.wednesday.items.[INDEX].start","typeLabel":"string"},"end":{"type":"string","pattern":"^(?:[01]\\d|2[0-3]):[0-5]\\d$","example":"17:00","isRequired":true,"uniqueKey":"working_hours.oneOf.0.weekly.wednesday.items.[INDEX].end","typeLabel":"string"}},"required":["start","end"],"uniqueKey":"working_hours.oneOf.0.weekly.wednesday.items.[INDEX]","typeLabel":"object"},"uniqueKey":"working_hours.oneOf.0.weekly.wednesday","typeLabel":"object[]"},"thursday":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"start":{"type":"string","pattern":"^(?:[01]\\d|2[0-3]):[0-5]\\d$","example":"09:00","isRequired":true,"uniqueKey":"working_hours.oneOf.0.weekly.thursday.items.[INDEX].start","typeLabel":"string"},"end":{"type":"string","pattern":"^(?:[01]\\d|2[0-3]):[0-5]\\d$","example":"17:00","isRequired":true,"uniqueKey":"working_hours.oneOf.0.weekly.thursday.items.[INDEX].end","typeLabel":"string"}},"required":["start","end"],"uniqueKey":"working_hours.oneOf.0.weekly.thursday.items.[INDEX]","typeLabel":"object"},"uniqueKey":"working_hours.oneOf.0.weekly.thursday","typeLabel":"object[]"},"friday":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"start":{"type":"string","pattern":"^(?:[01]\\d|2[0-3]):[0-5]\\d$","example":"09:00","isRequired":true,"uniqueKey":"working_hours.oneOf.0.weekly.friday.items.[INDEX].start","typeLabel":"string"},"end":{"type":"string","pattern":"^(?:[01]\\d|2[0-3]):[0-5]\\d$","example":"17:00","isRequired":true,"uniqueKey":"working_hours.oneOf.0.weekly.friday.items.[INDEX].end","typeLabel":"string"}},"required":["start","end"],"uniqueKey":"working_hours.oneOf.0.weekly.friday.items.[INDEX]","typeLabel":"object"},"uniqueKey":"working_hours.oneOf.0.weekly.friday","typeLabel":"object[]"},"saturday":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"start":{"type":"string","pattern":"^(?:[01]\\d|2[0-3]):[0-5]\\d$","example":"09:00","isRequired":true,"uniqueKey":"working_hours.oneOf.0.weekly.saturday.items.[INDEX].start","typeLabel":"string"},"end":{"type":"string","pattern":"^(?:[01]\\d|2[0-3]):[0-5]\\d$","example":"17:00","isRequired":true,"uniqueKey":"working_hours.oneOf.0.weekly.saturday.items.[INDEX].end","typeLabel":"string"}},"required":["start","end"],"uniqueKey":"working_hours.oneOf.0.weekly.saturday.items.[INDEX]","typeLabel":"object"},"uniqueKey":"working_hours.oneOf.0.weekly.saturday","typeLabel":"object[]"},"sunday":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"start":{"type":"string","pattern":"^(?:[01]\\d|2[0-3]):[0-5]\\d$","example":"09:00","isRequired":true,"uniqueKey":"working_hours.oneOf.0.weekly.sunday.items.[INDEX].start","typeLabel":"string"},"end":{"type":"string","pattern":"^(?:[01]\\d|2[0-3]):[0-5]\\d$","example":"17:00","isRequired":true,"uniqueKey":"working_hours.oneOf.0.weekly.sunday.items.[INDEX].end","typeLabel":"string"}},"required":["start","end"],"uniqueKey":"working_hours.oneOf.0.weekly.sunday.items.[INDEX]","typeLabel":"object"},"uniqueKey":"working_hours.oneOf.0.weekly.sunday","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"working_hours.oneOf.0.weekly","typeLabel":"object"}},"additionalProperties":false,"uniqueKey":"working_hours.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"working_hours.oneOf.1","typeLabel":"null"}],"uniqueKey":"working_hours","typeLabel":"object | null"},"working_hours_timezone":{"type":"string","example":"America/New_York","description":"Optional IANA override; otherwise uses campaign_timezone.","uniqueKey":"working_hours_timezone","typeLabel":"string"},"workflow_config":{"oneOf":[{"type":"object","description":"Optional multi-attempt workflow. When configured, it supersedes simple retry settings.","required":["attempts"],"example":{"retryOutcomes":["CALLEE_DID_NOT_PICKUP","VOICE_MAIL"],"attempts":[{"day":0,"startTime":"00:00","doubleDial":false},{"day":1,"startTime":"16:00","doubleDial":true},{"day":3,"startTime":"10:00","doubleDial":false}],"timezone":"America/Los_Angeles"},"properties":{"attempts":{"type":"array","minItems":1,"description":"Attempts in chronological order. The entry { day: 0, startTime: \"00:00\", doubleDial: false } defines only the first attempt and dials once. Add a second item to schedule a second attempt. The initial entry's doubleDial value controls whether that first attempt is dialed twice.","items":{"type":"object","additionalProperties":false,"description":"One call attempt in a campaign workflow.","properties":{"day":{"type":"integer","minimum":0,"description":"Day offset from when the contact enters the campaign. Use 0 for the initial attempt.","isRequired":true,"uniqueKey":"workflow_config.oneOf.0.attempts.items.[INDEX].day","typeLabel":"integer"},"startTime":{"type":"string","pattern":"^(?:[01]\\d|2[0-3]):[0-5]\\d$","example":"16:00","description":"Attempt time in 24-hour HH:mm format. The synthetic initial attempt uses 00:00 and follows the campaign start time.","isRequired":true,"uniqueKey":"workflow_config.oneOf.0.attempts.items.[INDEX].startTime","typeLabel":"string"},"doubleDial":{"type":"boolean","default":false,"description":"Whether to call twice back-to-back for this attempt.","uniqueKey":"workflow_config.oneOf.0.attempts.items.[INDEX].doubleDial","typeLabel":"boolean"}},"required":["day","startTime"],"uniqueKey":"workflow_config.oneOf.0.attempts.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"workflow_config.oneOf.0.attempts","typeLabel":"object[]"},"retryOutcomes":{"type":"array","description":"Call outcomes that advance a contact to the next attempt. Defaults to CALLEE_DID_NOT_PICKUP and VOICE_MAIL when omitted.","items":{"type":"string","uniqueKey":"workflow_config.oneOf.0.retryOutcomes.items.[INDEX]","typeLabel":"string"},"example":["CALLEE_DID_NOT_PICKUP","VOICE_MAIL"],"uniqueKey":"workflow_config.oneOf.0.retryOutcomes","typeLabel":"string[]"},"timezone":{"type":"string","example":"America/Los_Angeles","description":"Optional IANA timezone for workflow attempt times. Inherits the campaign timezone when omitted.","uniqueKey":"workflow_config.oneOf.0.timezone","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"workflow_config.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"workflow_config.oneOf.1","typeLabel":"null"}],"uniqueKey":"workflow_config","typeLabel":"object | null"},"max_concurrent_calls":{"type":"integer","minimum":1,"maximum":6,"uniqueKey":"max_concurrent_calls","typeLabel":"integer"},"call_spacing_seconds":{"type":"integer","minimum":0,"uniqueKey":"call_spacing_seconds","typeLabel":"integer"},"api_contacts_enabled":{"type":"boolean","description":"For outbound campaigns without a CSV. Start the campaign, then submit contacts through POST /api/make-calls with campaign_id.","uniqueKey":"api_contacts_enabled","typeLabel":"boolean"}},"required":["name","script_id"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"name":"\u003cstring>","script_id":"\u003cstring>","description":"\u003cstring>","file_upload_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","variable_mappings":{},"from_phone_number":"\u003cstring>","campaign_timezone":"America/Los_Angeles","scheduled_date":"2023-12-25","scheduled_time":"09:00","scheduled_timezone_input":"America/Los_Angeles","working_hours":{"weekly":{"monday":[{"start":"09:00","end":"17:00"}],"tuesday":[{"start":"09:00","end":"17:00"}],"wednesday":[{"start":"09:00","end":"17:00"}],"thursday":[{"start":"09:00","end":"17:00"}],"friday":[{"start":"09:00","end":"17:00"}],"saturday":[{"start":"09:00","end":"17:00"}],"sunday":[{"start":"09:00","end":"17:00"}]}},"working_hours_timezone":"America/New_York","workflow_config":{"retryOutcomes":["CALLEE_DID_NOT_PICKUP","VOICE_MAIL"],"attempts":[{"day":0,"startTime":"00:00","doubleDial":false},{"day":1,"startTime":"16:00","doubleDial":true},{"day":3,"startTime":"10:00","doubleDial":false}],"timezone":"America/Los_Angeles"},"max_concurrent_calls":3,"call_spacing_seconds":1,"api_contacts_enabled":true}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"b883f5b6-bdf6-44a0-b820-8f8dfe77b381":{"description":"Campaign created","content":{"application/json":{"schema":{"type":"object","required":["success"],"properties":{"success":{"type":"boolean","example":true,"isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"campaign":{"type":"object","additionalProperties":true,"properties":{"id":{"type":"string","format":"uuid","uniqueKey":"campaign.id","typeLabel":"string\u003cuuid>"},"name":{"type":"string","uniqueKey":"campaign.name","typeLabel":"string"},"status":{"type":"string","uniqueKey":"campaign.status","typeLabel":"string"},"script_id":{"type":"string","uniqueKey":"campaign.script_id","typeLabel":"string"},"file_upload_id":{"oneOf":[{"type":"string","format":"uuid","uniqueKey":"campaign.file_upload_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","uniqueKey":"campaign.file_upload_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"campaign.file_upload_id","typeLabel":"string\u003cuuid> | null"},"api_contacts_enabled":{"type":"boolean","uniqueKey":"campaign.api_contacts_enabled","typeLabel":"boolean"},"campaign_timezone":{"oneOf":[{"type":"string","uniqueKey":"campaign.campaign_timezone.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"campaign.campaign_timezone.oneOf.1","typeLabel":"null"}],"uniqueKey":"campaign.campaign_timezone","typeLabel":"string | null"},"working_hours":{"oneOf":[{"type":"object","required":["weekly"],"properties":{"weekly":{"type":"object","additionalProperties":false,"properties":{"monday":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"start":{"type":"string","pattern":"^(?:[01]\\d|2[0-3]):[0-5]\\d$","example":"09:00","isRequired":true,"uniqueKey":"campaign.working_hours.oneOf.0.weekly.monday.items.[INDEX].start","typeLabel":"string"},"end":{"type":"string","pattern":"^(?:[01]\\d|2[0-3]):[0-5]\\d$","example":"17:00","isRequired":true,"uniqueKey":"campaign.working_hours.oneOf.0.weekly.monday.items.[INDEX].end","typeLabel":"string"}},"required":["start","end"],"uniqueKey":"campaign.working_hours.oneOf.0.weekly.monday.items.[INDEX]","typeLabel":"object"},"uniqueKey":"campaign.working_hours.oneOf.0.weekly.monday","typeLabel":"object[]"},"tuesday":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"start":{"type":"string","pattern":"^(?:[01]\\d|2[0-3]):[0-5]\\d$","example":"09:00","isRequired":true,"uniqueKey":"campaign.working_hours.oneOf.0.weekly.tuesday.items.[INDEX].start","typeLabel":"string"},"end":{"type":"string","pattern":"^(?:[01]\\d|2[0-3]):[0-5]\\d$","example":"17:00","isRequired":true,"uniqueKey":"campaign.working_hours.oneOf.0.weekly.tuesday.items.[INDEX].end","typeLabel":"string"}},"required":["start","end"],"uniqueKey":"campaign.working_hours.oneOf.0.weekly.tuesday.items.[INDEX]","typeLabel":"object"},"uniqueKey":"campaign.working_hours.oneOf.0.weekly.tuesday","typeLabel":"object[]"},"wednesday":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"start":{"type":"string","pattern":"^(?:[01]\\d|2[0-3]):[0-5]\\d$","example":"09:00","isRequired":true,"uniqueKey":"campaign.working_hours.oneOf.0.weekly.wednesday.items.[INDEX].start","typeLabel":"string"},"end":{"type":"string","pattern":"^(?:[01]\\d|2[0-3]):[0-5]\\d$","example":"17:00","isRequired":true,"uniqueKey":"campaign.working_hours.oneOf.0.weekly.wednesday.items.[INDEX].end","typeLabel":"string"}},"required":["start","end"],"uniqueKey":"campaign.working_hours.oneOf.0.weekly.wednesday.items.[INDEX]","typeLabel":"object"},"uniqueKey":"campaign.working_hours.oneOf.0.weekly.wednesday","typeLabel":"object[]"},"thursday":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"start":{"type":"string","pattern":"^(?:[01]\\d|2[0-3]):[0-5]\\d$","example":"09:00","isRequired":true,"uniqueKey":"campaign.working_hours.oneOf.0.weekly.thursday.items.[INDEX].start","typeLabel":"string"},"end":{"type":"string","pattern":"^(?:[01]\\d|2[0-3]):[0-5]\\d$","example":"17:00","isRequired":true,"uniqueKey":"campaign.working_hours.oneOf.0.weekly.thursday.items.[INDEX].end","typeLabel":"string"}},"required":["start","end"],"uniqueKey":"campaign.working_hours.oneOf.0.weekly.thursday.items.[INDEX]","typeLabel":"object"},"uniqueKey":"campaign.working_hours.oneOf.0.weekly.thursday","typeLabel":"object[]"},"friday":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"start":{"type":"string","pattern":"^(?:[01]\\d|2[0-3]):[0-5]\\d$","example":"09:00","isRequired":true,"uniqueKey":"campaign.working_hours.oneOf.0.weekly.friday.items.[INDEX].start","typeLabel":"string"},"end":{"type":"string","pattern":"^(?:[01]\\d|2[0-3]):[0-5]\\d$","example":"17:00","isRequired":true,"uniqueKey":"campaign.working_hours.oneOf.0.weekly.friday.items.[INDEX].end","typeLabel":"string"}},"required":["start","end"],"uniqueKey":"campaign.working_hours.oneOf.0.weekly.friday.items.[INDEX]","typeLabel":"object"},"uniqueKey":"campaign.working_hours.oneOf.0.weekly.friday","typeLabel":"object[]"},"saturday":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"start":{"type":"string","pattern":"^(?:[01]\\d|2[0-3]):[0-5]\\d$","example":"09:00","isRequired":true,"uniqueKey":"campaign.working_hours.oneOf.0.weekly.saturday.items.[INDEX].start","typeLabel":"string"},"end":{"type":"string","pattern":"^(?:[01]\\d|2[0-3]):[0-5]\\d$","example":"17:00","isRequired":true,"uniqueKey":"campaign.working_hours.oneOf.0.weekly.saturday.items.[INDEX].end","typeLabel":"string"}},"required":["start","end"],"uniqueKey":"campaign.working_hours.oneOf.0.weekly.saturday.items.[INDEX]","typeLabel":"object"},"uniqueKey":"campaign.working_hours.oneOf.0.weekly.saturday","typeLabel":"object[]"},"sunday":{"type":"array","items":{"type":"object","additionalProperties":false,"properties":{"start":{"type":"string","pattern":"^(?:[01]\\d|2[0-3]):[0-5]\\d$","example":"09:00","isRequired":true,"uniqueKey":"campaign.working_hours.oneOf.0.weekly.sunday.items.[INDEX].start","typeLabel":"string"},"end":{"type":"string","pattern":"^(?:[01]\\d|2[0-3]):[0-5]\\d$","example":"17:00","isRequired":true,"uniqueKey":"campaign.working_hours.oneOf.0.weekly.sunday.items.[INDEX].end","typeLabel":"string"}},"required":["start","end"],"uniqueKey":"campaign.working_hours.oneOf.0.weekly.sunday.items.[INDEX]","typeLabel":"object"},"uniqueKey":"campaign.working_hours.oneOf.0.weekly.sunday","typeLabel":"object[]"}},"isRequired":true,"uniqueKey":"campaign.working_hours.oneOf.0.weekly","typeLabel":"object"}},"additionalProperties":false,"uniqueKey":"campaign.working_hours.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"campaign.working_hours.oneOf.1","typeLabel":"null"}],"uniqueKey":"campaign.working_hours","typeLabel":"object | null"},"working_hours_timezone":{"oneOf":[{"type":"string","uniqueKey":"campaign.working_hours_timezone.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"campaign.working_hours_timezone.oneOf.1","typeLabel":"null"}],"uniqueKey":"campaign.working_hours_timezone","typeLabel":"string | null"},"scheduled_start_time":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"campaign.scheduled_start_time.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"campaign.scheduled_start_time.oneOf.1","typeLabel":"null"}],"uniqueKey":"campaign.scheduled_start_time","typeLabel":"string\u003cdate-time> | null"},"scheduled_timezone":{"oneOf":[{"type":"string","uniqueKey":"campaign.scheduled_timezone.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"campaign.scheduled_timezone.oneOf.1","typeLabel":"null"}],"uniqueKey":"campaign.scheduled_timezone","typeLabel":"string | null"},"workflow_config":{"oneOf":[{"type":"object","description":"A chronological, multi-attempt calling sequence for each campaign contact.","required":["attempts"],"example":{"retryOutcomes":["CALLEE_DID_NOT_PICKUP","VOICE_MAIL"],"attempts":[{"day":0,"startTime":"00:00","doubleDial":false},{"day":1,"startTime":"16:00","doubleDial":true},{"day":3,"startTime":"10:00","doubleDial":false}],"timezone":"America/Los_Angeles"},"properties":{"attempts":{"type":"array","minItems":1,"description":"Attempts in chronological order. The entry { day: 0, startTime: \"00:00\", doubleDial: false } defines only the first attempt and dials once. Add a second item to schedule a second attempt. The initial entry's doubleDial value controls whether that first attempt is dialed twice.","items":{"type":"object","additionalProperties":false,"description":"One call attempt in a campaign workflow.","properties":{"day":{"type":"integer","minimum":0,"description":"Day offset from when the contact enters the campaign. Use 0 for the initial attempt.","isRequired":true,"uniqueKey":"campaign.workflow_config.oneOf.0.attempts.items.[INDEX].day","typeLabel":"integer"},"startTime":{"type":"string","pattern":"^(?:[01]\\d|2[0-3]):[0-5]\\d$","example":"16:00","description":"Attempt time in 24-hour HH:mm format. The synthetic initial attempt uses 00:00 and follows the campaign start time.","isRequired":true,"uniqueKey":"campaign.workflow_config.oneOf.0.attempts.items.[INDEX].startTime","typeLabel":"string"},"doubleDial":{"type":"boolean","default":false,"description":"Whether to call twice back-to-back for this attempt.","uniqueKey":"campaign.workflow_config.oneOf.0.attempts.items.[INDEX].doubleDial","typeLabel":"boolean"}},"required":["day","startTime"],"uniqueKey":"campaign.workflow_config.oneOf.0.attempts.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"campaign.workflow_config.oneOf.0.attempts","typeLabel":"object[]"},"retryOutcomes":{"type":"array","description":"Call outcomes that advance a contact to the next attempt. Defaults to CALLEE_DID_NOT_PICKUP and VOICE_MAIL when omitted.","items":{"type":"string","uniqueKey":"campaign.workflow_config.oneOf.0.retryOutcomes.items.[INDEX]","typeLabel":"string"},"example":["CALLEE_DID_NOT_PICKUP","VOICE_MAIL"],"uniqueKey":"campaign.workflow_config.oneOf.0.retryOutcomes","typeLabel":"string[]"},"timezone":{"type":"string","example":"America/Los_Angeles","description":"Optional IANA timezone for workflow attempt times. Inherits the campaign timezone when omitted.","uniqueKey":"campaign.workflow_config.oneOf.0.timezone","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"campaign.workflow_config.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"campaign.workflow_config.oneOf.1","typeLabel":"null"}],"uniqueKey":"campaign.workflow_config","typeLabel":"object | null"},"total_calls":{"type":"integer","uniqueKey":"campaign.total_calls","typeLabel":"integer"},"created_at":{"type":"string","format":"date-time","uniqueKey":"campaign.created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"type":"string","format":"date-time","uniqueKey":"campaign.updated_at","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"campaign","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":true,"campaign":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","name":"\u003cstring>","status":"\u003cstring>","script_id":"\u003cstring>","file_upload_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","api_contacts_enabled":true,"campaign_timezone":"\u003cstring>","working_hours":{"weekly":{"monday":[{"start":"09:00","end":"17:00"}],"tuesday":[{"start":"09:00","end":"17:00"}],"wednesday":[{"start":"09:00","end":"17:00"}],"thursday":[{"start":"09:00","end":"17:00"}],"friday":[{"start":"09:00","end":"17:00"}],"saturday":[{"start":"09:00","end":"17:00"}],"sunday":[{"start":"09:00","end":"17:00"}]}},"working_hours_timezone":"\u003cstring>","scheduled_start_time":"2023-11-07T05:31:56Z","scheduled_timezone":"\u003cstring>","workflow_config":{"retryOutcomes":["CALLEE_DID_NOT_PICKUP","VOICE_MAIL"],"attempts":[{"day":0,"startTime":"00:00","doubleDial":false},{"day":1,"startTime":"16:00","doubleDial":true},{"day":3,"startTime":"10:00","doubleDial":false}],"timezone":"America/Los_Angeles"},"total_calls":123,"created_at":"2023-11-07T05:31:56Z","updated_at":"2023-11-07T05:31:56Z"}}}},"exampleType":"generated"}},"exampleType":"generated"},"a676c948-be01-49ba-885f-89fe893718d1":{"description":"Invalid request","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":false,"isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"details":{"oneOf":[{"type":"string","uniqueKey":"details.oneOf.0","typeLabel":"string"},{"type":"object","additionalProperties":true,"uniqueKey":"details.oneOf.1","typeLabel":"object"},{"type":"array","items":{"oneOf":[{}],"uniqueKey":"details.oneOf.2.items.[INDEX]","typeLabel":"any"},"uniqueKey":"details.oneOf.2","typeLabel":"any[]"},{"type":"null","uniqueKey":"details.oneOf.3","typeLabel":"null"}],"uniqueKey":"details","typeLabel":"string | object | any[] | null"},"code":{"type":"string","uniqueKey":"code","typeLabel":"string"}},"required":["success","error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":false,"error":"\u003cstring>","details":"\u003cstring>","code":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"5fdfc7a4-4458-4793-9824-c2463d18ade4":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":false,"isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"details":{"oneOf":[{"type":"string","uniqueKey":"details.oneOf.0","typeLabel":"string"},{"type":"object","additionalProperties":true,"uniqueKey":"details.oneOf.1","typeLabel":"object"},{"type":"array","items":{"oneOf":[{}],"uniqueKey":"details.oneOf.2.items.[INDEX]","typeLabel":"any"},"uniqueKey":"details.oneOf.2","typeLabel":"any[]"},{"type":"null","uniqueKey":"details.oneOf.3","typeLabel":"null"}],"uniqueKey":"details","typeLabel":"string | object | any[] | null"},"code":{"type":"string","uniqueKey":"code","typeLabel":"string"}},"required":["success","error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":false,"error":"\u003cstring>","details":"\u003cstring>","code":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"9c40b2ba-b73c-4ead-b883-3dff766edbc0":{"description":"Authenticated caller does not have access","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":false,"isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"details":{"oneOf":[{"type":"string","uniqueKey":"details.oneOf.0","typeLabel":"string"},{"type":"object","additionalProperties":true,"uniqueKey":"details.oneOf.1","typeLabel":"object"},{"type":"array","items":{"oneOf":[{}],"uniqueKey":"details.oneOf.2.items.[INDEX]","typeLabel":"any"},"uniqueKey":"details.oneOf.2","typeLabel":"any[]"},{"type":"null","uniqueKey":"details.oneOf.3","typeLabel":"null"}],"uniqueKey":"details","typeLabel":"string | object | any[] | null"},"code":{"type":"string","uniqueKey":"code","typeLabel":"string"}},"required":["success","error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":false,"error":"\u003cstring>","details":"\u003cstring>","code":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"d0c87cb4-0862-47d5-af06-60a632d4d656":{"description":"Resource not found","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":false,"isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"details":{"oneOf":[{"type":"string","uniqueKey":"details.oneOf.0","typeLabel":"string"},{"type":"object","additionalProperties":true,"uniqueKey":"details.oneOf.1","typeLabel":"object"},{"type":"array","items":{"oneOf":[{}],"uniqueKey":"details.oneOf.2.items.[INDEX]","typeLabel":"any"},"uniqueKey":"details.oneOf.2","typeLabel":"any[]"},{"type":"null","uniqueKey":"details.oneOf.3","typeLabel":"null"}],"uniqueKey":"details","typeLabel":"string | object | any[] | null"},"code":{"type":"string","uniqueKey":"code","typeLabel":"string"}},"required":["success","error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":false,"error":"\u003cstring>","details":"\u003cstring>","code":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"f3d5cbd5-975d-40f0-9bf0-b9a8f2ee7d92":{"description":"The voice agent is archived and read-only (code: agent_archived)","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":false,"isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"details":{"oneOf":[{"type":"string","uniqueKey":"details.oneOf.0","typeLabel":"string"},{"type":"object","additionalProperties":true,"uniqueKey":"details.oneOf.1","typeLabel":"object"},{"type":"array","items":{"oneOf":[{}],"uniqueKey":"details.oneOf.2.items.[INDEX]","typeLabel":"any"},"uniqueKey":"details.oneOf.2","typeLabel":"any[]"},{"type":"null","uniqueKey":"details.oneOf.3","typeLabel":"null"}],"uniqueKey":"details","typeLabel":"string | object | any[] | null"},"code":{"type":"string","uniqueKey":"code","typeLabel":"string"}},"required":["success","error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":false,"error":"\u003cstring>","details":"\u003cstring>","code":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"86a651ef-7cf6-4fb8-863f-1ff98911f18b":{"description":"Server error","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":false,"isRequired":true,"uniqueKey":"success","typeLabel":"boolean"},"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"details":{"oneOf":[{"type":"string","uniqueKey":"details.oneOf.0","typeLabel":"string"},{"type":"object","additionalProperties":true,"uniqueKey":"details.oneOf.1","typeLabel":"object"},{"type":"array","items":{"oneOf":[{}],"uniqueKey":"details.oneOf.2.items.[INDEX]","typeLabel":"any"},"uniqueKey":"details.oneOf.2","typeLabel":"any[]"},{"type":"null","uniqueKey":"details.oneOf.3","typeLabel":"null"}],"uniqueKey":"details","typeLabel":"string | object | any[] | null"},"code":{"type":"string","uniqueKey":"code","typeLabel":"string"}},"required":["success","error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":false,"error":"\u003cstring>","details":"\u003cstring>","code":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"5c12105a-6160-4f72-a261-b0bf7230898c":{"apiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key","description":"Create and manage API keys in your AgentCallback account under Dashboard > API Keys.","scopes":[]}}},"servers":{"8d8a2d8a-01a3-4b88-a28d-681948be19be":{"url":"https://www.agentcallback.com","description":"AgentCallback API server"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"x-api-key","description":"Create and manage API keys in your AgentCallback account under Dashboard > API Keys.","scopes":[]},"schema":{"title":"x-api-key","type":"string","description":"Create and manage API keys in your AgentCallback account under Dashboard > API Keys.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"apiKeyAuth","name":"x-api-key"}],"title":"apiKeyAuth"}]},"originalFileLocation":"openapi.json"},"subdomain":"agentcallback","siteName":"AgentCallback Documentation","title":"Create campaign - AgentCallback Documentation","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-05T05:36:18.596Z","originalFileLocation":"api-reference/campaigns/create-campaign.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"application-name\" content=\"AgentCallback Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/agentcallback/yvJb2oTVTKcYVU9C/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/agentcallback/yvJb2oTVTKcYVU9C/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/agentcallback/yvJb2oTVTKcYVU9C/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/agentcallback/yvJb2oTVTKcYVU9C/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/agentcallback/yvJb2oTVTKcYVU9C/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/agentcallback/yvJb2oTVTKcYVU9C/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/agentcallback/yvJb2oTVTKcYVU9C/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/agentcallback/yvJb2oTVTKcYVU9C/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/agentcallback/yvJb2oTVTKcYVU9C/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create campaign - AgentCallback Documentation\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"AgentCallback Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.agentcallback.com/api-reference/campaigns/create-campaign\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://agentcallback.mintlify.site/_mintlify/api/og/v2?division=Campaigns\u0026amp;title=Create+campaign\u0026amp;theme=f93f9f41876bb5c60e936f10\u0026amp;signature=007f99f591ed736d7ea52b4db6a8ce88a68d410c962262326f8e75a6ea4830cc\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Create campaign - AgentCallback Documentation\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://agentcallback.mintlify.site/_mintlify/api/og/v2?division=Campaigns\u0026amp;title=Create+campaign\u0026amp;theme=f93f9f41876bb5c60e936f10\u0026amp;signature=007f99f591ed736d7ea52b4db6a8ce88a68d410c962262326f8e75a6ea4830cc\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/agentcallback/yvJb2oTVTKcYVU9C/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"AgentCallback Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#2563EB\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.agentcallback.com/api-reference/campaigns/create-campaign\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/campaigns/create-campaign.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.agentcallback.com/#organization\",\"name\":\"AgentCallback Documentation\",\"url\":\"https://docs.agentcallback.com\"},{\"@type\":\"WebSite\",\"@id\":\"https://docs.agentcallback.com#website\",\"name\":\"AgentCallback Documentation\",\"url\":\"https://docs.agentcallback.com\",\"publisher\":{\"@id\":\"https://docs.agentcallback.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.agentcallback.com/api-reference/campaigns/create-campaign#webpage\",\"url\":\"https://docs.agentcallback.com/api-reference/campaigns/create-campaign\",\"name\":\"Create campaign\",\"dateModified\":\"2026-10-05T05:36:18.596Z\",\"isPartOf\":{\"@id\":\"https://docs.agentcallback.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.agentcallback.com/api-reference/campaigns/create-campaign#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.agentcallback.com/api-reference/campaigns/create-campaign#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Endpoints\",\"item\":\"https://docs.agentcallback.com/api-reference/authentication/validate-api-credentials\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Campaigns\",\"item\":\"https://docs.agentcallback.com/api-reference/campaigns/list-campaigns\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Create campaign\",\"item\":\"https://docs.agentcallback.com/api-reference/campaigns/create-campaign\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.agentcallback.com/api-reference/campaigns/create-campaign#apireference\",\"headline\":\"Create campaign\",\"name\":\"Create campaign\",\"url\":\"https://docs.agentcallback.com/api-reference/campaigns/create-campaign\",\"mainEntityOfPage\":{\"@id\":\"https://docs.agentcallback.com/api-reference/campaigns/create-campaign#webpage\"},\"dateModified\":\"2026-10-05T05:36:18.596Z\",\"publisher\":{\"@id\":\"https://docs.agentcallback.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.agentcallback.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"AgentCallback Documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"AgentCallback Documentation","nav":{"global":{"anchors":[{"anchor":"Home","icon":"house","href":"/"},{"anchor":"Get started","icon":"rocket","href":"/platform/quickstart"}]},"directory":"card","tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/platform/how-agentcallback-works"}]},{"tab":"API Reference","groups":[{"group":"Get started","icon":"key","pages":[{"title":"Introduction","href":"/api-reference/introduction"}]},{"group":"Endpoints","icon":"code","pages":[{"group":"Authentication","pages":[{"title":"Validate API credentials","deprecated":null,"version":null,"openapi":"/openapi.json get /api/validate-token","href":"/api-reference/authentication/validate-api-credentials"}]},{"group":"Calls","pages":[{"title":"Create outbound calls","deprecated":null,"version":null,"openapi":"/openapi.json post /api/make-calls","href":"/api-reference/calls/create-outbound-calls"},{"title":"Get call status","deprecated":null,"version":null,"openapi":"/openapi.json get /api/call-status/{callSid}","href":"/api-reference/calls/get-call-status"},{"title":"List calls by phone number","deprecated":null,"version":null,"openapi":"/openapi.json get /api/calls/phone/{phone_number}","href":"/api-reference/calls/list-calls-by-phone-number"},{"title":"List calls","deprecated":null,"version":null,"openapi":"/openapi.json get /api/calls","href":"/api-reference/calls/list-calls"}]},{"group":"Voice Agents","pages":[{"title":"Create voice agent","deprecated":null,"version":null,"openapi":"/openapi.json post /api/scripts","href":"/api-reference/voice-agents/create-voice-agent"},{"title":"Get voice agent","deprecated":null,"version":null,"openapi":"/openapi.json get /api/scripts/{id}","href":"/api-reference/voice-agents/get-voice-agent"},{"title":"Update voice agent","deprecated":null,"version":null,"openapi":"/openapi.json put /api/scripts/{id}","href":"/api-reference/voice-agents/update-voice-agent"},{"title":"Duplicate voice agent","deprecated":null,"version":null,"openapi":"/openapi.json post /api/scripts/{id}/duplicate","href":"/api-reference/voice-agents/duplicate-voice-agent"},{"title":"List voice agent versions","deprecated":null,"version":null,"openapi":"/openapi.json get /api/scripts/{id}/versions","href":"/api-reference/voice-agents/list-voice-agent-versions"},{"title":"Get voice agent version","deprecated":null,"version":null,"openapi":"/openapi.json get /api/scripts/{id}/versions/{versionCode}","href":"/api-reference/voice-agents/get-voice-agent-version"}]},{"group":"Campaigns","pages":[{"title":"List campaigns","description":null,"deprecated":null,"version":null,"openapi":"/openapi.json get /api/campaigns","href":"/api-reference/campaigns/list-campaigns"},{"title":"Create campaign","deprecated":null,"version":null,"openapi":"/openapi.json post /api/campaigns","href":"/api-reference/campaigns/create-campaign"},{"title":"Get campaign","description":null,"deprecated":null,"version":null,"openapi":"/openapi.json get /api/campaigns/{id}","href":"/api-reference/campaigns/get-campaign"},{"title":"Start campaign","deprecated":null,"version":null,"openapi":"/openapi.json post /api/campaigns/{id}/start","href":"/api-reference/campaigns/start-campaign"},{"title":"Pause campaign","deprecated":null,"version":null,"openapi":"/openapi.json post /api/campaigns/{id}/pause","href":"/api-reference/campaigns/pause-campaign"},{"title":"Complete campaign","deprecated":null,"version":null,"openapi":"/openapi.json post /api/campaigns/{id}/complete","href":"/api-reference/campaigns/complete-campaign"},{"title":"Retry campaign calls","deprecated":null,"version":null,"openapi":"/openapi.json post /api/campaigns/{id}/retry","href":"/api-reference/campaigns/retry-campaign-calls"},{"title":"Get campaign workflow","deprecated":null,"version":null,"openapi":"/openapi.json get /api/campaigns/{id}/workflow","href":"/api-reference/campaigns/get-campaign-workflow"},{"title":"Set campaign workflow","deprecated":null,"version":null,"openapi":"/openapi.json put /api/campaigns/{id}/workflow","href":"/api-reference/campaigns/set-campaign-workflow"},{"title":"Delete campaign workflow","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/campaigns/{id}/workflow","href":"/api-reference/campaigns/delete-campaign-workflow"},{"title":"Export campaign calls","deprecated":null,"version":null,"openapi":"/openapi.json get /api/campaigns/{id}/calls/export","href":"/api-reference/campaigns/export-campaign-calls"},{"title":"Update campaign schedule","deprecated":null,"version":null,"openapi":"/openapi.json put /api/campaigns/{id}/schedule","href":"/api-reference/campaigns/update-campaign-schedule"},{"title":"Convert campaign to draft","deprecated":null,"version":null,"openapi":"/openapi.json delete /api/campaigns/{id}/schedule","href":"/api-reference/campaigns/convert-campaign-to-draft"},{"title":"Hold campaign schedule","deprecated":null,"version":null,"openapi":"/openapi.json post /api/campaigns/{id}/hold-schedule","href":"/api-reference/campaigns/hold-campaign-schedule"},{"title":"Resume campaign schedule","deprecated":null,"version":null,"openapi":"/openapi.json post /api/campaigns/{id}/resume-schedule","href":"/api-reference/campaigns/resume-campaign-schedule"}]},{"group":"File Uploads","pages":[{"title":"List CSV uploads","deprecated":null,"version":null,"openapi":"/openapi.json get /api/file-uploads","href":"/api-reference/file-uploads/list-csv-uploads"},{"title":"Upload a CSV contact file","deprecated":null,"version":null,"openapi":"/openapi.json post /api/file-uploads","href":"/api-reference/file-uploads/upload-a-csv-contact-file"}]},{"group":"Phone Numbers","pages":[{"title":"List phone numbers","deprecated":null,"version":null,"openapi":"/openapi.json get /api/organization-phone-numbers","href":"/api-reference/phone-numbers/list-phone-numbers"},{"title":"Get phone number","deprecated":null,"version":null,"openapi":"/openapi.json get /api/organization-phone-numbers/{id}","href":"/api-reference/phone-numbers/get-phone-number"}]},{"group":"Voices","pages":[{"title":"List voices","deprecated":null,"version":null,"openapi":"/openapi.json get /api/voices","href":"/api-reference/voices/list-voices"},{"title":"Get voice","deprecated":null,"version":null,"openapi":"/openapi.json get /api/voices/{voiceId}","href":"/api-reference/voices/get-voice"},{"title":"Get voice preview audio","deprecated":null,"version":null,"openapi":"/openapi.json get /api/voices/{voiceId}/preview","href":"/api-reference/voices/get-voice-preview-audio"}]}]}]}]},"basePath":"","title":"Create campaign - AgentCallback Documentation","buildId":"dpl_DTau1J5HqS9UTgVSDwGksstFWtPa","deploymentId":"dpl_DTau1J5HqS9UTgVSDwGksstFWtPa","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-5FCzAcfS.js","utils-SLtAG4EZ.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-2DZi8ZMu.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-D7J3nkzE.js","snippetPresets-D0Alv0AH.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","Page-D9ithiIZ.js","ApiExamples-BI4qNJ2c.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BD3uyr8j.js","shallow-D8iEBr5z.js","getApiPlaygroundDisplay-CgNP4lzR.js","CodeSnippet-CX-QHuMs.js","CodeSnippets-VlXE-ZUf.js","getPastedJson-DYNQkZ1M.js","icon-CzacdwOi.js","MethodPill-2JVqoYKi.js","DuplicateIcon-_xVXs-U8.js","createIcon-BRHrweLo.js","DynamicMarkdown-mQG_iQiE.js","SectionHeading-DMpJzv8f.js","axios-vUo_bRtp.js","Markdown-5FGIym-8.js","clsx-D-TRO5q5.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CdrJecqK.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-CHlcWBLM.js"]}