For platform: meta with a page_id, launches a real campaign on Meta (same path the in-app wizard uses). Every other platform/shape creates a local draft - only Meta has live launch wiring today. Requires scope ads:write.
{"docsConfig":{"theme":"maple","$schema":"https://mintlify.com/docs.json","name":"SmartlyQ","colors":{"primary":"#4D8BF5","light":"#6BA1FF","dark":"#3A6FD8"},"logo":{"light":"https://mintcdn.com/smartlyq/ZmAYRP2sMgynCE25/logo/light.png?fit=max\u0026auto=format\u0026n=ZmAYRP2sMgynCE25\u0026q=85\u0026s=db5c3347a05b96c71f78cc854cc97ada","dark":"https://mintcdn.com/smartlyq/ZmAYRP2sMgynCE25/logo/dark.png?fit=max\u0026auto=format\u0026n=ZmAYRP2sMgynCE25\u0026q=85\u0026s=a72e59c7fa63b4ca786ebc5a31b6cb6f"},"favicon":"https://mintcdn.com/smartlyq/ZmAYRP2sMgynCE25/favicon.png?fit=max\u0026auto=format\u0026n=ZmAYRP2sMgynCE25\u0026q=85\u0026s=aaf98efeaf7b5e37a0f87a2ff67abd2e","navbar":{"links":[{"icon":"file-lines","href":"/llms.txt","label":"llms.txt"},{"icon":"download","href":"/openapi.json","label":"OpenAPI"},{"href":"mailto:[email protected]","label":"Support"}],"primary":{"type":"button","label":"Developer Dashboard","href":"https://app.smartlyq.com/next/developer"}},"footer":{"socials":{"x":"https://x.com/smartlyq_","linkedin":"https://linkedin.com/company/smartlyq","facebook":"https://facebook.com/smartlyq","instagram":"https://instagram.com/smartlyqofficial","youtube":"https://youtube.com/@SmartlyQ","github":"https://github.com/GLofficial"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","grok","mcp","cursor","vscode","download-spec",{"title":"Full docs (llms.txt)","description":"Full documentation index for LLMs and AI agents","icon":"file-lines","href":"/llms.txt"}],"display":"header"},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"smartlyq","hasAudioNarration":false,"actualSubdomain":"smartlyq","customDomains":["docs.smartlyq.com"],"gitSource":{"type":"github","owner":"glofficial","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6aeb0c41476494e6dae313aa","collectionId":"bab33997-2beb-4121-a2a6-e648284a634b","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6aeb0c41476494e6dae313aa"},"entitlements":{},"buildId":"6aeb0c41476494e6dae313aa","clientVersion":"0.0.4067","searchFilterCounts":[{"language":"default","tag":"API Reference","count":394},{"language":"default","tag":"Social","count":143},{"language":"default","tag":"CRM","count":62},{"language":"default","tag":"Accounts","count":57},{"language":"default","tag":"AI Generation","count":54},{"language":"default","tag":"Ads","count":48},{"language":"default","tag":"WhatsApp","count":35},{"language":"default","tag":"Documentation","count":26},{"language":"default","tag":"Inbox","count":20},{"language":"default","tag":"Analytics","count":19}]},"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":"vite-origin","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":"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}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"table td .icon,table th .icon{vertical-align:middle}"}],"page":{"pagePath":"api-reference/ads/create-a-campaign","slug":"/api-reference/ads/create-a-campaign","pageMetadata":{"title":"Create a campaign","description":"For `platform: meta` with a `page_id`, launches a real campaign on Meta (same path the in-app wizard uses). Every other platform/shape creates a local draft - only Meta has live launch wiring today. Requires scope `ads:write`.","deprecated":null,"version":null,"openapi":"/openapi.json post /ads/campaigns","href":"/api-reference/ads/create-a-campaign","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"For \", _jsx(_components.code, {\n children: \"platform: meta\"\n }), \" with a \", _jsx(_components.code, {\n children: \"page_id\"\n }), \", launches a real campaign on Meta (same path the in-app wizard uses). Every other platform/shape creates a local draft - only Meta has live launch wiring today. Requires scope \", _jsx(_components.code, {\n children: \"ads:write\"\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 a campaign","description":"For `platform: meta` with a `page_id`, launches a real campaign on Meta (same path the in-app wizard uses). Every other platform/shape creates a local draft - only Meta has live launch wiring today. Requires scope `ads:write`.","deprecated":null,"version":null,"openapi":"/openapi.json post /ads/campaigns","href":"/api-reference/ads/create-a-campaign","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Create a campaign","operationId":"createAdCampaign","tags":["Ads"],"description":"For `platform: meta` with a `page_id`, launches a real campaign on Meta (same path the in-app wizard uses). Every other platform/shape creates a local draft - only Meta has live launch wiring today. Requires scope `ads:write`.","requestBody":"a9042f3d-c0be-4ef3-8dd0-7f747f0f2542","responses":{"201":"34f0ef77-6ac1-4189-8456-2da4e55ffb64","422":"58de913a-ac01-4ea7-bc0c-efdb4e8f9b99"},"x-scopes":["ads:write"],"method":"post","type":"path","servers":["f6a9201e-8849-4a29-8a18-5df3e4201d10"],"security":["dd134831-c210-4662-ad07-2acfaa265081"],"path":"/ads/campaigns","baseUrlOptions":["https://api.smartlyq.com/v1"],"title":"Create a campaign","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"platform":{"type":"string","example":"meta","enum":["meta","google","tiktok","linkedin"],"isRequired":true,"uniqueKey":"platform","typeLabel":"enum\u003cstring>"},"name":{"type":"string","example":"Spring Sale - US","isRequired":true,"uniqueKey":"name","typeLabel":"string"},"objective":{"type":"string","example":"traffic","uniqueKey":"objective","typeLabel":"string"},"page_id":{"type":"string","example":"1234567890","description":"Meta only - required to launch live, otherwise a draft is created.","uniqueKey":"page_id","typeLabel":"string"},"ad_account_id":{"type":"string","example":"act_123456789","uniqueKey":"ad_account_id","typeLabel":"string"},"budget":{"type":"number","example":50,"uniqueKey":"budget","typeLabel":"number"},"budget_type":{"type":"string","example":"daily","enum":["daily","lifetime"],"uniqueKey":"budget_type","typeLabel":"enum\u003cstring>"},"start_date":{"type":"string","example":"2026-09-01","uniqueKey":"start_date","typeLabel":"string"},"end_date":{"type":"string","example":"2026-09-30","uniqueKey":"end_date","typeLabel":"string"},"launch":{"type":"boolean","example":false,"description":"Non-Meta only - true creates an active local draft instead of a draft.","uniqueKey":"launch","typeLabel":"boolean"},"targeting":{"type":"object","properties":{},"additionalProperties":true,"uniqueKey":"targeting","typeLabel":"object"},"creative":{"type":"object","properties":{"object_story_id":{"type":"string","example":"1234567890_9876543210","description":"Meta only - \"{page_id}_{post_id}\" from GET /ads/pages/{page_id}/posts. Boosts that existing post instead of building a new creative; image_url/video_url/headlines/primary_text are all ignored when this is set.","uniqueKey":"creative.object_story_id","typeLabel":"string"},"image_url":{"type":"string","example":"https://example.com/creative.jpg","uniqueKey":"creative.image_url","typeLabel":"string"},"video_url":{"type":"string","example":"https://example.com/creative.mp4","uniqueKey":"creative.video_url","typeLabel":"string"},"format":{"type":"string","example":"image","enum":["image","video"],"uniqueKey":"creative.format","typeLabel":"enum\u003cstring>"},"headlines":{"type":"array","items":{"type":"string","uniqueKey":"creative.headlines.items.[INDEX]","typeLabel":"string"},"example":["20% off this week only"],"uniqueKey":"creative.headlines","typeLabel":"string[]"},"descriptions":{"type":"array","items":{"type":"string","uniqueKey":"creative.descriptions.items.[INDEX]","typeLabel":"string"},"uniqueKey":"creative.descriptions","typeLabel":"string[]"},"primary_text":{"type":"string","example":"Shop the sale before it ends.","uniqueKey":"creative.primary_text","typeLabel":"string"},"destination_url":{"type":"string","example":"https://example.com/spring-sale","uniqueKey":"creative.destination_url","typeLabel":"string"},"cta":{"type":"string","example":"LEARN_MORE","description":"Standard link CTAs, or MESSAGE_PAGE (pairs with settings.destination_type=messenger) or CALL_NOW (pairs with settings.phone_number).","uniqueKey":"creative.cta","typeLabel":"string"}},"additionalProperties":true,"uniqueKey":"creative","typeLabel":"object"},"settings":{"type":"object","properties":{"pixel_id":{"type":"string","example":"","uniqueKey":"settings.pixel_id","typeLabel":"string"},"pixel_tracking":{"type":"boolean","example":true,"uniqueKey":"settings.pixel_tracking","typeLabel":"boolean"},"conversion_event":{"type":"string","example":"purchase","uniqueKey":"settings.conversion_event","typeLabel":"string"},"lead_form_id":{"type":"string","example":"","uniqueKey":"settings.lead_form_id","typeLabel":"string"},"placements":{"type":"array","items":{"type":"string","uniqueKey":"settings.placements.items.[INDEX]","typeLabel":"string"},"uniqueKey":"settings.placements","typeLabel":"string[]"},"destination_type":{"type":"string","example":"","enum":["","messenger"],"description":"Set to messenger for Click-to-Messenger - the ad set targets Messenger chats instead of a link click. Use cta: MESSAGE_PAGE on the creative to match.","uniqueKey":"settings.destination_type","typeLabel":"enum\u003cstring>"},"phone_number":{"type":"string","example":"","description":"E.164 format (e.g. +14155551234), same country as the ad set's targeting. Only takes effect with cta: CALL_NOW on the creative (Click-to-Call) - ignored otherwise.","uniqueKey":"settings.phone_number","typeLabel":"string"}},"additionalProperties":true,"uniqueKey":"settings","typeLabel":"object"}},"required":["platform","name"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"platform":"meta","name":"Spring Sale - US","objective":"traffic","page_id":"1234567890","ad_account_id":"act_123456789","budget":50,"budget_type":"daily","start_date":"2026-09-01","end_date":"2026-09-30","launch":false,"targeting":{},"creative":{"object_story_id":"1234567890_9876543210","image_url":"https://example.com/creative.jpg","video_url":"https://example.com/creative.mp4","format":"image","headlines":["20% off this week only"],"descriptions":["\u003cstring>"],"primary_text":"Shop the sale before it ends.","destination_url":"https://example.com/spring-sale","cta":"LEARN_MORE"},"settings":{"pixel_id":"","pixel_tracking":true,"conversion_event":"purchase","lead_form_id":"","placements":["\u003cstring>"],"destination_type":"","phone_number":""}}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"34f0ef77-6ac1-4189-8456-2da4e55ffb64":{"description":"Campaign created","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true],"uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"data":{"type":"object","properties":{"id":{"type":"integer","example":5001,"uniqueKey":"data.id","typeLabel":"integer"},"status":{"type":"string","example":"paused","uniqueKey":"data.status","typeLabel":"string"},"warnings":{"type":"array","items":{"type":"string","uniqueKey":"data.warnings.items.[INDEX]","typeLabel":"string"},"uniqueKey":"data.warnings","typeLabel":"string[]"}},"uniqueKey":"data","typeLabel":"object"},"meta":{"type":"object","properties":{"request_id":{"type":"string","example":"req_9f3a2b1c-7d4e-4a08-b2c6-5e1f8a9d0c34","uniqueKey":"meta.request_id","typeLabel":"string"},"timestamp":{"type":"string","format":"date-time","example":"2026-07-26T09:41:22Z","uniqueKey":"meta.timestamp","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"meta","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":true,"data":{"id":5001,"status":"paused","warnings":["\u003cstring>"]},"meta":{"request_id":"req_9f3a2b1c-7d4e-4a08-b2c6-5e1f8a9d0c34","timestamp":"2026-07-26T09:41:22Z"}}}},"exampleType":"generated"}},"exampleType":"generated"},"58de913a-ac01-4ea7-bc0c-efdb4e8f9b99":{"description":"Validation error","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[false],"uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"error":{"type":"object","properties":{"code":{"type":"string","uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","uniqueKey":"error.message","typeLabel":"string"},"details":{"type":"object","uniqueKey":"error.details","typeLabel":"object"}},"uniqueKey":"error","typeLabel":"object"},"meta":{"type":"object","properties":{"request_id":{"type":"string","example":"req_9f3a2b1c-7d4e-4a08-b2c6-5e1f8a9d0c34","uniqueKey":"meta.request_id","typeLabel":"string"},"timestamp":{"type":"string","format":"date-time","example":"2026-07-26T09:41:22Z","uniqueKey":"meta.timestamp","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"meta","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"success":false,"error":{"code":"VALIDATION_ERROR","message":"Missing required fields: content, platforms.","details":{"fields":["content","platforms"]}},"meta":{"request_id":"req_9f3a2b1c-7d4e-4a08-b2c6-5e1f8a9d0c34","timestamp":"2026-07-26T09:41:22Z"}},"examples":{"Example":{"title":"Example","value":{"success":false,"error":{"code":"VALIDATION_ERROR","message":"Missing required fields: content, platforms.","details":{"fields":["content","platforms"]}},"meta":{"request_id":"req_9f3a2b1c-7d4e-4a08-b2c6-5e1f8a9d0c34","timestamp":"2026-07-26T09:41:22Z"}}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"dd134831-c210-4662-ad07-2acfaa265081":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"sqk_live_* or sqk_test_*","description":"API key from Developer dashboard (Bearer token).","scopes":[],"schemeName":"BearerAuth"}}},"servers":{"f6a9201e-8849-4a29-8a18-5df3e4201d10":{"url":"https://api.smartlyq.com/v1","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"sqk_live_* or sqk_test_*","description":"API key from Developer dashboard (Bearer token).","scopes":[],"schemeName":"BearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"API key from Developer dashboard (Bearer token).","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"BearerAuth","name":"Authorization"}],"title":"BearerAuth"}]},"originalFileLocation":"openapi.json"},"subdomain":"smartlyq","siteName":"SmartlyQ","title":"Create a campaign - SmartlyQ","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-04T10:43:25.727Z","originalFileLocation":"api-reference/ads/create-a-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=\"description\" content=\"For platform: meta with a page_id, launches a real campaign on Meta (same path the in-app wizard uses). Every other platform/shape creates a local draft - only Meta has live launch wiring today. Requires scope ads:write.\">\u003cmeta data-mint-head name=\"application-name\" content=\"SmartlyQ\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/smartlyq/Y4EmzmEAtVw2JJEQ/_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/smartlyq/Y4EmzmEAtVw2JJEQ/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/smartlyq/Y4EmzmEAtVw2JJEQ/_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/smartlyq/Y4EmzmEAtVw2JJEQ/_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/smartlyq/Y4EmzmEAtVw2JJEQ/_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/smartlyq/Y4EmzmEAtVw2JJEQ/_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/smartlyq/Y4EmzmEAtVw2JJEQ/_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/smartlyq/Y4EmzmEAtVw2JJEQ/_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/smartlyq/Y4EmzmEAtVw2JJEQ/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create a campaign - SmartlyQ\">\u003cmeta data-mint-head property=\"og:description\" content=\"For platform: meta with a page_id, launches a real campaign on Meta (same path the in-app wizard uses). Every other platform/shape creates a local draft - only Meta has live launch wiring today. Requires scope ads:write.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"SmartlyQ\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.smartlyq.com/api-reference/ads/create-a-campaign\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://smartlyq.mintlify.app/_mintlify/api/og/v2?division=Campaigns\u0026amp;title=Create+a+campaign\u0026amp;description=For+%60platform%3A+meta%60+with+a+%60page_id%60%2C+launches+a+real+campaign+on+Meta+%28same+path+the+in-app+wizard+uses%29.+Every+other+platform%2Fshape+creates+a+local+draft+-+o\u0026amp;theme=3670c4429bf5b41f936d92bb\u0026amp;signature=f445ee00a3f9cfc5aa2fa373cbda7c4c703c65ab07f9be6540a34c43e4b8f51f\">\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 a campaign - SmartlyQ\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"For platform: meta with a page_id, launches a real campaign on Meta (same path the in-app wizard uses). Every other platform/shape creates a local draft - only Meta has live launch wiring today. Requires scope ads:write.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://smartlyq.mintlify.app/_mintlify/api/og/v2?division=Campaigns\u0026amp;title=Create+a+campaign\u0026amp;description=For+%60platform%3A+meta%60+with+a+%60page_id%60%2C+launches+a+real+campaign+on+Meta+%28same+path+the+in-app+wizard+uses%29.+Every+other+platform%2Fshape+creates+a+local+draft+-+o\u0026amp;theme=3670c4429bf5b41f936d92bb\u0026amp;signature=f445ee00a3f9cfc5aa2fa373cbda7c4c703c65ab07f9be6540a34c43e4b8f51f\">\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/smartlyq/Y4EmzmEAtVw2JJEQ/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"SmartlyQ\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#4D8BF5\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.smartlyq.com/api-reference/ads/create-a-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/ads/create-a-campaign.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.smartlyq.com/#organization\",\"name\":\"SmartlyQ\",\"url\":\"https://docs.smartlyq.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/smartlyq/ZmAYRP2sMgynCE25/logo/light.png?fit=max\u0026auto=format\u0026n=ZmAYRP2sMgynCE25\u0026q=85\u0026s=db5c3347a05b96c71f78cc854cc97ada\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.smartlyq.com#website\",\"name\":\"SmartlyQ\",\"url\":\"https://docs.smartlyq.com\",\"publisher\":{\"@id\":\"https://docs.smartlyq.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.smartlyq.com/api-reference/ads/create-a-campaign#webpage\",\"url\":\"https://docs.smartlyq.com/api-reference/ads/create-a-campaign\",\"name\":\"Create a campaign\",\"description\":\"For platform: meta with a page_id, launches a real campaign on Meta (same path the in-app wizard uses). Every other platform/shape creates a local draft - only Meta has live launch wiring today. Requires scope ads:write.\",\"dateModified\":\"2026-11-04T10:43:25.727Z\",\"isPartOf\":{\"@id\":\"https://docs.smartlyq.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.smartlyq.com/api-reference/ads/create-a-campaign#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.smartlyq.com/api-reference/ads/create-a-campaign#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Ads\",\"item\":\"https://docs.smartlyq.com/api-reference/ads/ads-performance-analytics\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Campaigns\",\"item\":\"https://docs.smartlyq.com/api-reference/ads/list-campaigns\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Create a campaign\",\"item\":\"https://docs.smartlyq.com/api-reference/ads/create-a-campaign\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.smartlyq.com/api-reference/ads/create-a-campaign#apireference\",\"headline\":\"Create a campaign\",\"name\":\"Create a campaign\",\"description\":\"For platform: meta with a page_id, launches a real campaign on Meta (same path the in-app wizard uses). Every other platform/shape creates a local draft - only Meta has live launch wiring today. Requires scope ads:write.\",\"url\":\"https://docs.smartlyq.com/api-reference/ads/create-a-campaign\",\"mainEntityOfPage\":{\"@id\":\"https://docs.smartlyq.com/api-reference/ads/create-a-campaign#webpage\"},\"dateModified\":\"2026-11-04T10:43:25.727Z\",\"publisher\":{\"@id\":\"https://docs.smartlyq.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.smartlyq.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"SmartlyQ\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"SmartlyQ","nav":{"global":null,"tabs":[{"tab":"Documentation","icon":"rocket","pages":[{"title":"Documentation","href":"/introduction"}]},{"tab":"Platforms","icon":"globe","pages":[{"title":"Platforms","href":"/platforms"}]},{"tab":"API Reference","icon":"code","groups":[{"group":"Core","pages":[{"group":"Account","pages":[{"title":"Get current user profile","deprecated":null,"version":null,"openapi":"/openapi.json get /me","href":"/api-reference/account/get-current-user-profile"},{"title":"Get usage summary","deprecated":null,"version":null,"openapi":"/openapi.json get /me/usage","href":"/api-reference/account/get-usage-summary"},{"title":"Get wallet balance","deprecated":null,"version":null,"openapi":"/openapi.json get /me/balance","href":"/api-reference/account/get-wallet-balance"},{"title":"Billing overview","deprecated":null,"version":null,"openapi":"/openapi.json get /me/billing","href":"/api-reference/account/billing-overview"}]},{"group":"Jobs","pages":[{"title":"List jobs","deprecated":null,"version":null,"openapi":"/openapi.json get /jobs","href":"/api-reference/jobs/list-jobs"},{"title":"Get job","deprecated":null,"version":null,"openapi":"/openapi.json get /jobs/{job_id}","href":"/api-reference/jobs/get-job"},{"title":"Cancel job","deprecated":null,"version":null,"openapi":"/openapi.json post /jobs/{job_id}/cancel","href":"/api-reference/jobs/cancel-job"}]},{"group":"Webhooks","pages":[{"title":"List webhooks","deprecated":null,"version":null,"openapi":"/openapi.json get /webhooks","href":"/api-reference/webhooks/list-webhooks"},{"title":"Create webhook","deprecated":null,"version":null,"openapi":"/openapi.json post /webhooks","href":"/api-reference/webhooks/create-webhook"},{"title":"Update webhook","deprecated":null,"version":null,"openapi":"/openapi.json put /webhooks/{id}","href":"/api-reference/webhooks/update-webhook"},{"title":"Send test webhook","deprecated":null,"version":null,"openapi":"/openapi.json post /webhooks/{id}/test","href":"/api-reference/webhooks/send-test-webhook"},{"title":"List webhook delivery logs","deprecated":null,"version":null,"openapi":"/openapi.json get /webhooks/logs","href":"/api-reference/webhooks/list-webhook-delivery-logs"},{"title":"Delete webhook","deprecated":null,"version":null,"openapi":"/openapi.json delete /webhooks/{id}","href":"/api-reference/webhooks/delete-webhook"},{"title":"Replay a webhook delivery","deprecated":null,"version":null,"openapi":"/openapi.json post /webhooks/deliveries/{id}/replay","href":"/api-reference/webhooks/replay-a-webhook-delivery"}]},{"group":"Logs","pages":[{"title":"List developer logs","deprecated":null,"version":null,"openapi":"/openapi.json get /logs","href":"/api-reference/logs/list-developer-logs"}]}]},{"group":"CRM","pages":[{"group":"Contacts","pages":[{"title":"Create or upsert a contact","deprecated":null,"version":null,"openapi":"/openapi.json post /contacts","href":"/api-reference/crm-contacts/create-or-upsert-a-contact"},{"title":"Bulk import contacts","deprecated":null,"version":null,"openapi":"/openapi.json post /contacts/bulk","href":"/api-reference/crm/bulk-import-contacts"},{"title":"List contacts","deprecated":null,"version":null,"openapi":"/openapi.json get /contacts","href":"/api-reference/crm-contacts/list-contacts"},{"title":"Get a contact","deprecated":null,"version":null,"openapi":"/openapi.json get /contacts/{id}","href":"/api-reference/crm-contacts/get-a-contact"},{"title":"Delete contact","deprecated":null,"version":null,"openapi":"/openapi.json delete /contacts/{id}","href":"/api-reference/crm/delete-contact"},{"title":"Update a contact","deprecated":null,"version":null,"openapi":"/openapi.json patch /contacts/{id}","href":"/api-reference/crm-contacts/update-a-contact"},{"title":"Add tags to a contact","deprecated":null,"version":null,"openapi":"/openapi.json post /contacts/{id}/tags","href":"/api-reference/crm-contacts/add-tags-to-a-contact"},{"title":"Remove tags from a contact","deprecated":null,"version":null,"openapi":"/openapi.json delete /contacts/{id}/tags","href":"/api-reference/crm-contacts/remove-tags-from-a-contact"},{"title":"Set one custom field","deprecated":null,"version":null,"openapi":"/openapi.json put /contacts/{id}/fields/{slug}","href":"/api-reference/crm-contacts/set-one-custom-field"},{"title":"Clear one custom field","deprecated":null,"version":null,"openapi":"/openapi.json delete /contacts/{id}/fields/{slug}","href":"/api-reference/crm-contacts/clear-one-custom-field"},{"title":"Contact channels","deprecated":null,"version":null,"openapi":"/openapi.json get /contacts/{id}/channels","href":"/api-reference/crm/contact-channels"},{"title":"List contact notes","deprecated":null,"version":null,"openapi":"/openapi.json get /contacts/{id}/notes","href":"/api-reference/crm-contacts/list-contact-notes"},{"title":"Add a note to a contact","deprecated":null,"version":null,"openapi":"/openapi.json post /contacts/{id}/notes","href":"/api-reference/crm-contacts/add-a-note-to-a-contact"},{"title":"Enroll a contact in an automation","deprecated":null,"version":null,"openapi":"/openapi.json post /contacts/{id}/enroll","href":"/api-reference/crm-contacts/enroll-a-contact-in-an-automation"},{"title":"Log a message on a contact's timeline","deprecated":null,"version":null,"openapi":"/openapi.json post /contacts/{id}/messages","href":"/api-reference/crm-contacts/log-a-message-on-a-contacts-timeline"}]},{"group":"Custom Fields","pages":[{"title":"List custom fields","deprecated":null,"version":null,"openapi":"/openapi.json get /custom-fields","href":"/api-reference/crm-custom-fields/list-custom-fields"},{"title":"Create a custom field","deprecated":null,"version":null,"openapi":"/openapi.json post /custom-fields","href":"/api-reference/crm-custom-fields/create-a-custom-field"},{"title":"Update custom field","deprecated":null,"version":null,"openapi":"/openapi.json patch /custom-fields/{id}","href":"/api-reference/crm/update-custom-field"},{"title":"Delete a custom field","deprecated":null,"version":null,"openapi":"/openapi.json delete /custom-fields/{id}","href":"/api-reference/crm-custom-fields/delete-a-custom-field"}]},{"group":"Companies","pages":[{"title":"List companies","deprecated":null,"version":null,"openapi":"/openapi.json get /companies","href":"/api-reference/crm-companies/list-companies"},{"title":"Create a company","deprecated":null,"version":null,"openapi":"/openapi.json post /companies","href":"/api-reference/crm-companies/create-a-company"},{"title":"Get a company","deprecated":null,"version":null,"openapi":"/openapi.json get /companies/{id}","href":"/api-reference/crm-companies/get-a-company"},{"title":"Update a company","deprecated":null,"version":null,"openapi":"/openapi.json patch /companies/{id}","href":"/api-reference/crm-companies/update-a-company"},{"title":"Delete a company","deprecated":null,"version":null,"openapi":"/openapi.json delete /companies/{id}","href":"/api-reference/crm-companies/delete-a-company"},{"title":"Link a contact to a company","deprecated":null,"version":null,"openapi":"/openapi.json post /companies/{id}/contacts","href":"/api-reference/crm-companies/link-a-contact-to-a-company"},{"title":"Unlink a contact from a company","deprecated":null,"version":null,"openapi":"/openapi.json delete /companies/{id}/contacts","href":"/api-reference/crm-companies/unlink-a-contact-from-a-company"}]},{"group":"Tasks","pages":[{"title":"List tasks","deprecated":null,"version":null,"openapi":"/openapi.json get /tasks","href":"/api-reference/crm-tasks/list-tasks"},{"title":"Create a task","deprecated":null,"version":null,"openapi":"/openapi.json post /tasks","href":"/api-reference/crm-tasks/create-a-task"},{"title":"Get a task","deprecated":null,"version":null,"openapi":"/openapi.json get /tasks/{id}","href":"/api-reference/crm-tasks/get-a-task"},{"title":"Update a task","deprecated":null,"version":null,"openapi":"/openapi.json patch /tasks/{id}","href":"/api-reference/crm-tasks/update-a-task"},{"title":"Delete a task","deprecated":null,"version":null,"openapi":"/openapi.json delete /tasks/{id}","href":"/api-reference/crm-tasks/delete-a-task"},{"title":"Log time on a task","deprecated":null,"version":null,"openapi":"/openapi.json post /tasks/{id}/time","href":"/api-reference/crm-tasks/log-time-on-a-task"}]},{"group":"Tags","pages":[{"title":"List tags","deprecated":null,"version":null,"openapi":"/openapi.json get /tags","href":"/api-reference/crm-tags/list-tags"},{"title":"Create a tag","deprecated":null,"version":null,"openapi":"/openapi.json post /tags","href":"/api-reference/crm-tags/create-a-tag"},{"title":"Rename a tag","deprecated":null,"version":null,"openapi":"/openapi.json post /tags/rename","href":"/api-reference/crm-tags/rename-a-tag"},{"title":"Merge tags","deprecated":null,"version":null,"openapi":"/openapi.json post /tags/merge","href":"/api-reference/crm-tags/merge-tags"},{"title":"Delete a tag","deprecated":null,"version":null,"openapi":"/openapi.json post /tags/delete","href":"/api-reference/crm-tags/delete-a-tag"}]},{"group":"Calendar","pages":[{"title":"List booking pages","deprecated":null,"version":null,"openapi":"/openapi.json get /calendar/event-types","href":"/api-reference/calendar/list-booking-pages"},{"title":"List open slots","deprecated":null,"version":null,"openapi":"/openapi.json get /calendar/slots","href":"/api-reference/calendar/list-open-slots"},{"title":"Take a booking","deprecated":null,"version":null,"openapi":"/openapi.json post /calendar/bookings","href":"/api-reference/calendar/take-a-booking"},{"title":"Cancel a booking","deprecated":null,"version":null,"openapi":"/openapi.json post /calendar/bookings/{id}/cancel","href":"/api-reference/calendar/cancel-a-booking"}]},{"group":"Opportunities","pages":[{"title":"List pipelines","deprecated":null,"version":null,"openapi":"/openapi.json get /pipelines","href":"/api-reference/crm-opportunities/list-pipelines"},{"title":"Create a pipeline","deprecated":null,"version":null,"openapi":"/openapi.json post /pipelines","href":"/api-reference/crm-opportunities/create-a-pipeline"},{"title":"List a pipeline's stages","deprecated":null,"version":null,"openapi":"/openapi.json get /pipelines/{id}/stages","href":"/api-reference/crm-opportunities/list-a-pipelines-stages"},{"title":"List opportunities","deprecated":null,"version":null,"openapi":"/openapi.json get /opportunities","href":"/api-reference/crm-opportunities/list-opportunities"},{"title":"Create an opportunity","deprecated":null,"version":null,"openapi":"/openapi.json post /opportunities","href":"/api-reference/crm-opportunities/create-an-opportunity"},{"title":"Get an opportunity","deprecated":null,"version":null,"openapi":"/openapi.json get /opportunities/{id}","href":"/api-reference/crm-opportunities/get-an-opportunity"},{"title":"Update an opportunity","deprecated":null,"version":null,"openapi":"/openapi.json patch /opportunities/{id}","href":"/api-reference/crm-opportunities/update-an-opportunity"},{"title":"Update opportunity status","deprecated":null,"version":null,"openapi":"/openapi.json post /opportunities/{id}/status","href":"/api-reference/crm-opportunities/update-opportunity-status"},{"title":"Delete an opportunity","deprecated":null,"version":null,"openapi":"/openapi.json delete /opportunities/{id}","href":"/api-reference/crm-opportunities/delete-an-opportunity"}]},{"group":"Workspaces","pages":[{"title":"Create a workspace (sub-account)","deprecated":null,"version":null,"openapi":"/openapi.json post /workspaces","href":"/api-reference/workspaces/create-a-workspace-sub-account"},{"title":"Bulk sub-account action","deprecated":null,"version":null,"openapi":"/openapi.json post /workspaces/bulk","href":"/api-reference/workspaces/bulk-sub-account-action"},{"title":"List workspaces (sub-accounts)","deprecated":null,"version":null,"openapi":"/openapi.json get /workspaces","href":"/api-reference/workspaces/list-workspaces-sub-accounts"},{"title":"Get a workspace (sub-account)","deprecated":null,"version":null,"openapi":"/openapi.json get /workspaces/{id}","href":"/api-reference/workspaces/get-a-workspace-sub-account"},{"title":"Disable SaaS mode for a workspace","deprecated":null,"version":null,"openapi":"/openapi.json post /workspaces/{id}/disable-saas","href":"/api-reference/workspaces/disable-saas-mode-for-a-workspace"},{"title":"Delete a workspace (sub-account)","deprecated":null,"version":null,"openapi":"/openapi.json delete /workspaces/{id}","href":"/api-reference/workspaces/delete-a-workspace-sub-account"},{"title":"Pause (suspend) a workspace","deprecated":null,"version":null,"openapi":"/openapi.json post /workspaces/{id}/pause","href":"/api-reference/workspaces/pause-suspend-a-workspace"},{"title":"Resume a paused workspace","deprecated":null,"version":null,"openapi":"/openapi.json post /workspaces/{id}/resume","href":"/api-reference/workspaces/resume-a-paused-workspace"},{"title":"Get a sub-account's subscription","deprecated":null,"version":null,"openapi":"/openapi.json get /workspaces/{id}/subscription","href":"/api-reference/workspaces/get-a-sub-accounts-subscription"},{"title":"Get a sub-account's wallet balance","deprecated":null,"version":null,"openapi":"/openapi.json get /workspaces/{id}/wallet","href":"/api-reference/workspaces/get-a-sub-accounts-wallet-balance"},{"title":"List SaaS plans","deprecated":null,"version":null,"openapi":"/openapi.json get /saas/plans","href":"/api-reference/workspaces/list-saas-plans"},{"title":"Get a SaaS plan","deprecated":null,"version":null,"openapi":"/openapi.json get /saas/plans/{id}","href":"/api-reference/workspaces/get-a-saas-plan"}]}]},{"group":"Profiles","pages":[{"title":"Create a profile","deprecated":null,"version":null,"openapi":"/openapi.json post /profiles","href":"/api-reference/profiles/create-a-profile"},{"title":"List profiles","deprecated":null,"version":null,"openapi":"/openapi.json get /profiles","href":"/api-reference/profiles/list-profiles"},{"title":"Get a profile","deprecated":null,"version":null,"openapi":"/openapi.json get /profiles/{id}","href":"/api-reference/profiles/get-a-profile"},{"title":"Update a profile","deprecated":null,"version":null,"openapi":"/openapi.json patch /profiles/{id}","href":"/api-reference/profiles/update-a-profile"},{"title":"List a profile's connected accounts","deprecated":null,"version":null,"openapi":"/openapi.json get /profiles/{id}/accounts","href":"/api-reference/profiles/list-a-profiles-connected-accounts"},{"title":"Create a hosted connect link","deprecated":null,"version":null,"openapi":"/openapi.json post /profiles/{id}/connect-link","href":"/api-reference/profiles/create-a-hosted-connect-link"},{"title":"Get a raw connect URL for one platform","deprecated":null,"version":null,"openapi":"/openapi.json post /profiles/{id}/connect/{platform}","href":"/api-reference/profiles/get-a-raw-connect-url-for-one-platform"},{"title":"Pause a profile","deprecated":null,"version":null,"openapi":"/openapi.json post /profiles/{id}/pause","href":"/api-reference/profiles/pause-a-profile"},{"title":"Resume a profile","deprecated":null,"version":null,"openapi":"/openapi.json post /profiles/{id}/resume","href":"/api-reference/profiles/resume-a-profile"},{"title":"Delete a profile","deprecated":null,"version":null,"openapi":"/openapi.json delete /profiles/{id}","href":"/api-reference/profiles/delete-a-profile"},{"title":"Account billing summary","deprecated":null,"version":null,"openapi":"/openapi.json get /me/account-billing","href":"/api-reference/profiles/account-billing-summary"}]},{"group":"AI Generation","pages":[{"group":"Articles","pages":[{"title":"Generate article","deprecated":null,"version":null,"openapi":"/openapi.json post /articles/generate","href":"/api-reference/articles/generate-article"},{"title":"List articles","deprecated":null,"version":null,"openapi":"/openapi.json get /articles","href":"/api-reference/articles/list-articles"},{"title":"Get article","deprecated":null,"version":null,"openapi":"/openapi.json get /articles/{article_id}","href":"/api-reference/articles/get-article"},{"title":"Delete article","deprecated":null,"version":null,"openapi":"/openapi.json delete /articles/{article_id}","href":"/api-reference/articles/delete-article"}]},{"group":"Images","pages":[{"title":"Generate image","deprecated":null,"version":null,"openapi":"/openapi.json post /images/generate","href":"/api-reference/images/generate-image"},{"title":"List images","deprecated":null,"version":null,"openapi":"/openapi.json get /images","href":"/api-reference/images/list-images"},{"title":"Get image","deprecated":null,"version":null,"openapi":"/openapi.json get /images/{image_id}","href":"/api-reference/images/get-image"},{"title":"Delete image","deprecated":null,"version":null,"openapi":"/openapi.json delete /images/{image_id}","href":"/api-reference/images/delete-image"}]},{"group":"Videos","pages":[{"title":"List available video models","deprecated":null,"version":null,"openapi":"/openapi.json get /videos/models","href":"/api-reference/videos/list-available-video-models"},{"title":"Generate video","deprecated":null,"version":null,"openapi":"/openapi.json post /videos/generate","href":"/api-reference/videos/generate-video"},{"title":"List videos","deprecated":null,"version":null,"openapi":"/openapi.json get /videos","href":"/api-reference/videos/list-videos"},{"title":"Get video","deprecated":null,"version":null,"openapi":"/openapi.json get /videos/{video_id}","href":"/api-reference/videos/get-video"},{"title":"Delete video","deprecated":null,"version":null,"openapi":"/openapi.json delete /videos/{video_id}","href":"/api-reference/videos/delete-video"},{"title":"Generate a viral hook line","deprecated":null,"version":null,"openapi":"/openapi.json post /videos/hook","href":"/api-reference/videos/generate-a-viral-hook-line"},{"title":"Suggest B-roll moments","deprecated":null,"version":null,"openapi":"/openapi.json post /videos/broll-suggest","href":"/api-reference/videos/suggest-b-roll-moments"},{"title":"Suggest on-screen emphasis","deprecated":null,"version":null,"openapi":"/openapi.json post /videos/emphasis","href":"/api-reference/videos/suggest-on-screen-emphasis"},{"title":"Generate a viral thumbnail","deprecated":null,"version":null,"openapi":"/openapi.json post /videos/viral-thumbnail","href":"/api-reference/videos/generate-a-viral-thumbnail"}]},{"group":"Shorts","pages":[{"title":"Generate viral shorts from a long video","deprecated":null,"version":null,"openapi":"/openapi.json post /shorts/generate","href":"/api-reference/shorts/generate-viral-shorts-from-a-long-video"},{"title":"List shorts jobs","deprecated":null,"version":null,"openapi":"/openapi.json get /shorts","href":"/api-reference/shorts/list-shorts-jobs"},{"title":"List caption styles for shorts","deprecated":null,"version":null,"openapi":"/openapi.json get /shorts/caption-styles","href":"/api-reference/shorts/list-caption-styles-for-shorts"},{"title":"Get shorts job + clips","deprecated":null,"version":null,"openapi":"/openapi.json get /shorts/{uid}","href":"/api-reference/shorts/get-shorts-job-+-clips"},{"title":"List speech languages","deprecated":null,"version":null,"openapi":"/openapi.json get /languages","href":"/api-reference/shorts/list-speech-languages"}]},{"group":"Edits","pages":[{"title":"Create a video edit","deprecated":null,"version":null,"openapi":"/openapi.json post /edits","href":"/api-reference/edits/create-a-video-edit"},{"title":"List video edits","deprecated":null,"version":null,"openapi":"/openapi.json get /edits","href":"/api-reference/edits/list-video-edits"},{"title":"List edit options","deprecated":null,"version":null,"openapi":"/openapi.json get /edits/options","href":"/api-reference/edits/list-edit-options"},{"title":"Get a video edit","deprecated":null,"version":null,"openapi":"/openapi.json get /edits/{uid}","href":"/api-reference/edits/get-a-video-edit"},{"title":"Update a video edit","deprecated":null,"version":null,"openapi":"/openapi.json patch /edits/{uid}","href":"/api-reference/edits/update-a-video-edit"},{"title":"Export a video edit","deprecated":null,"version":null,"openapi":"/openapi.json post /edits/{uid}/export","href":"/api-reference/edits/export-a-video-edit"}]},{"group":"Presentations","pages":[{"title":"Generate presentation","deprecated":null,"version":null,"openapi":"/openapi.json post /presentations/generate","href":"/api-reference/presentations/generate-presentation"},{"title":"List presentations","deprecated":null,"version":null,"openapi":"/openapi.json get /presentations","href":"/api-reference/presentations/list-presentations"},{"title":"Get presentation","deprecated":null,"version":null,"openapi":"/openapi.json get /presentations/{presentation_id}","href":"/api-reference/presentations/get-presentation"},{"title":"Delete presentation","deprecated":null,"version":null,"openapi":"/openapi.json delete /presentations/{presentation_id}","href":"/api-reference/presentations/delete-presentation"}]},{"group":"Audio","pages":[{"title":"Text to speech","deprecated":null,"version":null,"openapi":"/openapi.json post /audio/text-to-speech","href":"/api-reference/audio/text-to-speech"},{"title":"Speech to text","deprecated":null,"version":null,"openapi":"/openapi.json post /audio/speech-to-text","href":"/api-reference/audio/speech-to-text"},{"title":"Get audio","deprecated":null,"version":null,"openapi":"/openapi.json get /audio/{audio_id}","href":"/api-reference/audio/get-audio"}]},{"group":"Content","pages":[{"title":"Rewrite content","deprecated":null,"version":null,"openapi":"/openapi.json post /content/rewrite","href":"/api-reference/content/rewrite-content"},{"title":"Generate a social caption","deprecated":null,"version":null,"openapi":"/openapi.json post /content/caption","href":"/api-reference/content/generate-a-social-caption"}]},{"group":"SEO","pages":[{"title":"Keyword research","deprecated":null,"version":null,"openapi":"/openapi.json post /seo/keyword-research","href":"/api-reference/seo/keyword-research"},{"title":"Live SERP lookup","deprecated":null,"version":null,"openapi":"/openapi.json post /seo/serp","href":"/api-reference/seo/live-serp-lookup"},{"title":"Keyword difficulty","deprecated":null,"version":null,"openapi":"/openapi.json post /seo/keyword-difficulty","href":"/api-reference/seo/keyword-difficulty"},{"title":"Ranked keywords (rank tracking)","deprecated":null,"version":null,"openapi":"/openapi.json post /seo/ranked-keywords","href":"/api-reference/seo/ranked-keywords-rank-tracking"},{"title":"Domain rank overview","deprecated":null,"version":null,"openapi":"/openapi.json post /seo/domain-overview","href":"/api-reference/seo/domain-rank-overview"},{"title":"Organic competitors","deprecated":null,"version":null,"openapi":"/openapi.json post /seo/competitors","href":"/api-reference/seo/organic-competitors"},{"title":"Backlink profile summary","deprecated":null,"version":null,"openapi":"/openapi.json post /seo/backlinks-summary","href":"/api-reference/seo/backlink-profile-summary"},{"title":"On-page SEO audit","deprecated":null,"version":null,"openapi":"/openapi.json post /seo/audit","href":"/api-reference/seo/on-page-seo-audit"},{"title":"Backlink prospects (link gap)","deprecated":null,"version":null,"openapi":"/openapi.json post /seo/backlink-prospects","href":"/api-reference/seo/backlink-prospects-link-gap"},{"title":"Referring domains","deprecated":null,"version":null,"openapi":"/openapi.json post /seo/referring-domains","href":"/api-reference/seo/referring-domains"},{"title":"Backlink anchors","deprecated":null,"version":null,"openapi":"/openapi.json post /seo/backlink-anchors","href":"/api-reference/seo/backlink-anchors"},{"title":"Backlink spam score","deprecated":null,"version":null,"openapi":"/openapi.json post /seo/spam-score","href":"/api-reference/seo/backlink-spam-score"},{"title":"Historical rank overview","deprecated":null,"version":null,"openapi":"/openapi.json post /seo/rank-history","href":"/api-reference/seo/historical-rank-overview"},{"title":"Deep site audit","deprecated":null,"version":null,"openapi":"/openapi.json post /seo/site-audit","href":"/api-reference/seo/deep-site-audit"},{"title":"AI Visibility: brand lookup","deprecated":null,"version":null,"openapi":"/openapi.json post /seo/brand-lookup","href":"/api-reference/seo/ai-visibility:-brand-lookup"},{"title":"AI Visibility: prompt explorer","deprecated":null,"version":null,"openapi":"/openapi.json post /seo/prompt-explorer","href":"/api-reference/seo/ai-visibility:-prompt-explorer"},{"title":"AI Visibility Audit (async)","deprecated":null,"version":null,"openapi":"/openapi.json post /seo/ai-audit","href":"/api-reference/seo/ai-visibility-audit-async"}]}]},{"group":"Social","pages":[{"group":"Accounts","pages":[{"title":"List social accounts","deprecated":null,"version":null,"openapi":"/openapi.json get /social/accounts","href":"/api-reference/social/list-social-accounts"},{"title":"Bulk account health","deprecated":null,"version":null,"openapi":"/openapi.json get /social/accounts/health","href":"/api-reference/social/bulk-account-health"},{"title":"Live account insights","deprecated":null,"version":null,"openapi":"/openapi.json get /social/accounts/{account_id}/insights","href":"/api-reference/social/live-account-insights"},{"title":"Connection target options","deprecated":null,"version":null,"openapi":"/openapi.json get /social/accounts/{account_id}/connect-options","href":"/api-reference/social/connection-target-options"},{"title":"Select connection target","deprecated":null,"version":null,"openapi":"/openapi.json post /social/accounts/{account_id}/connect-select","href":"/api-reference/social/select-connection-target"},{"title":"Get Messenger menu","deprecated":null,"version":null,"openapi":"/openapi.json get /social/accounts/{account_id}/messenger/menu","href":"/api-reference/social/get-messenger-menu"},{"title":"Set Messenger menu","deprecated":null,"version":null,"openapi":"/openapi.json put /social/accounts/{account_id}/messenger/menu","href":"/api-reference/social/set-messenger-menu"},{"title":"Delete Messenger menu","deprecated":null,"version":null,"openapi":"/openapi.json delete /social/accounts/{account_id}/messenger/menu","href":"/api-reference/social/delete-messenger-menu"},{"title":"Get ice breakers","deprecated":null,"version":null,"openapi":"/openapi.json get /social/accounts/{account_id}/instagram/ice-breakers","href":"/api-reference/social/get-ice-breakers"},{"title":"Set ice breakers","deprecated":null,"version":null,"openapi":"/openapi.json put /social/accounts/{account_id}/instagram/ice-breakers","href":"/api-reference/social/set-ice-breakers"},{"title":"Delete ice breakers","deprecated":null,"version":null,"openapi":"/openapi.json delete /social/accounts/{account_id}/instagram/ice-breakers","href":"/api-reference/social/delete-ice-breakers"},{"title":"Facebook page insights","deprecated":null,"version":null,"openapi":"/openapi.json get /social/accounts/{account_id}/facebook/page-insights","href":"/api-reference/social/facebook-page-insights"},{"title":"Instagram audience demographics","deprecated":null,"version":null,"openapi":"/openapi.json get /social/accounts/{account_id}/instagram/audience","href":"/api-reference/social/instagram-audience-demographics"},{"title":"Follower stats","deprecated":null,"version":null,"openapi":"/openapi.json get /social/accounts/follower-stats","href":"/api-reference/social/follower-stats"},{"title":"Start headless account connection","deprecated":null,"version":null,"openapi":"/openapi.json post /social/connect/{platform}","href":"/api-reference/social/start-headless-account-connection"},{"title":"Poll headless connection status","deprecated":null,"version":null,"openapi":"/openapi.json get /social/connect/{platform}","href":"/api-reference/social/poll-headless-connection-status"},{"title":"Rename account","deprecated":null,"version":null,"openapi":"/openapi.json patch /social/accounts/{account_id}","href":"/api-reference/social/rename-account"},{"title":"Account health","deprecated":null,"version":null,"openapi":"/openapi.json get /social/accounts/{account_id}/health","href":"/api-reference/social/account-health"},{"title":"Account reconnect URL","deprecated":null,"version":null,"openapi":"/openapi.json get /social/accounts/{account_id}/reconnect-url","href":"/api-reference/social/account-reconnect-url"},{"title":"TikTok creator info","deprecated":null,"version":null,"openapi":"/openapi.json get /social/accounts/{account_id}/tiktok/creator-info","href":"/api-reference/social/tiktok-creator-info"},{"title":"Pinterest boards","deprecated":null,"version":null,"openapi":"/openapi.json get /social/accounts/{account_id}/pinterest/boards","href":"/api-reference/social/pinterest-boards"},{"title":"YouTube playlists","deprecated":null,"version":null,"openapi":"/openapi.json get /social/accounts/{account_id}/youtube/playlists","href":"/api-reference/social/youtube-playlists"},{"title":"Instagram publishing limit","deprecated":null,"version":null,"openapi":"/openapi.json get /social/accounts/{account_id}/instagram/publishing-limit","href":"/api-reference/social/instagram-publishing-limit"},{"title":"Google Business performance","deprecated":null,"version":null,"openapi":"/openapi.json get /social/accounts/{account_id}/gmb/performance","href":"/api-reference/social/google-business-performance"},{"title":"Google Business search keywords","deprecated":null,"version":null,"openapi":"/openapi.json get /social/accounts/{account_id}/gmb/search-keywords","href":"/api-reference/social/google-business-search-keywords"},{"title":"Instagram stories","deprecated":null,"version":null,"openapi":"/openapi.json get /social/accounts/{account_id}/instagram/stories","href":"/api-reference/social/instagram-stories"},{"title":"Instagram story insights","deprecated":null,"version":null,"openapi":"/openapi.json get /social/accounts/{account_id}/instagram/stories/{story_id}/insights","href":"/api-reference/social/instagram-story-insights"},{"title":"X mentions","deprecated":null,"version":null,"openapi":"/openapi.json get /social/accounts/{account_id}/x/mentions","href":"/api-reference/social/x-mentions"},{"title":"Retweet on X","deprecated":null,"version":null,"openapi":"/openapi.json post /social/accounts/{account_id}/x/retweets","href":"/api-reference/social/retweet-on-x"},{"title":"Undo retweet","deprecated":null,"version":null,"openapi":"/openapi.json delete /social/accounts/{account_id}/x/retweets/{tweet_id}","href":"/api-reference/social/undo-retweet"},{"title":"Facebook post reactions","deprecated":null,"version":null,"openapi":"/openapi.json get /social/accounts/{account_id}/facebook/post-reactions","href":"/api-reference/social/facebook-post-reactions"},{"title":"Reddit search","deprecated":null,"version":null,"openapi":"/openapi.json get /social/accounts/{account_id}/reddit/search","href":"/api-reference/social/reddit-search"},{"title":"Reddit feed","deprecated":null,"version":null,"openapi":"/openapi.json get /social/accounts/{account_id}/reddit/feed","href":"/api-reference/social/reddit-feed"},{"title":"Subscribed subreddits","deprecated":null,"version":null,"openapi":"/openapi.json get /social/accounts/{account_id}/reddit/subreddits","href":"/api-reference/social/subscribed-subreddits"},{"title":"Subreddit info + eligibility","deprecated":null,"version":null,"openapi":"/openapi.json get /social/accounts/{account_id}/reddit/subreddits/{subreddit}","href":"/api-reference/social/subreddit-info-+-eligibility"},{"title":"Subreddit rules","deprecated":null,"version":null,"openapi":"/openapi.json get /social/accounts/{account_id}/reddit/subreddits/{subreddit}/rules","href":"/api-reference/social/subreddit-rules"},{"title":"Pause posting to an account","deprecated":null,"version":null,"openapi":"/openapi.json post /social/accounts/{account_id}/pause","href":"/api-reference/social/pause-posting-to-an-account"},{"title":"Resume posting to an account","deprecated":null,"version":null,"openapi":"/openapi.json post /social/accounts/{account_id}/resume","href":"/api-reference/social/resume-posting-to-an-account"},{"title":"Disconnect a social account","deprecated":null,"version":null,"openapi":"/openapi.json delete /social/accounts/{account_id}","href":"/api-reference/social/disconnect-a-social-account"},{"title":"Move account to profile","deprecated":null,"version":null,"openapi":"/openapi.json post /social/accounts/{account_id}/move","href":"/api-reference/social/move-account-to-profile"},{"title":"List account groups","deprecated":null,"version":null,"openapi":"/openapi.json get /social/account-groups","href":"/api-reference/social/list-account-groups"},{"title":"Create account group","deprecated":null,"version":null,"openapi":"/openapi.json post /social/account-groups","href":"/api-reference/social/create-account-group"},{"title":"Get account group","deprecated":null,"version":null,"openapi":"/openapi.json get /social/account-groups/{group_id}","href":"/api-reference/social/get-account-group"},{"title":"Update account group","deprecated":null,"version":null,"openapi":"/openapi.json put /social/account-groups/{group_id}","href":"/api-reference/social/update-account-group"},{"title":"Delete account group","deprecated":null,"version":null,"openapi":"/openapi.json delete /social/account-groups/{group_id}","href":"/api-reference/social/delete-account-group"},{"title":"Get Facebook page details","deprecated":null,"version":null,"openapi":"/openapi.json get /social/accounts/{account_id}/facebook/page","href":"/api-reference/social/get-facebook-page-details"},{"title":"Update Facebook page details","deprecated":null,"version":null,"openapi":"/openapi.json patch /social/accounts/{account_id}/facebook/page","href":"/api-reference/social/update-facebook-page-details"},{"title":"Get Facebook page settings","deprecated":null,"version":null,"openapi":"/openapi.json get /social/accounts/{account_id}/facebook/page/settings","href":"/api-reference/social/get-facebook-page-settings"},{"title":"Update Facebook page settings","deprecated":null,"version":null,"openapi":"/openapi.json patch /social/accounts/{account_id}/facebook/page/settings","href":"/api-reference/social/update-facebook-page-settings"},{"title":"Set Facebook page profile picture","deprecated":null,"version":null,"openapi":"/openapi.json post /social/accounts/{account_id}/facebook/page/picture","href":"/api-reference/social/set-facebook-page-profile-picture"},{"title":"Set Facebook page cover photo","deprecated":null,"version":null,"openapi":"/openapi.json post /social/accounts/{account_id}/facebook/page/cover","href":"/api-reference/social/set-facebook-page-cover-photo"},{"title":"Get Facebook Reel limit","deprecated":null,"version":null,"openapi":"/openapi.json get /social/accounts/{account_id}/facebook/reel-limit","href":"/api-reference/social/get-facebook-reel-limit"},{"title":"Create a Pinterest board","deprecated":null,"version":null,"openapi":"/openapi.json post /social/accounts/{account_id}/pinterest/boards","href":"/api-reference/social/create-a-pinterest-board"},{"title":"Update a YouTube playlist","deprecated":null,"version":null,"openapi":"/openapi.json patch /social/accounts/{account_id}/youtube/playlists/{playlist_id}","href":"/api-reference/social/update-a-youtube-playlist"},{"title":"List mentions","deprecated":null,"version":null,"openapi":"/openapi.json get /social/accounts/{account_id}/mentions","href":"/api-reference/social/list-mentions"},{"title":"Reply to a mention","deprecated":null,"version":null,"openapi":"/openapi.json post /social/accounts/{account_id}/mentions/{mention_id}/reply","href":"/api-reference/social/reply-to-a-mention"},{"title":"List subreddit post flairs","deprecated":null,"version":null,"openapi":"/openapi.json get /social/accounts/{account_id}/reddit/subreddits/{subreddit}/flairs","href":"/api-reference/social/list-subreddit-post-flairs"}]},{"group":"Google Business","pages":[{"title":"List Google locations","deprecated":null,"version":null,"openapi":"/openapi.json get /social/accounts/{account_id}/gmb/locations","href":"/api-reference/social/list-google-locations"},{"title":"Get business info","deprecated":null,"version":null,"openapi":"/openapi.json get /social/accounts/{account_id}/gmb/location","href":"/api-reference/social/get-business-info"},{"title":"Update business info","deprecated":null,"version":null,"openapi":"/openapi.json patch /social/accounts/{account_id}/gmb/location","href":"/api-reference/social/update-business-info"},{"title":"Get attributes","deprecated":null,"version":null,"openapi":"/openapi.json get /social/accounts/{account_id}/gmb/attributes","href":"/api-reference/social/get-attributes"},{"title":"Available attributes","deprecated":null,"version":null,"openapi":"/openapi.json get /social/accounts/{account_id}/gmb/attributes/metadata","href":"/api-reference/social/available-attributes"},{"title":"Update attributes","deprecated":null,"version":null,"openapi":"/openapi.json put /social/accounts/{account_id}/gmb/attributes","href":"/api-reference/social/update-attributes"},{"title":"List media","deprecated":null,"version":null,"openapi":"/openapi.json get /social/accounts/{account_id}/gmb/media","href":"/api-reference/social/list-media"},{"title":"Add photo","deprecated":null,"version":null,"openapi":"/openapi.json post /social/accounts/{account_id}/gmb/media","href":"/api-reference/social/add-photo"},{"title":"Delete media","deprecated":null,"version":null,"openapi":"/openapi.json delete /social/accounts/{account_id}/gmb/media","href":"/api-reference/social/delete-media"},{"title":"Get food menus","deprecated":null,"version":null,"openapi":"/openapi.json get /social/accounts/{account_id}/gmb/food-menus","href":"/api-reference/social/get-food-menus"},{"title":"Update food menus","deprecated":null,"version":null,"openapi":"/openapi.json put /social/accounts/{account_id}/gmb/food-menus","href":"/api-reference/social/update-food-menus"},{"title":"List place-action links","deprecated":null,"version":null,"openapi":"/openapi.json get /social/accounts/{account_id}/gmb/place-actions","href":"/api-reference/social/list-place-action-links"},{"title":"Create place-action link","deprecated":null,"version":null,"openapi":"/openapi.json post /social/accounts/{account_id}/gmb/place-actions","href":"/api-reference/social/create-place-action-link"},{"title":"Update place-action link","deprecated":null,"version":null,"openapi":"/openapi.json patch /social/accounts/{account_id}/gmb/place-actions","href":"/api-reference/social/update-place-action-link"},{"title":"Delete place-action link","deprecated":null,"version":null,"openapi":"/openapi.json delete /social/accounts/{account_id}/gmb/place-actions","href":"/api-reference/social/delete-place-action-link"},{"title":"List verifications","deprecated":null,"version":null,"openapi":"/openapi.json get /social/accounts/{account_id}/gmb/verifications","href":"/api-reference/social/list-verifications"},{"title":"Verification options","deprecated":null,"version":null,"openapi":"/openapi.json post /social/accounts/{account_id}/gmb/verifications/options","href":"/api-reference/social/verification-options"}]},{"group":"Posts","pages":[{"title":"Create post (publish immediately)","deprecated":null,"version":null,"openapi":"/openapi.json post /social/posts","href":"/api-reference/social/create-post-publish-immediately"},{"title":"Schedule post","deprecated":null,"version":null,"openapi":"/openapi.json post /social/posts/schedule","href":"/api-reference/social/schedule-post"},{"title":"Bulk schedule posts","deprecated":null,"version":null,"openapi":"/openapi.json post /social/posts/bulk","href":"/api-reference/social/bulk-schedule-posts"},{"title":"Validate a bulk batch","deprecated":null,"version":null,"openapi":"/openapi.json post /social/posts/bulk/validate","href":"/api-reference/social/validate-a-bulk-batch"},{"title":"List social posts","deprecated":null,"version":null,"openapi":"/openapi.json get /social/posts","href":"/api-reference/social/list-social-posts"},{"title":"Get social post","deprecated":null,"version":null,"openapi":"/openapi.json get /social/posts/{post_id}","href":"/api-reference/social/get-social-post"},{"title":"Update social post","deprecated":null,"version":null,"openapi":"/openapi.json patch /social/posts/{post_id}","href":"/api-reference/social/update-social-post"},{"title":"Retry publishing a post","deprecated":null,"version":null,"openapi":"/openapi.json post /social/posts/{post_id}/retry","href":"/api-reference/social/retry-publishing-a-post"},{"title":"Unpublish post","deprecated":null,"version":null,"openapi":"/openapi.json post /social/posts/{post_id}/unpublish","href":"/api-reference/social/unpublish-post"},{"title":"Edit published post","deprecated":null,"version":null,"openapi":"/openapi.json post /social/posts/{post_id}/edit","href":"/api-reference/social/edit-published-post"},{"title":"Update YouTube metadata","deprecated":null,"version":null,"openapi":"/openapi.json post /social/posts/{post_id}/update-metadata","href":"/api-reference/social/update-youtube-metadata"},{"title":"Sync external posts","deprecated":null,"version":null,"openapi":"/openapi.json post /social/posts/sync-external","href":"/api-reference/social/sync-external-posts"},{"title":"Stop recycling","deprecated":null,"version":null,"openapi":"/openapi.json delete /social/posts/{post_id}/recycle","href":"/api-reference/social/stop-recycling"},{"title":"Delete social post","deprecated":null,"version":null,"openapi":"/openapi.json delete /social/posts/{post_id}","href":"/api-reference/social/delete-social-post"}]},{"group":"Queues","pages":[{"title":"List queues","deprecated":null,"version":null,"openapi":"/openapi.json get /social/queues","href":"/api-reference/social/list-queues"},{"title":"Create queue","deprecated":null,"version":null,"openapi":"/openapi.json post /social/queues","href":"/api-reference/social/create-queue"},{"title":"Get queue","deprecated":null,"version":null,"openapi":"/openapi.json get /social/queues/{queue_id}","href":"/api-reference/social/get-queue"},{"title":"Update queue","deprecated":null,"version":null,"openapi":"/openapi.json put /social/queues/{queue_id}","href":"/api-reference/social/update-queue"},{"title":"Delete queue","deprecated":null,"version":null,"openapi":"/openapi.json delete /social/queues/{queue_id}","href":"/api-reference/social/delete-queue"},{"title":"Get next open slot","deprecated":null,"version":null,"openapi":"/openapi.json get /social/queues/{queue_id}/next-slot","href":"/api-reference/social/get-next-open-slot"},{"title":"Preview upcoming slots","deprecated":null,"version":null,"openapi":"/openapi.json get /social/queues/{queue_id}/preview","href":"/api-reference/social/preview-upcoming-slots"}]},{"group":"Validation","pages":[{"title":"Validate post content","deprecated":null,"version":null,"openapi":"/openapi.json post /social/validate/post","href":"/api-reference/social/validate-post-content"},{"title":"Validate media URL","deprecated":null,"version":null,"openapi":"/openapi.json post /social/validate/media","href":"/api-reference/social/validate-media-url"}]},{"group":"Analytics","pages":[{"title":"Get analytics overview","deprecated":null,"version":null,"openapi":"/openapi.json get /analytics/overview","href":"/api-reference/analytics/get-analytics-overview"},{"title":"Get post analytics","deprecated":null,"version":null,"openapi":"/openapi.json get /analytics/posts","href":"/api-reference/analytics/get-post-analytics"},{"title":"Post metric timeline","deprecated":null,"version":null,"openapi":"/openapi.json get /analytics/posts/{post_id}/timeline","href":"/api-reference/analytics/post-metric-timeline"},{"title":"Daily metrics","deprecated":null,"version":null,"openapi":"/openapi.json get /analytics/daily-metrics","href":"/api-reference/analytics/daily-metrics"},{"title":"Best time to post","deprecated":null,"version":null,"openapi":"/openapi.json get /analytics/best-time","href":"/api-reference/analytics/best-time-to-post"},{"title":"Content decay","deprecated":null,"version":null,"openapi":"/openapi.json get /analytics/content-decay","href":"/api-reference/analytics/content-decay"},{"title":"Posting frequency vs engagement","deprecated":null,"version":null,"openapi":"/openapi.json get /analytics/posting-frequency","href":"/api-reference/analytics/posting-frequency-vs-engagement"},{"title":"Inbox volume","deprecated":null,"version":null,"openapi":"/openapi.json get /analytics/inbox/volume","href":"/api-reference/analytics/inbox-volume"},{"title":"Inbox heatmap","deprecated":null,"version":null,"openapi":"/openapi.json get /analytics/inbox/heatmap","href":"/api-reference/analytics/inbox-heatmap"},{"title":"Inbox source breakdown","deprecated":null,"version":null,"openapi":"/openapi.json get /analytics/inbox/source-breakdown","href":"/api-reference/analytics/inbox-source-breakdown"},{"title":"Inbox response time","deprecated":null,"version":null,"openapi":"/openapi.json get /analytics/inbox/response-time","href":"/api-reference/analytics/inbox-response-time"},{"title":"Inbox top accounts","deprecated":null,"version":null,"openapi":"/openapi.json get /analytics/inbox/top-accounts","href":"/api-reference/analytics/inbox-top-accounts"},{"title":"Inbox conversation stats","deprecated":null,"version":null,"openapi":"/openapi.json get /analytics/inbox/conversations","href":"/api-reference/analytics/inbox-conversation-stats"},{"title":"Conversation analytics","deprecated":null,"version":null,"openapi":"/openapi.json get /analytics/inbox/conversations/{conversation_id}","href":"/api-reference/analytics/conversation-analytics"},{"title":"Get account analytics","deprecated":null,"version":null,"openapi":"/openapi.json get /analytics/accounts/{account_id}","href":"/api-reference/analytics/get-account-analytics"},{"title":"YouTube channel insights","deprecated":null,"version":null,"openapi":"/openapi.json get /analytics/youtube/channel-insights","href":"/api-reference/analytics/youtube-channel-insights"},{"title":"YouTube daily views","deprecated":null,"version":null,"openapi":"/openapi.json get /analytics/youtube/daily-views","href":"/api-reference/analytics/youtube-daily-views"},{"title":"YouTube audience retention","deprecated":null,"version":null,"openapi":"/openapi.json get /analytics/youtube/video-retention","href":"/api-reference/analytics/youtube-audience-retention"},{"title":"YouTube viewer demographics","deprecated":null,"version":null,"openapi":"/openapi.json get /analytics/youtube/demographics","href":"/api-reference/analytics/youtube-viewer-demographics"}]},{"group":"Reviews","pages":[{"title":"List reviews","deprecated":null,"version":null,"openapi":"/openapi.json get /reviews","href":"/api-reference/reviews/list-reviews"},{"title":"Reply to review","deprecated":null,"version":null,"openapi":"/openapi.json post /reviews/{review_id}/reply","href":"/api-reference/reviews/reply-to-review"},{"title":"Delete review reply","deprecated":null,"version":null,"openapi":"/openapi.json delete /reviews/{review_id}/reply","href":"/api-reference/reviews/delete-review-reply"},{"title":"Sync reviews","deprecated":null,"version":null,"openapi":"/openapi.json post /reviews/sync","href":"/api-reference/reviews/sync-reviews"}]},{"group":"Automations","pages":[{"title":"List automations","deprecated":null,"version":null,"openapi":"/openapi.json get /automations","href":"/api-reference/automations/list-automations"},{"title":"Get automation","deprecated":null,"version":null,"openapi":"/openapi.json get /automations/{automation_id}","href":"/api-reference/automations/get-automation"},{"title":"Activate automation","deprecated":null,"version":null,"openapi":"/openapi.json post /automations/{automation_id}/activate","href":"/api-reference/automations/activate-automation"},{"title":"Pause automation","deprecated":null,"version":null,"openapi":"/openapi.json post /automations/{automation_id}/deactivate","href":"/api-reference/automations/pause-automation"},{"title":"Trigger automation","deprecated":null,"version":null,"openapi":"/openapi.json post /automations/{automation_id}/trigger","href":"/api-reference/automations/trigger-automation"},{"title":"List runs","deprecated":null,"version":null,"openapi":"/openapi.json get /automations/{automation_id}/runs","href":"/api-reference/automations/list-runs"},{"title":"Get run","deprecated":null,"version":null,"openapi":"/openapi.json get /automations/{automation_id}/runs/{run_id}","href":"/api-reference/automations/get-run"},{"title":"Duplicate an automation","deprecated":null,"version":null,"openapi":"/openapi.json post /automations/{automation_id}/duplicate","href":"/api-reference/automations/duplicate-an-automation"},{"title":"List automation versions","deprecated":null,"version":null,"openapi":"/openapi.json get /automations/{automation_id}/versions","href":"/api-reference/automations/list-automation-versions"},{"title":"Get one automation version","deprecated":null,"version":null,"openapi":"/openapi.json get /automations/{automation_id}/versions/{version}","href":"/api-reference/automations/get-one-automation-version"},{"title":"Restore an automation version","deprecated":null,"version":null,"openapi":"/openapi.json post /automations/{automation_id}/versions/{version}/restore","href":"/api-reference/automations/restore-an-automation-version"}]},{"group":"Media","pages":[{"title":"Get presigned upload URL","deprecated":null,"version":null,"openapi":"/openapi.json post /media/upload-url","href":"/api-reference/media/get-presigned-upload-url"},{"title":"Upload a file directly","deprecated":null,"version":null,"openapi":"/openapi.json post /media/upload-direct","href":"/api-reference/media/upload-a-file-directly"},{"title":"Confirm a presigned upload","deprecated":null,"version":null,"openapi":"/openapi.json post /media/{media_id}/confirm","href":"/api-reference/media/confirm-a-presigned-upload"},{"title":"List media","deprecated":null,"version":null,"openapi":"/openapi.json get /media","href":"/api-reference/media/list-media"},{"title":"Get media","deprecated":null,"version":null,"openapi":"/openapi.json get /media/{media_id}","href":"/api-reference/media/get-media"},{"title":"Delete media","deprecated":null,"version":null,"openapi":"/openapi.json delete /media/{media_id}","href":"/api-reference/media/delete-media"}]},{"group":"Short URLs","pages":[{"title":"Shorten URL","deprecated":null,"version":null,"openapi":"/openapi.json post /urls/shorten","href":"/api-reference/urls/shorten-url"},{"title":"List short URLs","deprecated":null,"version":null,"openapi":"/openapi.json get /urls","href":"/api-reference/urls/list-short-urls"},{"title":"Get short URL","deprecated":null,"version":null,"openapi":"/openapi.json get /urls/{url_id}","href":"/api-reference/urls/get-short-url"},{"title":"Get short URL stats","deprecated":null,"version":null,"openapi":"/openapi.json get /urls/{url_id}/stats","href":"/api-reference/urls/get-short-url-stats"},{"title":"Delete short URL","deprecated":null,"version":null,"openapi":"/openapi.json delete /urls/{url_id}","href":"/api-reference/urls/delete-short-url"},{"title":"Update a short URL","deprecated":null,"version":null,"openapi":"/openapi.json patch /urls/{id}","href":"/api-reference/urls/update-a-short-url"}]}]},{"group":"Ads","pages":[{"group":"Analytics \u0026 Targeting","pages":[{"title":"Ads performance analytics","deprecated":null,"version":null,"openapi":"/openapi.json get /ads/analytics","href":"/api-reference/ads/ads-performance-analytics"},{"title":"Search Meta interest targeting","deprecated":null,"version":null,"openapi":"/openapi.json get /ads/targeting-search","href":"/api-reference/ads/search-meta-interest-targeting"},{"title":"List a Page's organic posts","deprecated":null,"version":null,"openapi":"/openapi.json get /ads/pages/{page_id}/posts","href":"/api-reference/ads/list-a-pages-organic-posts"}]},{"group":"Campaigns","pages":[{"title":"List campaigns","description":"Metric fields (`spent`, `impressions`, `clicks`, `conversions`, `leads`, `purchase_value`, `ctr`, `cpa`, `roas`) cover the **last 28 days**, on every platform. That is the window the ad networks give us daily figures for, so it is the longest total we can report without inventing the missing days - it is NOT the campaign's lifetime. For any other date range, or a per-campaign breakdown of one, use `GET /ads/analytics`. Requires scope `ads:read`.","deprecated":null,"version":null,"openapi":"/openapi.json get /ads/campaigns","href":"/api-reference/ads/list-campaigns"},{"title":"Create a campaign","deprecated":null,"version":null,"openapi":"/openapi.json post /ads/campaigns","href":"/api-reference/ads/create-a-campaign"},{"title":"Get a campaign","description":"Metric fields (`spent`, `impressions`, `clicks`, `conversions`, `leads`, `purchase_value`, `ctr`, `cpa`, `roas`) cover the **last 28 days**, on every platform. That is the window the ad networks give us daily figures for, so it is the longest total we can report without inventing the missing days - it is NOT the campaign's lifetime. For any other date range, or a per-campaign breakdown of one, use `GET /ads/analytics`. Requires scope `ads:read`.","deprecated":null,"version":null,"openapi":"/openapi.json get /ads/campaigns/{id}","href":"/api-reference/ads/get-a-campaign"},{"title":"Update a campaign","deprecated":null,"version":null,"openapi":"/openapi.json patch /ads/campaigns/{id}","href":"/api-reference/ads/update-a-campaign"},{"title":"Delete a campaign","deprecated":null,"version":null,"openapi":"/openapi.json delete /ads/campaigns/{id}","href":"/api-reference/ads/delete-a-campaign"},{"title":"Pause a campaign","deprecated":null,"version":null,"openapi":"/openapi.json post /ads/campaigns/{id}/pause","href":"/api-reference/ads/pause-a-campaign"},{"title":"Resume a campaign","deprecated":null,"version":null,"openapi":"/openapi.json post /ads/campaigns/{id}/resume","href":"/api-reference/ads/resume-a-campaign"},{"title":"Duplicate a campaign","deprecated":null,"version":null,"openapi":"/openapi.json post /ads/campaigns/{id}/duplicate","href":"/api-reference/ads/duplicate-a-campaign"},{"title":"Archive a campaign","deprecated":null,"version":null,"openapi":"/openapi.json post /ads/campaigns/{id}/archive","href":"/api-reference/ads/archive-a-campaign"},{"title":"Bulk pause/resume campaigns","deprecated":null,"version":null,"openapi":"/openapi.json post /ads/campaigns/bulk-status","href":"/api-reference/ads/bulk-pauseresume-campaigns"}]},{"group":"Ad Sets","pages":[{"title":"List ad sets","deprecated":null,"version":null,"openapi":"/openapi.json get /ads/ad-sets","href":"/api-reference/ads/list-ad-sets"},{"title":"Get an ad set","deprecated":null,"version":null,"openapi":"/openapi.json get /ads/ad-sets/{id}","href":"/api-reference/ads/get-an-ad-set"},{"title":"Delete an ad set","deprecated":null,"version":null,"openapi":"/openapi.json delete /ads/ad-sets/{id}","href":"/api-reference/ads/delete-an-ad-set"},{"title":"Pause an ad set","deprecated":null,"version":null,"openapi":"/openapi.json post /ads/ad-sets/{id}/pause","href":"/api-reference/ads/pause-an-ad-set"},{"title":"Resume an ad set","deprecated":null,"version":null,"openapi":"/openapi.json post /ads/ad-sets/{id}/resume","href":"/api-reference/ads/resume-an-ad-set"},{"title":"Duplicate an ad set","deprecated":null,"version":null,"openapi":"/openapi.json post /ads/ad-sets/{id}/duplicate","href":"/api-reference/ads/duplicate-an-ad-set"},{"title":"Archive an ad set","deprecated":null,"version":null,"openapi":"/openapi.json post /ads/ad-sets/{id}/archive","href":"/api-reference/ads/archive-an-ad-set"}]},{"group":"Ads","pages":[{"title":"List ads","deprecated":null,"version":null,"openapi":"/openapi.json get /ads/ads","href":"/api-reference/ads/list-ads"},{"title":"Get an ad","deprecated":null,"version":null,"openapi":"/openapi.json get /ads/ads/{id}","href":"/api-reference/ads/get-an-ad"},{"title":"Delete an ad","deprecated":null,"version":null,"openapi":"/openapi.json delete /ads/ads/{id}","href":"/api-reference/ads/delete-an-ad"},{"title":"Pause an ad","deprecated":null,"version":null,"openapi":"/openapi.json post /ads/ads/{id}/pause","href":"/api-reference/ads/pause-an-ad"},{"title":"Resume an ad","deprecated":null,"version":null,"openapi":"/openapi.json post /ads/ads/{id}/resume","href":"/api-reference/ads/resume-an-ad"},{"title":"Duplicate an ad","deprecated":null,"version":null,"openapi":"/openapi.json post /ads/ads/{id}/duplicate","href":"/api-reference/ads/duplicate-an-ad"},{"title":"Archive an ad","deprecated":null,"version":null,"openapi":"/openapi.json post /ads/ads/{id}/archive","href":"/api-reference/ads/archive-an-ad"}]},{"group":"Audiences \u0026 Pixels","pages":[{"title":"Create an audience","deprecated":null,"version":null,"openapi":"/openapi.json post /ads/audiences","href":"/api-reference/ads/create-an-audience"},{"title":"List audiences","deprecated":null,"version":null,"openapi":"/openapi.json get /ads/audiences","href":"/api-reference/ads/list-audiences"},{"title":"List pixels / conversion destinations","deprecated":null,"version":null,"openapi":"/openapi.json get /ads/pixels","href":"/api-reference/ads/list-pixels-conversion-destinations"}]},{"group":"Lead Forms","pages":[{"title":"List lead forms","deprecated":null,"version":null,"openapi":"/openapi.json get /ads/lead-forms","href":"/api-reference/ads/list-lead-forms"},{"title":"Create a lead form","deprecated":null,"version":null,"openapi":"/openapi.json post /ads/lead-forms","href":"/api-reference/ads/create-a-lead-form"}]},{"group":"Creatives","pages":[{"title":"List creatives","deprecated":null,"version":null,"openapi":"/openapi.json get /ads/creatives","href":"/api-reference/ads/list-creatives"},{"title":"Create a creative","deprecated":null,"version":null,"openapi":"/openapi.json post /ads/creatives","href":"/api-reference/ads/create-a-creative"},{"title":"Update a creative","deprecated":null,"version":null,"openapi":"/openapi.json patch /ads/creatives/{id}","href":"/api-reference/ads/update-a-creative"},{"title":"Delete a creative","deprecated":null,"version":null,"openapi":"/openapi.json delete /ads/creatives/{id}","href":"/api-reference/ads/delete-a-creative"}]},{"group":"Accounts \u0026 Diagnostics","pages":[{"title":"List connected ad accounts","deprecated":null,"version":null,"openapi":"/openapi.json get /ads/accounts","href":"/api-reference/ads/list-connected-ad-accounts"},{"title":"Account health and rate-limit diagnostics","deprecated":null,"version":null,"openapi":"/openapi.json get /ads/accounts/diagnostics","href":"/api-reference/ads/account-health-and-rate-limit-diagnostics"},{"title":"List audit log entries","deprecated":null,"version":null,"openapi":"/openapi.json get /ads/audit-log","href":"/api-reference/ads/list-audit-log-entries"}]},{"group":"Estimate \u0026 Sync","pages":[{"title":"Audience-size estimate","deprecated":null,"version":null,"openapi":"/openapi.json post /ads/estimate","href":"/api-reference/ads/audience-size-estimate"},{"title":"Trigger an account sync","deprecated":null,"version":null,"openapi":"/openapi.json post /ads/sync","href":"/api-reference/ads/trigger-an-account-sync"}]}]},{"group":"WhatsApp","pages":[{"title":"Send a WhatsApp message","deprecated":null,"version":null,"openapi":"/openapi.json post /whatsapp/messages","href":"/api-reference/whatsapp/send-a-whatsapp-message"},{"title":"List message templates","deprecated":null,"version":null,"openapi":"/openapi.json get /whatsapp/templates","href":"/api-reference/whatsapp/list-message-templates"},{"title":"Create a message template","deprecated":null,"version":null,"openapi":"/openapi.json post /whatsapp/templates","href":"/api-reference/whatsapp/create-a-message-template"},{"title":"Get business profile","deprecated":null,"version":null,"openapi":"/openapi.json get /whatsapp/business-profile","href":"/api-reference/whatsapp/get-business-profile"},{"title":"Update business profile","deprecated":null,"version":null,"openapi":"/openapi.json patch /whatsapp/business-profile","href":"/api-reference/whatsapp/update-business-profile"},{"title":"List phone numbers","deprecated":null,"version":null,"openapi":"/openapi.json get /whatsapp/phone-numbers","href":"/api-reference/whatsapp/list-phone-numbers"},{"title":"Get a WhatsApp template","deprecated":null,"version":null,"openapi":"/openapi.json get /whatsapp/templates/{name}","href":"/api-reference/whatsapp/get-a-whatsapp-template"},{"title":"Update a WhatsApp template","deprecated":null,"version":null,"openapi":"/openapi.json patch /whatsapp/templates/{name}","href":"/api-reference/whatsapp/update-a-whatsapp-template"},{"title":"Delete a WhatsApp template","deprecated":null,"version":null,"openapi":"/openapi.json delete /whatsapp/templates/{name}","href":"/api-reference/whatsapp/delete-a-whatsapp-template"},{"title":"Set the WhatsApp profile photo","deprecated":null,"version":null,"openapi":"/openapi.json post /whatsapp/business-profile/photo","href":"/api-reference/whatsapp/set-the-whatsapp-profile-photo"},{"title":"Get the WhatsApp display name","deprecated":null,"version":null,"openapi":"/openapi.json get /whatsapp/business-profile/display-name","href":"/api-reference/whatsapp/get-the-whatsapp-display-name"},{"title":"Request a WhatsApp display-name change","deprecated":null,"version":null,"openapi":"/openapi.json post /whatsapp/business-profile/display-name","href":"/api-reference/whatsapp/request-a-whatsapp-display-name-change"},{"title":"Browse the shared template library","deprecated":null,"version":null,"openapi":"/openapi.json get /whatsapp/template-library","href":"/api-reference/whatsapp/browse-the-shared-template-library"},{"title":"Adopt a library template","deprecated":null,"version":null,"openapi":"/openapi.json post /whatsapp/templates/from-library","href":"/api-reference/whatsapp/adopt-a-library-template"},{"title":"List flows","deprecated":null,"version":null,"openapi":"/openapi.json get /whatsapp/flows","href":"/api-reference/whatsapp/list-flows"},{"title":"Create a flow","deprecated":null,"version":null,"openapi":"/openapi.json post /whatsapp/flows","href":"/api-reference/whatsapp/create-a-flow"},{"title":"Get flow","deprecated":null,"version":null,"openapi":"/openapi.json get /whatsapp/flows/{flow_id}","href":"/api-reference/whatsapp/get-flow"},{"title":"Update flow","deprecated":null,"version":null,"openapi":"/openapi.json patch /whatsapp/flows/{flow_id}","href":"/api-reference/whatsapp/update-flow"},{"title":"Delete flow","deprecated":null,"version":null,"openapi":"/openapi.json delete /whatsapp/flows/{flow_id}","href":"/api-reference/whatsapp/delete-flow"},{"title":"Get flow JSON asset","deprecated":null,"version":null,"openapi":"/openapi.json get /whatsapp/flows/{flow_id}/json","href":"/api-reference/whatsapp/get-flow-json-asset"},{"title":"Upload flow JSON","deprecated":null,"version":null,"openapi":"/openapi.json put /whatsapp/flows/{flow_id}/json","href":"/api-reference/whatsapp/upload-flow-json"},{"title":"Get flow preview URL","deprecated":null,"version":null,"openapi":"/openapi.json get /whatsapp/flows/{flow_id}/preview","href":"/api-reference/whatsapp/get-flow-preview-url"},{"title":"Publish flow","deprecated":null,"version":null,"openapi":"/openapi.json post /whatsapp/flows/{flow_id}/publish","href":"/api-reference/whatsapp/publish-flow"},{"title":"Deprecate flow","deprecated":null,"version":null,"openapi":"/openapi.json post /whatsapp/flows/{flow_id}/deprecate","href":"/api-reference/whatsapp/deprecate-flow"},{"title":"List blocked users","deprecated":null,"version":null,"openapi":"/openapi.json get /whatsapp/block-users","href":"/api-reference/whatsapp/list-blocked-users"},{"title":"Block users","deprecated":null,"version":null,"openapi":"/openapi.json post /whatsapp/block-users","href":"/api-reference/whatsapp/block-users"},{"title":"Unblock users","deprecated":null,"version":null,"openapi":"/openapi.json delete /whatsapp/block-users","href":"/api-reference/whatsapp/unblock-users"},{"title":"List your sandbox sessions","deprecated":null,"version":null,"openapi":"/openapi.json get /whatsapp/sandbox/sessions","href":"/api-reference/whatsapp/list-your-sandbox-sessions"},{"title":"Start a sandbox activation","deprecated":null,"version":null,"openapi":"/openapi.json post /whatsapp/sandbox/sessions","href":"/api-reference/whatsapp/start-a-sandbox-activation"},{"title":"Send the sandbox template","deprecated":null,"version":null,"openapi":"/openapi.json post /whatsapp/sandbox/sessions/{session_id}/send","href":"/api-reference/whatsapp/send-the-sandbox-template"},{"title":"Revoke a sandbox session","deprecated":null,"version":null,"openapi":"/openapi.json delete /whatsapp/sandbox/sessions/{session_id}","href":"/api-reference/whatsapp/revoke-a-sandbox-session"},{"title":"Bridge status","deprecated":null,"version":null,"openapi":"/openapi.json get /whatsapp/numbers/{sender_id}/bridge","href":"/api-reference/whatsapp/bridge-status"},{"title":"Bridge an owned number onto WhatsApp","deprecated":null,"version":null,"openapi":"/openapi.json post /whatsapp/numbers/{sender_id}/bridge","href":"/api-reference/whatsapp/bridge-an-owned-number-onto-whatsapp"},{"title":"Request a verification code","deprecated":null,"version":null,"openapi":"/openapi.json post /whatsapp/numbers/{sender_id}/bridge/request-code","href":"/api-reference/whatsapp/request-a-verification-code"},{"title":"Submit the verification code","deprecated":null,"version":null,"openapi":"/openapi.json post /whatsapp/numbers/{sender_id}/bridge/verify","href":"/api-reference/whatsapp/submit-the-verification-code"}]},{"group":"Inbox","pages":[{"group":"Comments","pages":[{"title":"List comments","deprecated":null,"version":null,"openapi":"/openapi.json get /social/comments","href":"/api-reference/comments/list-comments"},{"title":"Get one post's comments (threaded)","deprecated":null,"version":null,"openapi":"/openapi.json get /social/comments/{post_id}","href":"/api-reference/comments/get-one-posts-comments-threaded"},{"title":"Reply to a comment","deprecated":null,"version":null,"openapi":"/openapi.json post /social/comments/{comment_id}/reply","href":"/api-reference/comments/reply-to-a-comment"},{"title":"Private reply (comment-to-DM)","deprecated":null,"version":null,"openapi":"/openapi.json post /social/comments/{comment_id}/private-reply","href":"/api-reference/social/private-reply-comment-to-dm"},{"title":"Hide or unhide a comment","deprecated":null,"version":null,"openapi":"/openapi.json post /social/comments/{comment_id}/hide","href":"/api-reference/comments/hide-or-unhide-a-comment"},{"title":"Delete a comment","deprecated":null,"version":null,"openapi":"/openapi.json delete /social/comments/{comment_id}","href":"/api-reference/comments/delete-a-comment"},{"title":"Like a comment","deprecated":null,"version":null,"openapi":"/openapi.json post /social/comments/{comment_id}/like","href":"/api-reference/comments/like-a-comment"},{"title":"Unlike a comment","deprecated":null,"version":null,"openapi":"/openapi.json delete /social/comments/{comment_id}/like","href":"/api-reference/comments/unlike-a-comment"},{"title":"Approve or reject a comment","deprecated":null,"version":null,"openapi":"/openapi.json post /social/comments/{comment_id}/moderate","href":"/api-reference/comments/approve-or-reject-a-comment"}]},{"group":"Direct Messages","pages":[{"title":"List DM conversations","deprecated":null,"version":null,"openapi":"/openapi.json get /social/conversations","href":"/api-reference/direct-messages/list-dm-conversations"},{"title":"Search conversations","deprecated":null,"version":null,"openapi":"/openapi.json get /social/conversations/search","href":"/api-reference/social/search-conversations"},{"title":"Get conversation","deprecated":null,"version":null,"openapi":"/openapi.json get /social/conversations/{conversation_id}","href":"/api-reference/social/get-conversation"},{"title":"Archive / reopen conversation","deprecated":null,"version":null,"openapi":"/openapi.json patch /social/conversations/{conversation_id}","href":"/api-reference/social/archive-reopen-conversation"},{"title":"List messages in a conversation","deprecated":null,"version":null,"openapi":"/openapi.json get /social/conversations/{conversation_id}/messages","href":"/api-reference/direct-messages/list-messages-in-a-conversation"},{"title":"Send a direct message","deprecated":null,"version":null,"openapi":"/openapi.json post /social/conversations/{conversation_id}/messages","href":"/api-reference/direct-messages/send-a-direct-message"},{"title":"Mark a conversation read","deprecated":null,"version":null,"openapi":"/openapi.json post /social/conversations/{conversation_id}/read","href":"/api-reference/direct-messages/mark-a-conversation-read"},{"title":"Typing indicator","deprecated":null,"version":null,"openapi":"/openapi.json post /social/conversations/{conversation_id}/typing","href":"/api-reference/social/typing-indicator"},{"title":"React to a message","deprecated":null,"version":null,"openapi":"/openapi.json post /social/conversations/{conversation_id}/messages/{message_id}/reactions","href":"/api-reference/direct-messages/react-to-a-message"},{"title":"Remove a message reaction","deprecated":null,"version":null,"openapi":"/openapi.json delete /social/conversations/{conversation_id}/messages/{message_id}/reactions","href":"/api-reference/direct-messages/remove-a-message-reaction"},{"title":"Delete a sent message","deprecated":null,"version":null,"openapi":"/openapi.json delete /social/conversations/{conversation_id}/messages/{message_id}","href":"/api-reference/direct-messages/delete-a-sent-message"}]}]},{"group":"AI Assistants","pages":[{"group":"AI Captain","pages":[{"title":"Send AI Captain message","deprecated":null,"version":null,"openapi":"/openapi.json post /captain/messages","href":"/api-reference/ai-captain/send-ai-captain-message"},{"title":"List AI Captain conversations","deprecated":null,"version":null,"openapi":"/openapi.json get /captain/conversations","href":"/api-reference/ai-captain/list-ai-captain-conversations"},{"title":"Get AI Captain conversation","deprecated":null,"version":null,"openapi":"/openapi.json get /captain/conversations/{conversation_id}","href":"/api-reference/ai-captain/get-ai-captain-conversation"}]},{"group":"Chatbots","pages":[{"title":"Create chatbot","deprecated":null,"version":null,"openapi":"/openapi.json post /chatbots","href":"/api-reference/chatbot/create-chatbot"},{"title":"List chatbots","deprecated":null,"version":null,"openapi":"/openapi.json get /chatbots","href":"/api-reference/chatbot/list-chatbots"},{"title":"Get chatbot","deprecated":null,"version":null,"openapi":"/openapi.json get /chatbots/{id}","href":"/api-reference/chatbot/get-chatbot"},{"title":"Update chatbot","deprecated":null,"version":null,"openapi":"/openapi.json patch /chatbots/{id}","href":"/api-reference/chatbot/update-chatbot"},{"title":"Delete chatbot","deprecated":null,"version":null,"openapi":"/openapi.json delete /chatbots/{id}","href":"/api-reference/chatbot/delete-chatbot"},{"title":"Start chatbot training","deprecated":null,"version":null,"openapi":"/openapi.json post /chatbots/{id}/train","href":"/api-reference/chatbot/start-chatbot-training"},{"title":"Get chatbot training status","deprecated":null,"version":null,"openapi":"/openapi.json get /chatbots/{id}/train-status","href":"/api-reference/chatbot/get-chatbot-training-status"},{"title":"Send chatbot message","deprecated":null,"version":null,"openapi":"/openapi.json post /chatbots/{id}/messages","href":"/api-reference/chatbot/send-chatbot-message"},{"title":"List chatbot conversations","deprecated":null,"version":null,"openapi":"/openapi.json get /chatbots/{id}/conversations","href":"/api-reference/chatbot/list-chatbot-conversations"},{"title":"Get conversation messages","deprecated":null,"version":null,"openapi":"/openapi.json get /chatbots/{id}/conversations/{conv_id}/messages","href":"/api-reference/chatbot/get-conversation-messages"}]}]}]},{"tab":"Changelog","icon":"clock-rotate-left","pages":[{"title":"Changelog","href":"/changelog"}]}]},"basePath":"","title":"Create a campaign - SmartlyQ","buildId":"dpl_9VVk5y1P8k1ATeJguVngy9Q3cmbD","deploymentId":"dpl_9VVk5y1P8k1ATeJguVngy9Q3cmbD","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-DX1Meug0.js","utils-B_OMIQVC.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-ChxhRPMa.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-CuKvD8Iv.js","snippetPresets-C5d7p2hp.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","Page-BAvA99GL.js","ApiExamples-CfHcE8m4.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C1zZV314.js","shallow-CmQhqCJn.js","getApiPlaygroundDisplay-YRo9s1O7.js","CodeSnippet-RN1MTdfk.js","CodeSnippets-DKLPHxJA.js","getPastedJson-bz0M41mU.js","icon-CsmhpPrv.js","MethodPill-CNGsVE77.js","DuplicateIcon-DilfU_Z2.js","createIcon-BdsYzQck.js","DynamicMarkdown-CbqEDjbV.js","SectionHeading-O6hXpFCN.js","axios-vUo_bRtp.js","Markdown-nKm-uidQ.js","clsx-ClVdStUn.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CIQkMg3R.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-ImrFS4Fy.js"]}