Provider-native ID of the voice assistant. Required when config.mode includes 'voice'.
Example:
"asst_abc123"
chat_assistant_id
string
Provider-native ID of the chat assistant. Required when config.mode includes 'chat'.
Example:
"asst_chat123"
Response
Web widget created successfully. Returns widget ID, campaign ID, and configuration.
status
string
Example:
"success"
message
string
Example:
"Web widget created successfully"
data
object
Show child attributes
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"VoiceAIWrapper","description":"VoiceAIWrapper Docs","colors":{"primary":"#0B5CFF","light":"#4D8FFF","dark":"#094ACC"},"logo":{"light":"https://mintcdn.com/supafunnel/DKNI5GtlE4iCGz-8/logos/logo-black.png?fit=max\u0026auto=format\u0026n=DKNI5GtlE4iCGz-8\u0026q=85\u0026s=f0b7526597a0673902ae0e4bf3fec499","dark":"https://mintcdn.com/supafunnel/DKNI5GtlE4iCGz-8/logos/logo-white.png?fit=max\u0026auto=format\u0026n=DKNI5GtlE4iCGz-8\u0026q=85\u0026s=eb4ccb9c83526a01d2f6e8326200af7d"},"favicon":"https://mintcdn.com/supafunnel/3wItPkcmr5tq6xUZ/favicon.png?fit=max\u0026auto=format\u0026n=3wItPkcmr5tq6xUZ\u0026q=85\u0026s=3f402e51253e48bc19c79be7dd669a08","api":{"playground":{"display":"interactive"},"mdx":{"auth":{"method":"bearer"},"server":"https://api.voiceaiwrapper.app"}},"appearance":{"default":"light"},"background":{"color":{"dark":"#0d0d0d"}},"navbar":{"links":[{"href":"/general/support","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://dashboard.voiceaiwrapper.app"}},"footer":{"socials":{"x":"https://x.com/voiceaiwrapper","linkedin":"https://linkedin.com/company/voiceaiwrapper"}},"icons":{"library":"lucide"},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"API Reference","icon":"code","href":"/api-reference/authentication"},{"anchor":"Dashboard","icon":"monitor","href":"https://dashboard.voiceaiwrapper.app"},{"anchor":"Support","icon":"headset","href":"/general/support"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"supafunnel","hasAudioNarration":false,"actualSubdomain":"supafunnel","customDomains":["docs.voiceaiwrapper.app"],"gitSource":{"type":"github","owner":"supafunnel-co","repo":"voice-ai-wrapper-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true},"entitlements":{},"buildId":"6ad20bd17414c95fc10f4a9e","clientVersion":"0.0.4167","searchFilterCounts":[{"language":"default","tag":"Documentation","count":30},{"language":"default","tag":"API reference","count":29},{"language":"default","tag":"MCP server","count":16},{"language":"default","tag":"External Billing","count":13},{"language":"default","tag":"Leads (v2)","count":7},{"language":"default","tag":"Billing","count":7},{"language":"default","tag":"Tools","count":7},{"language":"default","tag":"Web Widget","count":7},{"language":"default","tag":"Headless Mode (Bring your own UI)","count":7},{"language":"default","tag":"Campaigns","count":3}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":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":"custom-rbac-roles","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":"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":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/web-widgets/create-web-widget","slug":"/api-reference/web-widgets/create-web-widget","pageMetadata":{"title":"Create Web Widget","openapi":"POST /api/v2/web-widgets","description":"Creates a new web widget for an inbound campaign.\n\n## Authentication\nAll requests require an `Authorization` header using Bearer token authentication:\n`Authorization: Bearer \u003capi_key>`","href":"/api-reference/web-widgets/create-web-widget"},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n h2: \"h2\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Creates a new web widget for an inbound campaign.\"\n }), \"\\n\", _jsx(_components.h2, {\n children: \"Authentication\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"All requests require an \", _jsx(_components.code, {\n children: \"Authorization\"\n }), \" header using Bearer token authentication:\\n\", _jsx(_components.code, {\n children: \"Authorization: Bearer \u003capi_key>\"\n })]\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"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 Web Widget","openapi":"POST /api/v2/web-widgets","description":"Creates a new web widget for an inbound campaign.\n\n## Authentication\nAll requests require an `Authorization` header using Bearer token authentication:\n`Authorization: Bearer \u003capi_key>`","href":"/api-reference/web-widgets/create-web-widget"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"createWebWidget","summary":"Create Web Widget","description":"Creates a new web widget for an inbound campaign.\n\n## Authentication\nAll requests require an `Authorization` header using Bearer token authentication:\n`Authorization: Bearer \u003capi_key>`","tags":["Web Widgets"],"requestBody":"e13b893a-781c-4c15-b212-8bc649f2cc2b","responses":{"201":"b6f1acc9-98bd-42ab-ad9a-1f0b3167940a","400":"a242bd1e-4c94-43a7-9189-21e68bcf9b3e","401":"ded77709-8f62-4dc7-85b1-732b29b3ef4a","404":"dd7ad495-957b-4043-a070-eef56a89f6fa","409":"7124baf3-66ed-4141-8a93-f0fdf4f50098","500":"c6088220-9fd7-42d0-8afd-9ed6264e4ecc"},"method":"post","type":"path","servers":["a5e87327-c278-4683-9e5f-f2fc0f39259e"],"security":["ade46c66-9612-417e-8d95-0e1947973bba"],"path":"/api/v2/web-widgets","baseUrlOptions":["https://api.voiceaiwrapper.app"],"title":"Create Web Widget","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"description":"Web widget configuration","content":{"application/json":{"schema":{"type":"object","required":["voice_campaign_id","config"],"properties":{"voice_campaign_id":{"type":"string","description":"Global ID of the inbound campaign for this widget. Required.","example":"Vm9pY2VDYW1wYWlnbjoxMjM=","isRequired":true,"uniqueKey":"voice_campaign_id","typeLabel":"string"},"config":{"type":"object","description":"Widget appearance and behaviour configuration. Required. All fields inside config are optional and will use defaults if not provided.","properties":{"mode":{"type":"array","items":{"type":"string","enum":["voice","chat"],"uniqueKey":"config.mode.items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"Array of enabled interaction modes. Optional. Default: `[\"voice\"]`. Valid values: `\"voice\"`, `\"chat\"`.","default":["voice"],"example":["voice"],"uniqueKey":"config.mode","typeLabel":"enum\u003cstring>[]"},"style":{"type":"string","enum":["card","compact"],"description":"Widget style. Optional. Default: `\"card\"`. Valid values: `\"card\"`, `\"compact\"`.","default":"card","example":"card","uniqueKey":"config.style","typeLabel":"enum\u003cstring>"},"theme":{"type":"string","enum":["light","dark"],"description":"Color theme. Optional. Default: `\"light\"`. Valid values: `\"light\"`, `\"dark\"`.","default":"light","example":"light","uniqueKey":"config.theme","typeLabel":"enum\u003cstring>"},"backgroundColor":{"type":"string","description":"Background color in hex format. Optional. Default: `\"#ffffff\"`.","default":"#ffffff","example":"#ffffff","uniqueKey":"config.backgroundColor","typeLabel":"string"},"textColor":{"type":"string","description":"Text color in hex format. Optional. Default: `\"#000000\"`.","default":"#000000","example":"#000000","uniqueKey":"config.textColor","typeLabel":"string"},"accentColor":{"type":"string","description":"Accent color in hex format. Optional. Default: `\"#3b82f6\"`.","default":"#3b82f6","example":"#3b82f6","uniqueKey":"config.accentColor","typeLabel":"string"},"ctaButtonColor":{"type":"string","description":"CTA button color in hex format. Optional. Default: `\"#3b82f6\"`.","default":"#3b82f6","example":"#3b82f6","uniqueKey":"config.ctaButtonColor","typeLabel":"string"},"footerTextColor":{"type":"string","description":"Footer text color in hex format. Optional. Default: `\"#666666\"`.","default":"#666666","example":"#666666","uniqueKey":"config.footerTextColor","typeLabel":"string"},"chatEndCallButtonColor":{"type":"string","description":"Chat end call button color in hex format. Optional. Default: `\"#ef4444\"`.","default":"#ef4444","example":"#ef4444","uniqueKey":"config.chatEndCallButtonColor","typeLabel":"string"},"chatConnectedStatusColor":{"type":"string","description":"Chat connected status indicator color in hex format. Optional. Default: `\"#22c55e\"`.","default":"#22c55e","example":"#22c55e","uniqueKey":"config.chatConnectedStatusColor","typeLabel":"string"},"animationStyle":{"type":"string","enum":["default","glob","siri"],"description":"Animation style for the widget. Optional. Default: `\"default\"`. Valid values: `\"default\"`, `\"glob\"`, `\"siri\"`.","default":"default","example":"default","uniqueKey":"config.animationStyle","typeLabel":"enum\u003cstring>"},"logo":{"type":"string","format":"uri","description":"URL to the logo image displayed in the widget. Optional.","example":"https://example.com/logo.png","uniqueKey":"config.logo","typeLabel":"string\u003curi>"},"icon":{"type":"string","enum":["activity","airplay","alertCircle","alertOctagon","alertTriangle","alignCenter","alignJustify","alignLeft","alignRight","anchor","aperture","archive","archiveRestore","arrowDown","arrowDownCircle","arrowDownLeft","arrowDownRight","arrowLeft","arrowLeftCircle","arrowLeftRight","arrowRight","arrowRightCircle","arrowUp","arrowUpCircle","arrowUpDown","arrowUpLeft","arrowUpRight","atSign","award","barChart","barChart2","barChart3","barChart4","battery","batteryCharging","batteryFull","batteryLow","batteryMedium","bell","bellOff","bellRing","bike","binary","bluetooth","bluetoothConnected","bluetoothOff","bluetoothSearching","bold","book","bookOpen","bookmark","bot","box","briefcase","building","building2","bus","calculator","calendar","calendarCheck","calendarClock","calendarDays","calendarHeart","calendarMinus","calendarOff","calendarPlus","calendarRange","calendarSearch","calendarX","camera","cameraOff","car","carrot","cast","check","checkCircle","checkCircle2","checkSquare","checkSquare2","chevronDown","chevronFirst","chevronLast","chevronLeft","chevronRight","chevronUp","chevronsDown","chevronsDownUp","chevronsLeft","chevronsLeftRight","chevronsRight","chevronsRightLeft","chevronsUp","chevronsUpDown","circle","circleDot","circleEllipsis","circleOff","circleSlashed","circleSlash","clipboard","clipboardCheck","clipboardCopy","clipboardEdit","clipboardList","clipboardSignature","clipboardType","clipboardX","clock","clock1","clock10","clock11","clock12","clock2","clock3","clock4","clock5","clock6","clock7","clock8","clock9","cloud","cloudCog","cloudDrizzle","cloudFog","cloudHail","cloudLightning","cloudMoon","cloudMoonRain","cloudOff","cloudRain","cloudRainWind","cloudSnow","cloudSun","cloudSunRain","cloudy","clover","code","code2","coffee","cog","coins","columns","command","compass","component","conciergeBell","contact","contact2","container","contrast","cookie","copy","copyleft","copyright","creditCard","croissant","crop","cross","crosshair","crown","cupSoda","currency","database","delete","dessert","diameter","diamond","dice1","dice2","dice3","dice4","dice5","dice6","dices","diff","disc","divide","divideCircle","divideSquare","dna","dnaOff","dog","dollarSign","download","downloadCloud","droplets","dumbbell","ear","earOff","edit","edit2","edit3","egg","eggFried","eggOff","equal","equalNot","eraser","euro","expand","externalLink","eye","eyeOff","factory","fan","fastForward","feather","file","fileArchive","fileAudio","fileAudio2","fileAxis3d","fileBadge","fileBadge2","fileBarChart","fileBarChart2","fileBox","fileCheck","fileCheck2","fileClock","fileCode","fileCode2","fileCog","fileCog2","fileDiff","fileDigit","fileDown","fileEdit","fileHeart","fileImage","fileInput","fileJson","fileJson2","fileKey","fileKey2","fileLineChart","fileLock","fileLock2","fileMinus","fileMinus2","fileOutput","filePieChart","filePlus","filePlus2","fileQuestion","fileScan","fileSearch","fileSearch2","fileSignature","fileSpreadsheet","fileSymlink","fileTerminal","fileText","fileType","fileType2","fileUp","fileVideo","fileVideo2","fileVolume","fileVolume2","fileWarning","fileX","fileX2","files","film","filter","fingerprint","fish","fishOff","flag","flagOff","flagTriangleLeft","flagTriangleRight","flame","flashlight","flashlightOff","flaskConical","flaskRound","flipHorizontal","flipHorizontal2","flipVertical","flipVertical2","flower","flower2","focus","folder","folderArchive","folderCheck","folderClock","folderClosed","folderCog","folderCog2","folderDown","folderEdit","folderHeart","folderInput","folderKey","folderLock","folderMinus","folderOpen","folderOutput","folderPlus","folderSearch","folderSearch2","folderSymlink","folderTree","folderUp","folderX","folders","formInput","forward","frame","frown","fuel","functionSquare","gamepad","gamepad2","gauge","gavel","gem","ghost","gift","gitBranch","gitBranchPlus","gitCommit","gitCompare","gitFork","gitMerge","gitPullRequest","globe","globe2","grab","graduationCap","grape","grid","gripHorizontal","gripVertical","hammer","hand","handMetal","hardDrive","hardHat","hash","haze","headphones","headset","heart","heartCrack","heartHandshake","heartOff","heartPulse","helpCircle","hexagon","highlighter","history","home","hop","hopOff","hotel","hourglass","iceCream","iceCream2","image","imageMinus","imageOff","imagePlus","import","inbox","indent","indianRupee","infinity","info","inspect","instagram","italic","japaneseYen","joystick","key","keyboard","lamp","lampCeiling","lampDesk","lampFloor","lampWallDown","lampWallUp","landmark","languages","laptop","laptop2","lasso","lassoSelect","laugh","layers","layout","layoutDashboard","layoutGrid","layoutList","layoutTemplate","leaf","library","lifeBuoy","lightbulb","lightbulbOff","lineChart","link","link2","link2Off","list","listChecks","listEnd","listMinus","listMusic","listOrdered","listPlus","listStart","listVideo","listX","loader","loader2","locate","locateFixed","locateOff","lock","lockKeyhole","logIn","logOut","luggage","magnet","mail","mailCheck","mailMinus","mailOpen","mailPlus","mailQuestion","mailSearch","mailWarning","mailX","mails","map","mapPin","mapPinOff","martini","maximize","maximize2","medal","megaphone","megaphoneOff","meh","menu","messageCircle","messageSquare","messagesSquare","mic","mic2","micOff","microscope","milestone","milk","milkOff","minimize","minimize2","minus","minusCircle","minusSquare","monitor","monitorOff","monitorSpeaker","moon","moreHorizontal","moreVertical","mountain","mountainSnow","mouse","mousePointer","mousePointer2","mousePointerClick","move","move3d","moveHorizontal","moveVertical","music","music2","music3","music4","navigation","navigation2","navigation2Off","network","newspaper","octagon","option","outdent","package","package2","packageCheck","packageMinus","packageOpen","packagePlus","packageSearch","packageX","paintBucket","paintbrush","paintbrush2","palette","palmtree","paperclip","partyPopper","pause","pauseCircle","pauseOctagon","penTool","percent","personStanding","phone","phoneCall","phoneForwarded","phoneIncoming","phoneMissed","phoneOff","phoneOutgoing","pi","piSquare","pictureInPicture","pictureInPicture2","pieChart","piggyBank","pilcrow","pilcrowSquare","pill","pin","pinOff","pipette","pizza","plane","play","playCircle","playSquare","plug","plug2","plugZap","plus","plusCircle","plusSquare","podcast","pointer","poundSterling","power","powerOff","printer","puzzle","qrCode","quote","radio","radioReceiver","radioTower","rat","receipt","rectangleHorizontal","rectangleVertical","recycle","redo","redo2","refreshCcw","refreshCw","refrigerator","regex","removeFormatting","repeat","repeat1","replace","replaceAll","reply","replyAll","rewind","rocket","rockingChair","rotate3d","rotateCcw","rotateCw","rss","ruler","russianRuble","sailboat","salad","save","scale","scale3d","scaling","scan","scanFace","scanLine","scissors","screenShare","screenShareOff","scroll","scrollText","search","searchSlash","searchX","send","separatorHorizontal","separatorVertical","server","serverCog","serverCrash","serverOff","settings","settings2","share","share2","sheet","shield","shieldAlert","shieldCheck","shieldClose","shieldOff","shieldQuestion","ship","shirt","shoppingBag","shoppingCart","shovel","showerHead","shrink","shrub","shuffle","sidebar","sidebarClose","sidebarOpen","sigma","sigmaSquare","signal","signalHigh","signalLow","signalMedium","signalZero","skipBack","skipForward","skull","slack","slash","slice","sliders","slidersHorizontal","smartphone","smile","snowflake","sofa","sortAsc","sortDesc","soup","speaker","spline","split","splitSquareHorizontal","splitSquareVertical","sprout","square","squareAsterisk","squareDot","squareEqual","squareSlash","stamp","star","starOff","stepBack","stepForward","stethoscope","sticker","stickyNote","stopCircle","store","stretchHorizontal","stretchVertical","strikethrough","subscript","sun","sunDim","sunMedium","sunMoon","sunSnow","sunrise","sunset","superscript","swissFranc","switchCamera","sword","swords","syringe","table","table2","tableProperties","tablet","tablets","tag","tags","target","tent","terminal","terminalSquare","testTube","testTube2","textCursor","textCursorInput","textQuote","textSelect","thermometer","thermometerSnowflake","thermometerSun","thumbsDown","thumbsUp","ticket","timer","timerOff","timerReset","toggleLeft","toggleRight","tornado","toyBrick","train","trash","trash2","treeDeciduous","treePine","trees","trendingDown","trendingUp","triangle","trophy","truck","tv","tv2","type","umbrella","underline","undo","undo2","unlink","unlink2","unlock","unlockKeyhole","upload","uploadCloud","usb","user","userCheck","userCog","userMinus","userPlus","userX","users","utensils","utensilsCrossed","verified","vibrate","vibrateOff","video","videoOff","view","voicemail","volume","volume1","volume2","volumeX","vote","wallet","wallet2","watch","waves","webcam","webhook","wifi","wifiOff","wind","wine","wineOff","wrapText","wrench","x","xCircle","xOctagon","xSquare","zap","zapOff","zoomIn","zoomOut"],"description":"Icon identifier for the widget launcher button. Optional. Default: `\"phone\"`. Must be one of the supported Lucide icon names listed in the enum.","default":"phone","example":"phone","uniqueKey":"config.icon","typeLabel":"enum\u003cstring>"},"position":{"type":"string","enum":["bottom-right","bottom-left","top-right","top-left"],"description":"Widget position on the page. Optional. Default: `\"bottom-right\"`. Valid values: `\"bottom-right\"`, `\"bottom-left\"`, `\"top-right\"`, `\"top-left\"`.","default":"bottom-right","example":"bottom-right","uniqueKey":"config.position","typeLabel":"enum\u003cstring>"},"borderRadius":{"type":"string","enum":["none","small","medium","large"],"description":"Border radius of the widget. Optional. Default: `\"medium\"`. Valid values: `\"none\"`, `\"small\"`, `\"medium\"`, `\"large\"`.","default":"medium","example":"medium","uniqueKey":"config.borderRadius","typeLabel":"enum\u003cstring>"},"ctaBorderRadius":{"type":"string","enum":["none","small","medium","large","full"],"description":"Border radius of the CTA button. Optional. Default: `\"medium\"`. Valid values: `\"none\"`, `\"small\"`, `\"medium\"`, `\"large\"`, `\"full\"`.","default":"medium","example":"medium","uniqueKey":"config.ctaBorderRadius","typeLabel":"enum\u003cstring>"},"size":{"type":"string","enum":["tiny","compact","large"],"description":"Widget size. Optional. Default: `\"compact\"`. Valid values: `\"tiny\"`, `\"compact\"`, `\"large\"`.","default":"compact","example":"compact","uniqueKey":"config.size","typeLabel":"enum\u003cstring>"},"title":{"type":"string","description":"Widget title text. Optional. Default: `\"AI Assistant\"`.","default":"AI Assistant","example":"AI Assistant","uniqueKey":"config.title","typeLabel":"string"},"subtitle":{"type":"string","description":"Widget subtitle text shown below the title. Optional. Default: `\"Get instant help from our AI\"`.","default":"Get instant help from our AI","example":"Get instant help from our AI","uniqueKey":"config.subtitle","typeLabel":"string"},"ctaButtonText":{"type":"string","description":"Text displayed on the CTA button. Optional. Default: `\"Start Conversation\"`.","default":"Start Conversation","example":"Start Conversation","uniqueKey":"config.ctaButtonText","typeLabel":"string"},"chatPlaceholder":{"type":"string","description":"Placeholder text for the chat input field. Optional. Default: `\"Type your message...\"`.","default":"Type your message...","example":"Type your message...","uniqueKey":"config.chatPlaceholder","typeLabel":"string"},"chatFirstMessage":{"type":"string","description":"First message shown in the chat window when a conversation starts. Optional. Default: `\"Hello! How can I help you today?\"`.","default":"Hello! How can I help you today?","example":"Hello! How can I help you today?","uniqueKey":"config.chatFirstMessage","typeLabel":"string"},"chatConnectedText":{"type":"string","description":"Text shown when the chat session is connected. Optional. Default: `\"Connected\"`.","default":"Connected","example":"Connected","uniqueKey":"config.chatConnectedText","typeLabel":"string"},"chatEndButtonText":{"type":"string","description":"Text on the chat end button. Optional. Default: `\"End\"`.","default":"End","example":"End","uniqueKey":"config.chatEndButtonText","typeLabel":"string"},"chatStartingText":{"type":"string","description":"Text shown while the chat session is initialising. Optional. Default: `\"Starting conversation...\"`.","default":"Starting conversation...","example":"Starting conversation...","uniqueKey":"config.chatStartingText","typeLabel":"string"},"chatConnectingText":{"type":"string","description":"Text shown while the chat is connecting. Optional. Default: `\"Connecting...\"`.","default":"Connecting...","example":"Connecting...","uniqueKey":"config.chatConnectingText","typeLabel":"string"},"chatStartConversationText":{"type":"string","description":"Prompt text to start a chat conversation. Optional. Default: `\"Start a conversation\"`.","default":"Start a conversation","example":"Start a conversation","uniqueKey":"config.chatStartConversationText","typeLabel":"string"},"chatTypeToStartText":{"type":"string","description":"Helper text shown before the user types the first message. Optional. Default: `\"Type a message to start chatting\"`.","default":"Type a message to start chatting","example":"Type a message to start chatting","uniqueKey":"config.chatTypeToStartText","typeLabel":"string"},"chatInactivityTimeoutMinutes":{"type":"integer","minimum":1,"maximum":60,"description":"Minutes of inactivity before the chat session ends automatically. Optional. Default: `3`. Range: 1–60.","default":3,"example":3,"uniqueKey":"config.chatInactivityTimeoutMinutes","typeLabel":"integer"},"modeSelectionText":{"type":"string","description":"Prompt text shown when both voice and chat modes are enabled and the user must choose. Optional. Default: `\"How would you like to interact?\"`.","default":"How would you like to interact?","example":"How would you like to interact?","uniqueKey":"config.modeSelectionText","typeLabel":"string"},"voiceStartButtonText":{"type":"string","description":"Text on the voice start button. Optional. Default: `\"Start Voice Call\"`.","default":"Start Voice Call","example":"Start Voice Call","uniqueKey":"config.voiceStartButtonText","typeLabel":"string"},"voiceEndButtonText":{"type":"string","description":"Text on the voice end/hang-up button. Optional. Default: `\"End Call\"`.","default":"End Call","example":"End Call","uniqueKey":"config.voiceEndButtonText","typeLabel":"string"},"permissionDeniedMessage":{"type":"string","description":"Message shown when the user denies microphone permission. Optional.","example":"Microphone access is required for voice calls.","uniqueKey":"config.permissionDeniedMessage","typeLabel":"string"},"permissionPromptMessage":{"type":"string","description":"Message shown when requesting microphone permission. Optional.","example":"Please allow microphone access to start a voice call.","uniqueKey":"config.permissionPromptMessage","typeLabel":"string"},"footerText":{"type":"string","description":"Footer text displayed at the bottom of the widget. Optional.","example":"Powered by VoiceAI","uniqueKey":"config.footerText","typeLabel":"string"},"enableConsent":{"type":"boolean","description":"When true, shows a consent/privacy popup before the user can interact. Optional. Default: `true`.","default":true,"example":true,"uniqueKey":"config.enableConsent","typeLabel":"boolean"},"consentTitle":{"type":"string","description":"Title of the consent popup. Optional. Default: `\"Privacy Notice\"`.","default":"Privacy Notice","example":"Privacy Notice","uniqueKey":"config.consentTitle","typeLabel":"string"},"consentText":{"type":"string","description":"Body text of the consent popup. Optional. Defaults to a standard privacy notice.","example":"By continuing, you agree to our privacy policy and terms of service.","uniqueKey":"config.consentText","typeLabel":"string"},"consentAcceptButtonText":{"type":"string","description":"Text on the consent accept button. Optional. Default: `\"Accept\"`.","default":"Accept","example":"Accept","uniqueKey":"config.consentAcceptButtonText","typeLabel":"string"},"consentCancelButtonText":{"type":"string","description":"Text on the consent cancel/decline button. Optional. Default: `\"Cancel\"`.","default":"Cancel","example":"Cancel","uniqueKey":"config.consentCancelButtonText","typeLabel":"string"},"localStorageKey":{"type":"string","description":"LocalStorage key used to persist the user's consent decision. Optional. Default: `\"ai-widget-consent\"`.","default":"ai-widget-consent","example":"ai-widget-consent","uniqueKey":"config.localStorageKey","typeLabel":"string"}},"example":{"mode":["voice"],"theme":"light","position":"bottom-right","title":"AI Assistant","subtitle":"Get instant help from our AI","ctaButtonText":"Start Conversation","accentColor":"#3b82f6","ctaButtonColor":"#3b82f6"},"isRequired":true,"uniqueKey":"config","typeLabel":"object"},"voice_assistant_id":{"type":"string","description":"Provider-native ID of the voice assistant. Required when config.mode includes 'voice'.","example":"asst_abc123","uniqueKey":"voice_assistant_id","typeLabel":"string"},"chat_assistant_id":{"type":"string","description":"Provider-native ID of the chat assistant. Required when config.mode includes 'chat'.","example":"asst_chat123","uniqueKey":"chat_assistant_id","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"voice_campaign_id":"Vm9pY2VDYW1wYWlnbjoxMjM=","config":{"mode":["voice"],"theme":"light","position":"bottom-right","title":"AI Assistant","subtitle":"Get instant help from our AI","ctaButtonText":"Start Conversation","accentColor":"#3b82f6","ctaButtonColor":"#3b82f6"},"voice_assistant_id":"asst_abc123","chat_assistant_id":"asst_chat123"}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"b6f1acc9-98bd-42ab-ad9a-1f0b3167940a":{"description":"Web widget created successfully. Returns widget ID, campaign ID, and configuration.","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","example":"success","uniqueKey":"status","typeLabel":"string"},"message":{"type":"string","example":"Web widget created successfully","uniqueKey":"message","typeLabel":"string"},"data":{"type":"object","properties":{"web_widget_id":{"type":"string","uniqueKey":"data.web_widget_id","typeLabel":"string"},"voice_campaign_id":{"type":"string","uniqueKey":"data.voice_campaign_id","typeLabel":"string"},"config":{"type":"object","uniqueKey":"data.config","typeLabel":"object"},"created_at":{"type":"string","format":"date-time","uniqueKey":"data.created_at","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"data","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status":"success","message":"Web widget created successfully","data":{"web_widget_id":"\u003cstring>","voice_campaign_id":"\u003cstring>","config":{},"created_at":"2023-11-07T05:31:56Z"}}}},"exampleType":"generated"}},"exampleType":"generated"},"a242bd1e-4c94-43a7-9189-21e68bcf9b3e":{"description":"Invalid request data. Common causes: missing required fields, invalid config values, outbound campaign, or assistant validation failure.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","uniqueKey":"message","typeLabel":"string"},"errors":{"type":"array","items":{"type":"string","uniqueKey":"errors.items.[INDEX]","typeLabel":"string"},"uniqueKey":"errors","typeLabel":"string[]"}},"uniqueKey":"","typeLabel":"object"},"example":{"message":"Invalid data","errors":["campaign ID is missing: voice_campaign_id"]},"examples":{"Example":{"title":"Example","value":{"message":"Invalid data","errors":["campaign ID is missing: voice_campaign_id"]}}},"exampleType":"examples"}},"exampleType":"examples"},"ded77709-8f62-4dc7-85b1-732b29b3ef4a":{"description":"Authentication failed. Ensure the Bearer token is present and valid.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"dd7ad495-957b-4043-a070-eef56a89f6fa":{"description":"Resource not found. The voice_campaign_id does not exist or does not belong to your tenant.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","uniqueKey":"message","typeLabel":"string"},"errors":{"type":"array","items":{"type":"string","uniqueKey":"errors.items.[INDEX]","typeLabel":"string"},"uniqueKey":"errors","typeLabel":"string[]"}},"uniqueKey":"","typeLabel":"object"},"example":{"message":"campaign not found or does not belong to this tenant","errors":["Invalid voice_campaign_id"]},"examples":{"Example":{"title":"Example","value":{"message":"campaign not found or does not belong to this tenant","errors":["Invalid voice_campaign_id"]}}},"exampleType":"examples"}},"exampleType":"examples"},"7124baf3-66ed-4141-8a93-f0fdf4f50098":{"description":"Conflict. A web widget already exists for this campaign.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","uniqueKey":"message","typeLabel":"string"},"errors":{"type":"array","items":{"type":"string","uniqueKey":"errors.items.[INDEX]","typeLabel":"string"},"uniqueKey":"errors","typeLabel":"string[]"}},"uniqueKey":"","typeLabel":"object"},"example":{"message":"A web widget already exists for this campaign","errors":["Duplicate web widget"]},"examples":{"Example":{"title":"Example","value":{"message":"A web widget already exists for this campaign","errors":["Duplicate web widget"]}}},"exampleType":"examples"}},"exampleType":"examples"},"c6088220-9fd7-42d0-8afd-9ed6264e4ecc":{"description":"Internal server error. Contact support if this persists.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"ade46c66-9612-417e-8d95-0e1947973bba":{"bearerAuth":{"type":"http","scheme":"bearer","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"a5e87327-c278-4683-9e5f-f2fc0f39259e":{"url":"https://api.voiceaiwrapper.app"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"supafunnel","siteName":"VoiceAIWrapper","title":"Create Web Widget - VoiceAIWrapper","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-04-24T08:09:30.557Z","originalFileLocation":"api-reference/web-widgets/create-web-widget.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=\"light\"}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=\"description\" content=\"Creates a new web widget for an inbound campaign. ## Authentication All requests require an Authorization header using Bearer token authentication: Authorization: Bearer\">\u003cmeta data-mint-head name=\"application-name\" content=\"VoiceAIWrapper\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/supafunnel/-JJo1zQ6gdVoBi-k/_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/supafunnel/-JJo1zQ6gdVoBi-k/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/supafunnel/-JJo1zQ6gdVoBi-k/_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/supafunnel/-JJo1zQ6gdVoBi-k/_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/supafunnel/-JJo1zQ6gdVoBi-k/_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/supafunnel/-JJo1zQ6gdVoBi-k/_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/supafunnel/-JJo1zQ6gdVoBi-k/_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/supafunnel/-JJo1zQ6gdVoBi-k/_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/supafunnel/-JJo1zQ6gdVoBi-k/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create Web Widget - VoiceAIWrapper\">\u003cmeta data-mint-head property=\"og:description\" content=\"Creates a new web widget for an inbound campaign. ## Authentication All requests require an Authorization header using Bearer token authentication: Authorization: Bearer\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"VoiceAIWrapper\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.voiceaiwrapper.app/api-reference/web-widgets/create-web-widget\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://supafunnel.mintlify.site/_mintlify/api/og/v2?division=Web+Widgets\u0026amp;title=Create+Web+Widget\u0026amp;description=Creates+a+new+web+widget+for+an+inbound+campaign.%0A%0A%23%23+Authentication%0AAll+requests+require+an+%60Authorization%60+header+using+Bearer+token+authentication%3A%0A%60Authoriz\u0026amp;theme=516b39465ba7b446e5e894ee\u0026amp;signature=b20a55a95a50488bef816449bc34faa78392c63941e92c5638f2df9a64775590\">\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 Web Widget - VoiceAIWrapper\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Creates a new web widget for an inbound campaign. ## Authentication All requests require an Authorization header using Bearer token authentication: Authorization: Bearer\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://supafunnel.mintlify.site/_mintlify/api/og/v2?division=Web+Widgets\u0026amp;title=Create+Web+Widget\u0026amp;description=Creates+a+new+web+widget+for+an+inbound+campaign.%0A%0A%23%23+Authentication%0AAll+requests+require+an+%60Authorization%60+header+using+Bearer+token+authentication%3A%0A%60Authoriz\u0026amp;theme=516b39465ba7b446e5e894ee\u0026amp;signature=b20a55a95a50488bef816449bc34faa78392c63941e92c5638f2df9a64775590\">\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/supafunnel/-JJo1zQ6gdVoBi-k/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"VoiceAIWrapper\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0B5CFF\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.voiceaiwrapper.app/api-reference/web-widgets/create-web-widget\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/web-widgets/create-web-widget.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.voiceaiwrapper.app/#organization\",\"name\":\"VoiceAIWrapper\",\"url\":\"https://docs.voiceaiwrapper.app\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/supafunnel/DKNI5GtlE4iCGz-8/logos/logo-black.png?fit=max\u0026auto=format\u0026n=DKNI5GtlE4iCGz-8\u0026q=85\u0026s=f0b7526597a0673902ae0e4bf3fec499\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.voiceaiwrapper.app#website\",\"name\":\"VoiceAIWrapper\",\"url\":\"https://docs.voiceaiwrapper.app\",\"publisher\":{\"@id\":\"https://docs.voiceaiwrapper.app/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.voiceaiwrapper.app/api-reference/web-widgets/create-web-widget#webpage\",\"url\":\"https://docs.voiceaiwrapper.app/api-reference/web-widgets/create-web-widget\",\"name\":\"Create Web Widget\",\"description\":\"Creates a new web widget for an inbound campaign. ## Authentication All requests require an Authorization header using Bearer token authentication: Authorization: Bearer\",\"dateModified\":\"2026-04-24T08:09:30.557Z\",\"isPartOf\":{\"@id\":\"https://docs.voiceaiwrapper.app#website\"},\"breadcrumb\":{\"@id\":\"https://docs.voiceaiwrapper.app/api-reference/web-widgets/create-web-widget#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.voiceaiwrapper.app/api-reference/web-widgets/create-web-widget#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"VoiceAIWrapper\",\"item\":\"https://docs.voiceaiwrapper.app\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create Web Widget\",\"item\":\"https://docs.voiceaiwrapper.app/api-reference/web-widgets/create-web-widget\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.voiceaiwrapper.app/api-reference/web-widgets/create-web-widget#apireference\",\"headline\":\"Create Web Widget\",\"name\":\"Create Web Widget\",\"description\":\"Creates a new web widget for an inbound campaign. ## Authentication All requests require an Authorization header using Bearer token authentication: Authorization: Bearer\",\"url\":\"https://docs.voiceaiwrapper.app/api-reference/web-widgets/create-web-widget\",\"mainEntityOfPage\":{\"@id\":\"https://docs.voiceaiwrapper.app/api-reference/web-widgets/create-web-widget#webpage\"},\"dateModified\":\"2026-04-24T08:09:30.557Z\",\"publisher\":{\"@id\":\"https://docs.voiceaiwrapper.app/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.voiceaiwrapper.app#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"VoiceAIWrapper\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"VoiceAIWrapper\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/web-widgets/create-web-widget.md","siteName":"VoiceAIWrapper","nav":{"global":{"anchors":[{"anchor":"API Reference","icon":"code","href":"/api-reference/authentication"},{"anchor":"Dashboard","icon":"monitor","href":"https://dashboard.voiceaiwrapper.app"},{"anchor":"Support","icon":"headset","href":"/general/support"}]},"tabs":[{"tab":"API reference","icon":"square-terminal","groups":[{"group":"Getting Started","pages":[{"title":"Authentication","icon":"key","href":"/api-reference/authentication"}]},{"group":"Campaigns","pages":[{"title":"Create Campaign","openapi":"POST /api/v2/voice-campaigns","href":"/api-reference/campaigns/create-campaign"},{"title":"Update Campaign","openapi":"PATCH /api/v2/voice-campaigns/{campaign_id}","href":"/api-reference/campaigns/update-campaign"},{"title":"Update Campaign Status","openapi":"PATCH /api/v2/voice-campaigns/{campaign_id}/status","href":"/api-reference/campaigns/update-campaign-status"}]},{"group":"Client Account Configurations","pages":[{"title":"Get Assigned Resources for Client Account Configuration","openapi":"GET /api/v2/client-account-configurations/{client_account_configuration_id}/resources","href":"/api-reference/client-account-configurations/get-assigned-resources"},{"title":"Assign Resources to Client Account Configuration","openapi":"POST /api/v2/client-account-configurations/{client_account_configuration_id}/resources/assign","description":"Replaces all resource assignments for a client account configuration with the provided set.\n\n## Authentication\nAll requests require an `Authorization` header using Bearer token authentication:\n`Authorization: Bearer \u003capi_key>`","href":"/api-reference/client-account-configurations/assign-resources"}]},{"group":"Web Widgets","pages":[{"title":"Create Web Widget","openapi":"POST /api/v2/web-widgets","href":"/api-reference/web-widgets/create-web-widget"}]},{"group":"Client Forms","pages":[{"title":"Get Form Submissions","openapi":"GET /api/v2/client-forms/{client_form_id}/submissions","description":"Retrieves submissions for a client form, optionally filtered to a specific client.\n\n## Authentication\nAll requests require an `Authorization` header using Bearer token authentication:\n`Authorization: Bearer \u003capi_key>`","href":"/api-reference/client-forms/get-form-submissions"}]},{"group":"Agents","pages":[{"title":"Get Clients Assigned to Agent","openapi":"GET /api/v2/agents/{agent_id}/clients","href":"/api-reference/agents/get-clients"}]},{"group":"Clients","pages":[{"title":"List All Clients","openapi":"GET /api/v2/clients","href":"/api-reference/clients/list-clients"},{"title":"Get Client Details","openapi":"GET /api/v2/clients/{client_id}","href":"/api-reference/clients/get-client-details"},{"title":"Create Client","openapi":"POST /api/v2/clients/create","href":"/api-reference/clients/create-client"}]},{"group":"Voice Providers","pages":[{"title":"Create VoiceAIPod","openapi":"POST /api/v2/voiceai-pod","href":"/api-reference/voice-providers/create-voice-provider"}]},{"group":"Leads (v1)","pages":[{"title":"Add Lead to Campaign","openapi":"POST /v1/api/voice-campaigns/{campaign_id}/leads","href":"/api-reference/leads-v1/add-to-voice-campaign"},{"title":"Remove Lead from Campaign","openapi":"DELETE /v1/api/voice-campaigns/{campaign_id}/lead/remove","href":"/api-reference/leads-v1/remove-from-voice-campaign"},{"title":"Update Lead in Campaign","openapi":"PATCH /v1/api/voice-campaigns/{campaign_id}/lead/update","href":"/api-reference/leads-v1/update-in-voice-campaign"}]},{"group":"Leads (v2)","pages":[{"title":"List Leads in Voice Campaign","openapi":"GET /api/v2/voice-campaigns/{campaign_id}/leads/list","href":"/api-reference/leads-v2/get-campaign-leads-list"},{"title":"Add Lead to Campaign","openapi":"POST /api/v2/voice-campaigns/{campaign_id}/leads","href":"/api-reference/leads-v2/add-to-voice-campaign"},{"title":"Remove Lead from Campaign","openapi":"DELETE /api/v2/voice-campaigns/{campaign_id}/lead/remove","href":"/api-reference/leads-v2/remove-from-voice-campaign"},{"title":"Update Lead in Campaign","openapi":"PATCH /api/v2/voice-campaigns/{campaign_id}/lead/update","href":"/api-reference/leads-v2/update-in-voice-campaign"},{"title":"Bulk Add Leads to Campaign","openapi":"POST /api/v2/voice-campaigns/{campaign_id}/leads/bulk","href":"/api-reference/leads-v2/bulk-add-to-voice-campaign"},{"title":"Bulk Update Leads in Campaign","openapi":"PATCH /api/v2/voice-campaigns/{campaign_id}/leads/update/bulk","href":"/api-reference/leads-v2/bulk-update-in-voice-campaign"},{"title":"Bulk Remove Leads from Campaign","openapi":"DELETE /api/v2/voice-campaigns/{campaign_id}/leads/remove/bulk","href":"/api-reference/leads-v2/bulk-remove-from-voice-campaign"}]},{"group":"External Billing","pages":[{"group":"Subscriptions","pages":[{"title":"List Subscriptions","openapi":"GET /api/v2/external-billing/subscriptions","href":"/api-reference/external-billing/list-subscriptions"},{"title":"Get Subscription","openapi":"GET /api/v2/external-billing/subscriptions/{subscription_id}/","href":"/api-reference/external-billing/get-subscription"}]},{"group":"Payment Requests","pages":[{"title":"List Payment Requests","openapi":"GET /api/v2/external-billing/payment-requests","href":"/api-reference/external-billing/list-payment-requests"},{"title":"Get Payment Request","openapi":"GET /api/v2/external-billing/payment-requests/{payment_request_id}/","href":"/api-reference/external-billing/get-payment-request"},{"title":"Update Payment Request","openapi":"PATCH /api/v2/external-billing/payment-requests/{payment_request_id}/update","href":"/api-reference/external-billing/update-payment-request"}]},{"group":"Usage","pages":[{"title":"Get Usage","openapi":"GET /api/v2/external-billing/usage","href":"/api-reference/external-billing/get-usage"}]}]}]},{"tab":"Documentation","icon":"book-open","pages":[{"title":"Documentation","href":"/documentation/widget/headless-mode"}]}]},"basePath":"","title":"Create Web Widget - VoiceAIWrapper","buildId":"dpl_9RFrWkXdFTJCytfx6jAofvAaEXr6","deploymentId":"dpl_9RFrWkXdFTJCytfx6jAofvAaEXr6","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-BgGj2PGS.js","utils-BhNOqRKb.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-BAgRNUZo.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-CGkb0TPw.js","snippetPresets-ChLkL1a6.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-Ef10Jrbx.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-DlVCnjU8.js","shallow-BA55zJxQ.js","getApiPlaygroundDisplay-DR09dKtp.js","CodeSnippet-BZ8J8Kll.js","CodeSnippets-CcguVheG.js","Page-C7x-eUfk.js","getPastedJson-D5UqeqBp.js","icon-DpD0l99C.js","MethodPill-Wg2NXsp_.js","DuplicateIcon-CCSyX8lh.js","createIcon-C4Ukv9HX.js","DynamicMarkdown-RhjEuCHC.js","SectionHeading-DL1MykRq.js","axios-vUo_bRtp.js","Markdown-BwQ4RMdp.js","dist-CiVXVcSh.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","katex-YMM-FMeD.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js","AssistantPageLink-Dic2Jtb2.js"]}