{"docsConfig":{"theme":"aspen","$schema":"https://mintlify.com/docs.json","name":"Kavenio","colors":{"primary":"#111827"},"logo":{"light":"https://mintcdn.com/kavenio/2b-EvfPCz2lVvy_Y/logo/kavenio-light.svg?fit=max\u0026auto=format\u0026n=2b-EvfPCz2lVvy_Y\u0026q=85\u0026s=4d05ac261edfadda2151f002652c7183","dark":"https://mintcdn.com/kavenio/2b-EvfPCz2lVvy_Y/logo/kavenio-dark.svg?fit=max\u0026auto=format\u0026n=2b-EvfPCz2lVvy_Y\u0026q=85\u0026s=2496d88db343046fb44583f0ff09c8a5"},"appearance":{"default":"light","strict":true},"navbar":{"primary":{"type":"button","label":"Dashboard","href":"https://app.kavenio.com"}},"contextual":{"options":["copy","chatgpt","claude"],"display":"header"},"styling":{"latex":false},"navigation":{"directory":"card","pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"kavenio","hasAudioNarration":false,"actualSubdomain":"kavenio","customDomains":["kavenio.com"],"gitSource":{"type":"github","owner":"kaveniohq","repo":"kavenio","deployBranch":"main","contentDirectory":"docs/public","isPrivate":true,"mountPath":"","label":""},"chroma":{"collectionId":"599d28c2-1996-4d87-b1fd-c013617b4693","liveDeploymentHistoryId":"6a6b3aa5b4b9b079fc50376f","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6a6b3aa5b4b9b079fc50376f"},"feedback":{"agentFeedback":true,"thumbs":true},"entitlements":{},"buildId":"6a6b3aa5b4b9b079fc50376f:success","clientVersion":"0.0.4044","searchFilterCounts":[{"language":"default","tag":"Documentation","count":255},{"language":"default","tag":"API","count":221},{"language":"default","tag":"Reference","count":209},{"language":"default","tag":"Connect","count":31},{"language":"default","tag":"Google Business","count":23},{"language":"default","tag":"Accounts","count":20},{"language":"default","tag":"Discord","count":16},{"language":"default","tag":"Posts","count":16},{"language":"default","tag":"Platforms","count":15},{"language":"default","tag":"Ads","count":15}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"/docs","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":"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":"byok-sep-25","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":"billing-updated-9-15","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}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"#body-content{margin-left:0!important;margin-right:0!important}#body-content,#content-area,#content-container,#navbar>div{max-width:none!important;width:100%!important}#content-container,#navbar>div{margin-left:0!important;margin-right:0!important}.sidebar-group-header{display:none!important}.quickstart-compact-callout .callout{display:inline-flex;width:auto;max-width:100%}table:has(thead th:nth-child(2):last-child){table-layout:fixed;width:100%}table:has(thead th:nth-child(2):last-child) td,table:has(thead th:nth-child(2):last-child) th{width:50%}table:has(thead th:nth-child(2):last-child) td:first-child code{overflow-wrap:anywhere;white-space:normal}"}],"page":{"pagePath":"api-reference/ads/create-a-click-to-whatsapp-ad","slug":"/api-reference/ads/create-a-click-to-whatsapp-ad","pageMetadata":{"title":"Create a click-to-WhatsApp ad","description":"Creates a Meta click-to-WhatsApp ad.","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/ads/ctwa","href":"/api-reference/ads/create-a-click-to-whatsapp-ad","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Creates a Meta click-to-WhatsApp ad.\"\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 click-to-WhatsApp ad","description":"Creates a Meta click-to-WhatsApp ad.","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/ads/ctwa","href":"/api-reference/ads/create-a-click-to-whatsapp-ad","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"createCtwaAd","tags":["Ads"],"summary":"Create a click-to-WhatsApp ad","description":"Creates a Meta click-to-WhatsApp ad.","x-mint":{"metadata":{"title":"Create a click-to-WhatsApp ad"}},"requestBody":"b2c9cf8e-9b92-4f0f-8f3b-f1253307794b","responses":{"201":"f001151b-5b5c-4ca8-977a-ad337ef177c2","401":"23b6b5eb-27ef-498a-b535-68deb0829bc4","422":"23bbb992-f27b-43e7-ab74-5eb4a8587149","500":"f5c650a7-5281-4a73-abde-e2f4ad2de8e0"},"method":"post","type":"path","servers":["61a4257d-edab-4f39-8a0d-6121b074f43f"],"security":["21ce1ac7-d04e-406d-ae14-0e5f305b5738"],"path":"/v1/ads/ctwa","baseUrlOptions":["https://api.kavenio.com"],"title":"Create a click-to-WhatsApp ad","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"example":{"accountId":"bbbbbbbbbbbbbbbb","adAccountId":"ad_account_example","name":"WhatsApp leads","headline":"Message us","body":"Chat with our team.","imageUrl":"https://cdn.example.com/ad.png","budgetAmount":25,"budgetType":"daily"},"schema":{"type":"object","properties":{"accountId":{"type":"string","minLength":16,"maxLength":16,"pattern":"^[abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ]{16}$","isRequired":true,"uniqueKey":"accountId","typeLabel":"string"},"adAccountId":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"adAccountId","typeLabel":"string"},"name":{"type":"string","minLength":1,"maxLength":255,"isRequired":true,"uniqueKey":"name","typeLabel":"string"},"budgetAmount":{"type":"number","exclusiveMinimum":0,"isRequired":true,"uniqueKey":"budgetAmount","typeLabel":"number"},"budgetType":{"type":"string","enum":["daily","lifetime"],"isRequired":true,"uniqueKey":"budgetType","typeLabel":"enum\u003cstring>"},"headline":{"type":"string","minLength":1,"maxLength":255,"uniqueKey":"headline","typeLabel":"string"},"body":{"type":"string","minLength":1,"uniqueKey":"body","typeLabel":"string"},"imageUrl":{"type":"string","format":"uri","uniqueKey":"imageUrl","typeLabel":"string\u003curi>"},"video":{"type":"object","properties":{"url":{"type":"string","format":"uri","isRequired":true,"uniqueKey":"video.url","typeLabel":"string\u003curi>"},"thumbnailUrl":{"type":"string","format":"uri","uniqueKey":"video.thumbnailUrl","typeLabel":"string\u003curi>"}},"required":["url"],"additionalProperties":false,"uniqueKey":"video","typeLabel":"object"},"creatives":{"minItems":1,"type":"array","items":{"type":"object","properties":{"headline":{"type":"string","minLength":1,"maxLength":255,"isRequired":true,"uniqueKey":"creatives.items.[INDEX].headline","typeLabel":"string"},"body":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"creatives.items.[INDEX].body","typeLabel":"string"},"name":{"type":"string","minLength":1,"maxLength":255,"uniqueKey":"creatives.items.[INDEX].name","typeLabel":"string"},"imageUrl":{"type":"string","format":"uri","uniqueKey":"creatives.items.[INDEX].imageUrl","typeLabel":"string\u003curi>"},"video":{"type":"object","properties":{"url":{"type":"string","format":"uri","isRequired":true,"uniqueKey":"creatives.items.[INDEX].video.url","typeLabel":"string\u003curi>"},"thumbnailUrl":{"type":"string","format":"uri","uniqueKey":"creatives.items.[INDEX].video.thumbnailUrl","typeLabel":"string\u003curi>"}},"required":["url"],"additionalProperties":false,"uniqueKey":"creatives.items.[INDEX].video","typeLabel":"object"}},"required":["headline","body"],"additionalProperties":false,"uniqueKey":"creatives.items.[INDEX]","typeLabel":"object"},"uniqueKey":"creatives","typeLabel":"object[]"},"currency":{"type":"string","minLength":3,"maxLength":3,"uniqueKey":"currency","typeLabel":"string"},"endDate":{"type":"string","format":"date-time","pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$","uniqueKey":"endDate","typeLabel":"string\u003cdate-time>"},"countries":{"type":"array","items":{"type":"string","minLength":2,"uniqueKey":"countries.items.[INDEX]","typeLabel":"string"},"uniqueKey":"countries","typeLabel":"string[]"},"cities":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"cities.items.[INDEX].key","typeLabel":"string"},"radius":{"type":"number","exclusiveMinimum":0,"uniqueKey":"cities.items.[INDEX].radius","typeLabel":"number"},"distance_unit":{"type":"string","enum":["mile","kilometer"],"uniqueKey":"cities.items.[INDEX].distance_unit","typeLabel":"enum\u003cstring>"}},"required":["key"],"additionalProperties":false,"uniqueKey":"cities.items.[INDEX]","typeLabel":"object"},"uniqueKey":"cities","typeLabel":"object[]"},"regions":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"regions.items.[INDEX].key","typeLabel":"string"}},"required":["key"],"additionalProperties":false,"uniqueKey":"regions.items.[INDEX]","typeLabel":"object"},"uniqueKey":"regions","typeLabel":"object[]"},"zips":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"zips.items.[INDEX].key","typeLabel":"string"}},"required":["key"],"additionalProperties":false,"uniqueKey":"zips.items.[INDEX]","typeLabel":"object"},"uniqueKey":"zips","typeLabel":"object[]"},"metros":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"metros.items.[INDEX].key","typeLabel":"string"}},"required":["key"],"additionalProperties":false,"uniqueKey":"metros.items.[INDEX]","typeLabel":"object"},"uniqueKey":"metros","typeLabel":"object[]"},"customLocations":{"type":"array","items":{"type":"object","properties":{"latitude":{"type":"number","isRequired":true,"uniqueKey":"customLocations.items.[INDEX].latitude","typeLabel":"number"},"longitude":{"type":"number","isRequired":true,"uniqueKey":"customLocations.items.[INDEX].longitude","typeLabel":"number"},"radius":{"type":"number","exclusiveMinimum":0,"isRequired":true,"uniqueKey":"customLocations.items.[INDEX].radius","typeLabel":"number"},"distanceUnit":{"type":"string","enum":["mile","kilometer"],"isRequired":true,"uniqueKey":"customLocations.items.[INDEX].distanceUnit","typeLabel":"enum\u003cstring>"}},"required":["latitude","longitude","radius","distanceUnit"],"additionalProperties":false,"uniqueKey":"customLocations.items.[INDEX]","typeLabel":"object"},"uniqueKey":"customLocations","typeLabel":"object[]"},"ageMin":{"type":"integer","minimum":13,"maximum":65,"uniqueKey":"ageMin","typeLabel":"integer"},"ageMax":{"type":"integer","minimum":13,"maximum":65,"uniqueKey":"ageMax","typeLabel":"integer"},"interests":{"type":"array","items":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"oneOf":[{}],"uniqueKey":"interests.items.[INDEX].additionalProperties","typeLabel":"any"},"uniqueKey":"interests.items.[INDEX]","typeLabel":"object"},"uniqueKey":"interests","typeLabel":"object[]"},"audienceId":{"type":"string","minLength":1,"uniqueKey":"audienceId","typeLabel":"string"},"advantageAudience":{"oneOf":[{"type":"number","const":0,"uniqueKey":"advantageAudience.oneOf.0","typeLabel":"number"},{"type":"number","const":1,"uniqueKey":"advantageAudience.oneOf.1","typeLabel":"number"}],"uniqueKey":"advantageAudience","typeLabel":"number"},"objective":{"type":"string","enum":["OUTCOME_ENGAGEMENT","OUTCOME_SALES","OUTCOME_LEADS"],"uniqueKey":"objective","typeLabel":"enum\u003cstring>"},"bidStrategy":{"type":"string","enum":["LOWEST_COST_WITHOUT_CAP","LOWEST_COST_WITH_BID_CAP","COST_CAP","LOWEST_COST_WITH_MIN_ROAS"],"uniqueKey":"bidStrategy","typeLabel":"enum\u003cstring>"},"bidAmount":{"type":"number","exclusiveMinimum":0,"uniqueKey":"bidAmount","typeLabel":"number"},"roasAverageFloor":{"type":"number","exclusiveMinimum":0,"uniqueKey":"roasAverageFloor","typeLabel":"number"},"dsaBeneficiary":{"type":"string","maxLength":100,"uniqueKey":"dsaBeneficiary","typeLabel":"string"},"dsaPayor":{"type":"string","maxLength":100,"uniqueKey":"dsaPayor","typeLabel":"string"}},"required":["accountId","adAccountId","name","budgetAmount","budgetType"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"accountId":"bbbbbbbbbbbbbbbb","adAccountId":"ad_account_example","name":"WhatsApp leads","headline":"Message us","body":"Chat with our team.","imageUrl":"https://cdn.example.com/ad.png","budgetAmount":25,"budgetType":"daily"}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"f001151b-5b5c-4ca8-977a-ad337ef177c2":{"description":"Create a click-to-WhatsApp ad completed.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","required":["ok","data"],"properties":{"ok":{"type":"boolean","x-kavenio-const":true,"isRequired":true,"uniqueKey":"oneOf.0.ok","typeLabel":"boolean"},"data":{"oneOf":[{"type":"object","required":["ad"],"properties":{"ad":{"type":"object","properties":{"_id":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"oneOf.0.data.oneOf.0.ad._id","typeLabel":"string"},"name":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"oneOf.0.data.oneOf.0.ad.name","typeLabel":"string"},"platform":{"type":"string","enum":["facebook","instagram","tiktok","linkedin","pinterest","google","twitter"],"isRequired":true,"uniqueKey":"oneOf.0.data.oneOf.0.ad.platform","typeLabel":"enum\u003cstring>"},"status":{"type":"string","enum":["active","paused","pending_review","rejected","completed","cancelled","error"],"isRequired":true,"uniqueKey":"oneOf.0.data.oneOf.0.ad.status","typeLabel":"enum\u003cstring>"},"adType":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"oneOf.0.data.oneOf.0.ad.adType","typeLabel":"string"},"goal":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"oneOf.0.data.oneOf.0.ad.goal","typeLabel":"string"},"isExternal":{"type":"boolean","isRequired":true,"uniqueKey":"oneOf.0.data.oneOf.0.ad.isExternal","typeLabel":"boolean"},"budget":{"type":"object","properties":{"amount":{"type":"number","isRequired":true,"uniqueKey":"oneOf.0.data.oneOf.0.ad.budget.amount","typeLabel":"number"},"type":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"oneOf.0.data.oneOf.0.ad.budget.type","typeLabel":"string"}},"required":["amount","type"],"additionalProperties":false,"isRequired":true,"uniqueKey":"oneOf.0.data.oneOf.0.ad.budget","typeLabel":"object"},"metrics":{"type":"object","properties":{"spend":{"type":"number","isRequired":true,"uniqueKey":"oneOf.0.data.oneOf.0.ad.metrics.spend","typeLabel":"number"},"impressions":{"type":"number","isRequired":true,"uniqueKey":"oneOf.0.data.oneOf.0.ad.metrics.impressions","typeLabel":"number"},"reach":{"type":"number","isRequired":true,"uniqueKey":"oneOf.0.data.oneOf.0.ad.metrics.reach","typeLabel":"number"},"clicks":{"type":"number","isRequired":true,"uniqueKey":"oneOf.0.data.oneOf.0.ad.metrics.clicks","typeLabel":"number"},"ctr":{"type":"number","isRequired":true,"uniqueKey":"oneOf.0.data.oneOf.0.ad.metrics.ctr","typeLabel":"number"},"cpc":{"type":"number","isRequired":true,"uniqueKey":"oneOf.0.data.oneOf.0.ad.metrics.cpc","typeLabel":"number"},"cpm":{"type":"number","isRequired":true,"uniqueKey":"oneOf.0.data.oneOf.0.ad.metrics.cpm","typeLabel":"number"},"engagement":{"type":"number","isRequired":true,"uniqueKey":"oneOf.0.data.oneOf.0.ad.metrics.engagement","typeLabel":"number"},"conversions":{"type":"number","isRequired":true,"uniqueKey":"oneOf.0.data.oneOf.0.ad.metrics.conversions","typeLabel":"number"},"costPerConversion":{"type":"number","isRequired":true,"uniqueKey":"oneOf.0.data.oneOf.0.ad.metrics.costPerConversion","typeLabel":"number"},"actions":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"number","uniqueKey":"oneOf.0.data.oneOf.0.ad.metrics.actions.additionalProperties","typeLabel":"number"},"isRequired":true,"uniqueKey":"oneOf.0.data.oneOf.0.ad.metrics.actions","typeLabel":"object"},"actionValues":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"number","uniqueKey":"oneOf.0.data.oneOf.0.ad.metrics.actionValues.additionalProperties","typeLabel":"number"},"isRequired":true,"uniqueKey":"oneOf.0.data.oneOf.0.ad.metrics.actionValues","typeLabel":"object"},"purchaseValue":{"type":"number","isRequired":true,"uniqueKey":"oneOf.0.data.oneOf.0.ad.metrics.purchaseValue","typeLabel":"number"},"roas":{"type":"number","isRequired":true,"uniqueKey":"oneOf.0.data.oneOf.0.ad.metrics.roas","typeLabel":"number"},"lastSyncedAt":{"type":"string","minLength":1,"uniqueKey":"oneOf.0.data.oneOf.0.ad.metrics.lastSyncedAt","typeLabel":"string"}},"required":["spend","impressions","reach","clicks","ctr","cpc","cpm","engagement","conversions","costPerConversion","actions","actionValues","purchaseValue","roas"],"additionalProperties":false,"isRequired":true,"uniqueKey":"oneOf.0.data.oneOf.0.ad.metrics","typeLabel":"object"},"promotedObject":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"oneOf":[{}],"uniqueKey":"oneOf.0.data.oneOf.0.ad.promotedObject.additionalProperties","typeLabel":"any"},"isRequired":true,"uniqueKey":"oneOf.0.data.oneOf.0.ad.promotedObject","typeLabel":"object"},"creative":{"type":"object","properties":{"thumbnailUrl":{"type":"string","uniqueKey":"oneOf.0.data.oneOf.0.ad.creative.thumbnailUrl","typeLabel":"string"},"imageUrl":{"type":"string","uniqueKey":"oneOf.0.data.oneOf.0.ad.creative.imageUrl","typeLabel":"string"},"videoId":{"type":"string","uniqueKey":"oneOf.0.data.oneOf.0.ad.creative.videoId","typeLabel":"string"},"videoUrl":{"type":"string","uniqueKey":"oneOf.0.data.oneOf.0.ad.creative.videoUrl","typeLabel":"string"},"objectType":{"type":"string","uniqueKey":"oneOf.0.data.oneOf.0.ad.creative.objectType","typeLabel":"string"},"objectStoryId":{"type":"string","uniqueKey":"oneOf.0.data.oneOf.0.ad.creative.objectStoryId","typeLabel":"string"},"effectiveObjectStoryId":{"type":"string","uniqueKey":"oneOf.0.data.oneOf.0.ad.creative.effectiveObjectStoryId","typeLabel":"string"},"effectiveInstagramMediaId":{"type":"string","uniqueKey":"oneOf.0.data.oneOf.0.ad.creative.effectiveInstagramMediaId","typeLabel":"string"},"instagramUserId":{"type":"string","uniqueKey":"oneOf.0.data.oneOf.0.ad.creative.instagramUserId","typeLabel":"string"},"instagramPermalinkUrl":{"type":"string","uniqueKey":"oneOf.0.data.oneOf.0.ad.creative.instagramPermalinkUrl","typeLabel":"string"},"mediaUrls":{"type":"array","items":{"type":"string","uniqueKey":"oneOf.0.data.oneOf.0.ad.creative.mediaUrls.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.0.data.oneOf.0.ad.creative.mediaUrls","typeLabel":"string[]"},"body":{"type":"string","uniqueKey":"oneOf.0.data.oneOf.0.ad.creative.body","typeLabel":"string"},"googleHeadline":{"type":"string","uniqueKey":"oneOf.0.data.oneOf.0.ad.creative.googleHeadline","typeLabel":"string"},"googleDescription":{"type":"string","uniqueKey":"oneOf.0.data.oneOf.0.ad.creative.googleDescription","typeLabel":"string"},"linkUrl":{"type":"string","uniqueKey":"oneOf.0.data.oneOf.0.ad.creative.linkUrl","typeLabel":"string"},"pinterestImageUrl":{"type":"string","uniqueKey":"oneOf.0.data.oneOf.0.ad.creative.pinterestImageUrl","typeLabel":"string"},"pinterestTitle":{"type":"string","uniqueKey":"oneOf.0.data.oneOf.0.ad.creative.pinterestTitle","typeLabel":"string"},"pinterestDescription":{"type":"string","uniqueKey":"oneOf.0.data.oneOf.0.ad.creative.pinterestDescription","typeLabel":"string"}},"additionalProperties":{"oneOf":[{}],"uniqueKey":"oneOf.0.data.oneOf.0.ad.creative.additionalProperties","typeLabel":"any"},"isRequired":true,"uniqueKey":"oneOf.0.data.oneOf.0.ad.creative","typeLabel":"object"},"targeting":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"oneOf":[{}],"uniqueKey":"oneOf.0.data.oneOf.0.ad.targeting.additionalProperties","typeLabel":"any"},"isRequired":true,"uniqueKey":"oneOf.0.data.oneOf.0.ad.targeting","typeLabel":"object"},"schedule":{"type":"object","properties":{"startDate":{"type":"string","minLength":1,"uniqueKey":"oneOf.0.data.oneOf.0.ad.schedule.startDate","typeLabel":"string"},"endDate":{"type":"string","minLength":1,"uniqueKey":"oneOf.0.data.oneOf.0.ad.schedule.endDate","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"oneOf.0.data.oneOf.0.ad.schedule","typeLabel":"object"},"createdAt":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"oneOf.0.data.oneOf.0.ad.createdAt","typeLabel":"string"},"updatedAt":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"oneOf.0.data.oneOf.0.ad.updatedAt","typeLabel":"string"},"platformAdId":{"type":"string","minLength":1,"uniqueKey":"oneOf.0.data.oneOf.0.ad.platformAdId","typeLabel":"string"},"platformAdAccountId":{"type":"string","minLength":1,"uniqueKey":"oneOf.0.data.oneOf.0.ad.platformAdAccountId","typeLabel":"string"},"platformCampaignId":{"type":"string","minLength":1,"uniqueKey":"oneOf.0.data.oneOf.0.ad.platformCampaignId","typeLabel":"string"},"platformAdSetId":{"type":"string","minLength":1,"uniqueKey":"oneOf.0.data.oneOf.0.ad.platformAdSetId","typeLabel":"string"},"campaignName":{"type":"string","minLength":1,"uniqueKey":"oneOf.0.data.oneOf.0.ad.campaignName","typeLabel":"string"},"adSetName":{"type":"string","minLength":1,"uniqueKey":"oneOf.0.data.oneOf.0.ad.adSetName","typeLabel":"string"},"platformObjective":{"type":"string","minLength":1,"uniqueKey":"oneOf.0.data.oneOf.0.ad.platformObjective","typeLabel":"string"},"optimizationGoal":{"type":"string","minLength":1,"uniqueKey":"oneOf.0.data.oneOf.0.ad.optimizationGoal","typeLabel":"string"},"platformAdAccountName":{"type":"string","minLength":1,"uniqueKey":"oneOf.0.data.oneOf.0.ad.platformAdAccountName","typeLabel":"string"},"platformCreatedAt":{"type":"string","minLength":1,"uniqueKey":"oneOf.0.data.oneOf.0.ad.platformCreatedAt","typeLabel":"string"},"bidStrategy":{"type":"string","minLength":1,"uniqueKey":"oneOf.0.data.oneOf.0.ad.bidStrategy","typeLabel":"string"},"bidAmount":{"type":"number","uniqueKey":"oneOf.0.data.oneOf.0.ad.bidAmount","typeLabel":"number"},"roasAverageFloor":{"type":"number","uniqueKey":"oneOf.0.data.oneOf.0.ad.roasAverageFloor","typeLabel":"number"},"rejectionReason":{"type":"string","minLength":1,"uniqueKey":"oneOf.0.data.oneOf.0.ad.rejectionReason","typeLabel":"string"}},"required":["_id","name","platform","status","adType","goal","isExternal","budget","metrics","promotedObject","creative","targeting","schedule","createdAt","updatedAt"],"additionalProperties":false,"isRequired":true,"uniqueKey":"oneOf.0.data.oneOf.0.ad","typeLabel":"object"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"oneOf.0.data.oneOf.0","typeLabel":"object"},{"type":"object","required":["ads","platformCampaignId","platformAdSetId"],"properties":{"ads":{"minItems":1,"type":"array","items":{"type":"object","properties":{"_id":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"oneOf.0.data.oneOf.1.ads.items.[INDEX]._id","typeLabel":"string"},"name":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"oneOf.0.data.oneOf.1.ads.items.[INDEX].name","typeLabel":"string"},"platform":{"type":"string","enum":["facebook","instagram","tiktok","linkedin","pinterest","google","twitter"],"isRequired":true,"uniqueKey":"oneOf.0.data.oneOf.1.ads.items.[INDEX].platform","typeLabel":"enum\u003cstring>"},"status":{"type":"string","enum":["active","paused","pending_review","rejected","completed","cancelled","error"],"isRequired":true,"uniqueKey":"oneOf.0.data.oneOf.1.ads.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"adType":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"oneOf.0.data.oneOf.1.ads.items.[INDEX].adType","typeLabel":"string"},"goal":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"oneOf.0.data.oneOf.1.ads.items.[INDEX].goal","typeLabel":"string"},"isExternal":{"type":"boolean","isRequired":true,"uniqueKey":"oneOf.0.data.oneOf.1.ads.items.[INDEX].isExternal","typeLabel":"boolean"},"budget":{"type":"object","properties":{"amount":{"type":"number","isRequired":true,"uniqueKey":"oneOf.0.data.oneOf.1.ads.items.[INDEX].budget.amount","typeLabel":"number"},"type":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"oneOf.0.data.oneOf.1.ads.items.[INDEX].budget.type","typeLabel":"string"}},"required":["amount","type"],"additionalProperties":false,"isRequired":true,"uniqueKey":"oneOf.0.data.oneOf.1.ads.items.[INDEX].budget","typeLabel":"object"},"metrics":{"type":"object","properties":{"spend":{"type":"number","isRequired":true,"uniqueKey":"oneOf.0.data.oneOf.1.ads.items.[INDEX].metrics.spend","typeLabel":"number"},"impressions":{"type":"number","isRequired":true,"uniqueKey":"oneOf.0.data.oneOf.1.ads.items.[INDEX].metrics.impressions","typeLabel":"number"},"reach":{"type":"number","isRequired":true,"uniqueKey":"oneOf.0.data.oneOf.1.ads.items.[INDEX].metrics.reach","typeLabel":"number"},"clicks":{"type":"number","isRequired":true,"uniqueKey":"oneOf.0.data.oneOf.1.ads.items.[INDEX].metrics.clicks","typeLabel":"number"},"ctr":{"type":"number","isRequired":true,"uniqueKey":"oneOf.0.data.oneOf.1.ads.items.[INDEX].metrics.ctr","typeLabel":"number"},"cpc":{"type":"number","isRequired":true,"uniqueKey":"oneOf.0.data.oneOf.1.ads.items.[INDEX].metrics.cpc","typeLabel":"number"},"cpm":{"type":"number","isRequired":true,"uniqueKey":"oneOf.0.data.oneOf.1.ads.items.[INDEX].metrics.cpm","typeLabel":"number"},"engagement":{"type":"number","isRequired":true,"uniqueKey":"oneOf.0.data.oneOf.1.ads.items.[INDEX].metrics.engagement","typeLabel":"number"},"conversions":{"type":"number","isRequired":true,"uniqueKey":"oneOf.0.data.oneOf.1.ads.items.[INDEX].metrics.conversions","typeLabel":"number"},"costPerConversion":{"type":"number","isRequired":true,"uniqueKey":"oneOf.0.data.oneOf.1.ads.items.[INDEX].metrics.costPerConversion","typeLabel":"number"},"actions":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"number","uniqueKey":"oneOf.0.data.oneOf.1.ads.items.[INDEX].metrics.actions.additionalProperties","typeLabel":"number"},"isRequired":true,"uniqueKey":"oneOf.0.data.oneOf.1.ads.items.[INDEX].metrics.actions","typeLabel":"object"},"actionValues":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"number","uniqueKey":"oneOf.0.data.oneOf.1.ads.items.[INDEX].metrics.actionValues.additionalProperties","typeLabel":"number"},"isRequired":true,"uniqueKey":"oneOf.0.data.oneOf.1.ads.items.[INDEX].metrics.actionValues","typeLabel":"object"},"purchaseValue":{"type":"number","isRequired":true,"uniqueKey":"oneOf.0.data.oneOf.1.ads.items.[INDEX].metrics.purchaseValue","typeLabel":"number"},"roas":{"type":"number","isRequired":true,"uniqueKey":"oneOf.0.data.oneOf.1.ads.items.[INDEX].metrics.roas","typeLabel":"number"},"lastSyncedAt":{"type":"string","minLength":1,"uniqueKey":"oneOf.0.data.oneOf.1.ads.items.[INDEX].metrics.lastSyncedAt","typeLabel":"string"}},"required":["spend","impressions","reach","clicks","ctr","cpc","cpm","engagement","conversions","costPerConversion","actions","actionValues","purchaseValue","roas"],"additionalProperties":false,"isRequired":true,"uniqueKey":"oneOf.0.data.oneOf.1.ads.items.[INDEX].metrics","typeLabel":"object"},"promotedObject":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"oneOf":[{}],"uniqueKey":"oneOf.0.data.oneOf.1.ads.items.[INDEX].promotedObject.additionalProperties","typeLabel":"any"},"isRequired":true,"uniqueKey":"oneOf.0.data.oneOf.1.ads.items.[INDEX].promotedObject","typeLabel":"object"},"creative":{"type":"object","properties":{"thumbnailUrl":{"type":"string","uniqueKey":"oneOf.0.data.oneOf.1.ads.items.[INDEX].creative.thumbnailUrl","typeLabel":"string"},"imageUrl":{"type":"string","uniqueKey":"oneOf.0.data.oneOf.1.ads.items.[INDEX].creative.imageUrl","typeLabel":"string"},"videoId":{"type":"string","uniqueKey":"oneOf.0.data.oneOf.1.ads.items.[INDEX].creative.videoId","typeLabel":"string"},"videoUrl":{"type":"string","uniqueKey":"oneOf.0.data.oneOf.1.ads.items.[INDEX].creative.videoUrl","typeLabel":"string"},"objectType":{"type":"string","uniqueKey":"oneOf.0.data.oneOf.1.ads.items.[INDEX].creative.objectType","typeLabel":"string"},"objectStoryId":{"type":"string","uniqueKey":"oneOf.0.data.oneOf.1.ads.items.[INDEX].creative.objectStoryId","typeLabel":"string"},"effectiveObjectStoryId":{"type":"string","uniqueKey":"oneOf.0.data.oneOf.1.ads.items.[INDEX].creative.effectiveObjectStoryId","typeLabel":"string"},"effectiveInstagramMediaId":{"type":"string","uniqueKey":"oneOf.0.data.oneOf.1.ads.items.[INDEX].creative.effectiveInstagramMediaId","typeLabel":"string"},"instagramUserId":{"type":"string","uniqueKey":"oneOf.0.data.oneOf.1.ads.items.[INDEX].creative.instagramUserId","typeLabel":"string"},"instagramPermalinkUrl":{"type":"string","uniqueKey":"oneOf.0.data.oneOf.1.ads.items.[INDEX].creative.instagramPermalinkUrl","typeLabel":"string"},"mediaUrls":{"type":"array","items":{"type":"string","uniqueKey":"oneOf.0.data.oneOf.1.ads.items.[INDEX].creative.mediaUrls.items.[INDEX]","typeLabel":"string"},"uniqueKey":"oneOf.0.data.oneOf.1.ads.items.[INDEX].creative.mediaUrls","typeLabel":"string[]"},"body":{"type":"string","uniqueKey":"oneOf.0.data.oneOf.1.ads.items.[INDEX].creative.body","typeLabel":"string"},"googleHeadline":{"type":"string","uniqueKey":"oneOf.0.data.oneOf.1.ads.items.[INDEX].creative.googleHeadline","typeLabel":"string"},"googleDescription":{"type":"string","uniqueKey":"oneOf.0.data.oneOf.1.ads.items.[INDEX].creative.googleDescription","typeLabel":"string"},"linkUrl":{"type":"string","uniqueKey":"oneOf.0.data.oneOf.1.ads.items.[INDEX].creative.linkUrl","typeLabel":"string"},"pinterestImageUrl":{"type":"string","uniqueKey":"oneOf.0.data.oneOf.1.ads.items.[INDEX].creative.pinterestImageUrl","typeLabel":"string"},"pinterestTitle":{"type":"string","uniqueKey":"oneOf.0.data.oneOf.1.ads.items.[INDEX].creative.pinterestTitle","typeLabel":"string"},"pinterestDescription":{"type":"string","uniqueKey":"oneOf.0.data.oneOf.1.ads.items.[INDEX].creative.pinterestDescription","typeLabel":"string"}},"additionalProperties":{"oneOf":[{}],"uniqueKey":"oneOf.0.data.oneOf.1.ads.items.[INDEX].creative.additionalProperties","typeLabel":"any"},"isRequired":true,"uniqueKey":"oneOf.0.data.oneOf.1.ads.items.[INDEX].creative","typeLabel":"object"},"targeting":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"oneOf":[{}],"uniqueKey":"oneOf.0.data.oneOf.1.ads.items.[INDEX].targeting.additionalProperties","typeLabel":"any"},"isRequired":true,"uniqueKey":"oneOf.0.data.oneOf.1.ads.items.[INDEX].targeting","typeLabel":"object"},"schedule":{"type":"object","properties":{"startDate":{"type":"string","minLength":1,"uniqueKey":"oneOf.0.data.oneOf.1.ads.items.[INDEX].schedule.startDate","typeLabel":"string"},"endDate":{"type":"string","minLength":1,"uniqueKey":"oneOf.0.data.oneOf.1.ads.items.[INDEX].schedule.endDate","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"oneOf.0.data.oneOf.1.ads.items.[INDEX].schedule","typeLabel":"object"},"createdAt":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"oneOf.0.data.oneOf.1.ads.items.[INDEX].createdAt","typeLabel":"string"},"updatedAt":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"oneOf.0.data.oneOf.1.ads.items.[INDEX].updatedAt","typeLabel":"string"},"platformAdId":{"type":"string","minLength":1,"uniqueKey":"oneOf.0.data.oneOf.1.ads.items.[INDEX].platformAdId","typeLabel":"string"},"platformAdAccountId":{"type":"string","minLength":1,"uniqueKey":"oneOf.0.data.oneOf.1.ads.items.[INDEX].platformAdAccountId","typeLabel":"string"},"platformCampaignId":{"type":"string","minLength":1,"uniqueKey":"oneOf.0.data.oneOf.1.ads.items.[INDEX].platformCampaignId","typeLabel":"string"},"platformAdSetId":{"type":"string","minLength":1,"uniqueKey":"oneOf.0.data.oneOf.1.ads.items.[INDEX].platformAdSetId","typeLabel":"string"},"campaignName":{"type":"string","minLength":1,"uniqueKey":"oneOf.0.data.oneOf.1.ads.items.[INDEX].campaignName","typeLabel":"string"},"adSetName":{"type":"string","minLength":1,"uniqueKey":"oneOf.0.data.oneOf.1.ads.items.[INDEX].adSetName","typeLabel":"string"},"platformObjective":{"type":"string","minLength":1,"uniqueKey":"oneOf.0.data.oneOf.1.ads.items.[INDEX].platformObjective","typeLabel":"string"},"optimizationGoal":{"type":"string","minLength":1,"uniqueKey":"oneOf.0.data.oneOf.1.ads.items.[INDEX].optimizationGoal","typeLabel":"string"},"platformAdAccountName":{"type":"string","minLength":1,"uniqueKey":"oneOf.0.data.oneOf.1.ads.items.[INDEX].platformAdAccountName","typeLabel":"string"},"platformCreatedAt":{"type":"string","minLength":1,"uniqueKey":"oneOf.0.data.oneOf.1.ads.items.[INDEX].platformCreatedAt","typeLabel":"string"},"bidStrategy":{"type":"string","minLength":1,"uniqueKey":"oneOf.0.data.oneOf.1.ads.items.[INDEX].bidStrategy","typeLabel":"string"},"bidAmount":{"type":"number","uniqueKey":"oneOf.0.data.oneOf.1.ads.items.[INDEX].bidAmount","typeLabel":"number"},"roasAverageFloor":{"type":"number","uniqueKey":"oneOf.0.data.oneOf.1.ads.items.[INDEX].roasAverageFloor","typeLabel":"number"},"rejectionReason":{"type":"string","minLength":1,"uniqueKey":"oneOf.0.data.oneOf.1.ads.items.[INDEX].rejectionReason","typeLabel":"string"}},"required":["_id","name","platform","status","adType","goal","isExternal","budget","metrics","promotedObject","creative","targeting","schedule","createdAt","updatedAt"],"additionalProperties":false,"uniqueKey":"oneOf.0.data.oneOf.1.ads.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"oneOf.0.data.oneOf.1.ads","typeLabel":"object[]"},"platformCampaignId":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"oneOf.0.data.oneOf.1.platformCampaignId","typeLabel":"string"},"platformAdSetId":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"oneOf.0.data.oneOf.1.platformAdSetId","typeLabel":"string"},"message":{"type":"string","minLength":1,"uniqueKey":"oneOf.0.data.oneOf.1.message","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"oneOf.0.data.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"oneOf.0.data","typeLabel":"object"}},"additionalProperties":false,"uniqueKey":"oneOf.0","typeLabel":"object"},{"type":"object","required":["ok","error"],"properties":{"ok":{"type":"boolean","x-kavenio-const":false,"isRequired":true,"uniqueKey":"oneOf.1.ok","typeLabel":"boolean"},"error":{"type":"object","properties":{"code":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"oneOf.1.error.code","typeLabel":"string"},"message":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"oneOf.1.error.message","typeLabel":"string"},"details":{"oneOf":[{}],"uniqueKey":"oneOf.1.error.details","typeLabel":"any"}},"required":["code","message"],"additionalProperties":false,"isRequired":true,"uniqueKey":"oneOf.1.error","typeLabel":"object"}},"additionalProperties":false,"uniqueKey":"oneOf.1","typeLabel":"object"}],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"ok":true,"data":{"ad":{"_id":"\u003cstring>","name":"\u003cstring>","platform":"facebook","status":"active","adType":"\u003cstring>","goal":"\u003cstring>","isExternal":true,"budget":{"amount":123,"type":"\u003cstring>"},"metrics":{"spend":123,"impressions":123,"reach":123,"clicks":123,"ctr":123,"cpc":123,"cpm":123,"engagement":123,"conversions":123,"costPerConversion":123,"actions":{},"actionValues":{},"purchaseValue":123,"roas":123,"lastSyncedAt":"\u003cstring>"},"promotedObject":{},"creative":{"thumbnailUrl":"\u003cstring>","imageUrl":"\u003cstring>","videoId":"\u003cstring>","videoUrl":"\u003cstring>","objectType":"\u003cstring>","objectStoryId":"\u003cstring>","effectiveObjectStoryId":"\u003cstring>","effectiveInstagramMediaId":"\u003cstring>","instagramUserId":"\u003cstring>","instagramPermalinkUrl":"\u003cstring>","mediaUrls":["\u003cstring>"],"body":"\u003cstring>","googleHeadline":"\u003cstring>","googleDescription":"\u003cstring>","linkUrl":"\u003cstring>","pinterestImageUrl":"\u003cstring>","pinterestTitle":"\u003cstring>","pinterestDescription":"\u003cstring>"},"targeting":{},"schedule":{"startDate":"\u003cstring>","endDate":"\u003cstring>"},"createdAt":"\u003cstring>","updatedAt":"\u003cstring>","platformAdId":"\u003cstring>","platformAdAccountId":"\u003cstring>","platformCampaignId":"\u003cstring>","platformAdSetId":"\u003cstring>","campaignName":"\u003cstring>","adSetName":"\u003cstring>","platformObjective":"\u003cstring>","optimizationGoal":"\u003cstring>","platformAdAccountName":"\u003cstring>","platformCreatedAt":"\u003cstring>","bidStrategy":"\u003cstring>","bidAmount":123,"roasAverageFloor":123,"rejectionReason":"\u003cstring>"}}}}},"exampleType":"generated"}},"exampleType":"generated"},"23b6b5eb-27ef-498a-b535-68deb0829bc4":{"description":"Authentication failed.","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean","x-kavenio-const":false,"isRequired":true,"uniqueKey":"ok","typeLabel":"boolean"},"error":{"type":"object","properties":{"code":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"oneOf":[{}],"uniqueKey":"error.details","typeLabel":"any"}},"required":["code","message"],"additionalProperties":false,"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["ok","error"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"ok":true,"error":{"code":"\u003cstring>","message":"\u003cstring>","details":"\u003cunknown>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"23bbb992-f27b-43e7-ab74-5eb4a8587149":{"description":"Request validation failed.","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean","x-kavenio-const":false,"isRequired":true,"uniqueKey":"ok","typeLabel":"boolean"},"error":{"type":"object","properties":{"code":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"oneOf":[{}],"uniqueKey":"error.details","typeLabel":"any"}},"required":["code","message"],"additionalProperties":false,"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["ok","error"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"ok":true,"error":{"code":"\u003cstring>","message":"\u003cstring>","details":"\u003cunknown>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"f5c650a7-5281-4a73-abde-e2f4ad2de8e0":{"description":"Request failed.","content":{"application/json":{"schema":{"type":"object","properties":{"ok":{"type":"boolean","x-kavenio-const":false,"isRequired":true,"uniqueKey":"ok","typeLabel":"boolean"},"error":{"type":"object","properties":{"code":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"oneOf":[{}],"uniqueKey":"error.details","typeLabel":"any"}},"required":["code","message"],"additionalProperties":false,"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["ok","error"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"ok":true,"error":{"code":"\u003cstring>","message":"\u003cstring>","details":"\u003cunknown>"}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"21ce1ac7-d04e-406d-ae14-0e5f305b5738":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"Clerk session or OAuth token","scopes":[]}}},"servers":{"61a4257d-edab-4f39-8a0d-6121b074f43f":{"url":"https://api.kavenio.com"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"Clerk session or OAuth token","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"api/openapi.json"},"subdomain":"kavenio","siteName":"Kavenio","title":"Create a click-to-WhatsApp ad - Kavenio","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-07-30T11:51:29.632Z","originalFileLocation":"api-reference/ads/create-a-click-to-whatsapp-ad.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=\"light\";if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"light\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Creates a Meta click-to-WhatsApp ad.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Kavenio\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/kavenio/_generated/favicon/apple-touch-icon.png?v=3\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/kavenio/_generated/favicon/favicon-32x32.png?v=3\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/kavenio/_generated/favicon/favicon-16x16.png?v=3\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"https://mintlify.s3.us-west-1.amazonaws.com/kavenio/_generated/favicon/favicon.ico?v=3\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create a click-to-WhatsApp ad - Kavenio\">\u003cmeta data-mint-head property=\"og:description\" content=\"Creates a Meta click-to-WhatsApp ad.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Kavenio\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://kavenio.com/docs/api-reference/ads/create-a-click-to-whatsapp-ad\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://kavenio.mintlify.app/_mintlify/api/og/v2?division=Ads\u0026amp;title=Create+a+click-to-WhatsApp+ad\u0026amp;description=Creates+a+Meta+click-to-WhatsApp+ad.\u0026amp;theme=9fae6bc4bbb48f9b0e73f472\u0026amp;signature=5c88f2e97f17b316cb4d9c8d30daa8d68b4cbea2ddf9733b3f9fa7515fc5e512\">\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 click-to-WhatsApp ad - Kavenio\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Creates a Meta click-to-WhatsApp ad.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://kavenio.mintlify.app/_mintlify/api/og/v2?division=Ads\u0026amp;title=Create+a+click-to-WhatsApp+ad\u0026amp;description=Creates+a+Meta+click-to-WhatsApp+ad.\u0026amp;theme=9fae6bc4bbb48f9b0e73f472\u0026amp;signature=5c88f2e97f17b316cb4d9c8d30daa8d68b4cbea2ddf9733b3f9fa7515fc5e512\">\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=\"https://mintlify.s3.us-west-1.amazonaws.com/kavenio/_generated/favicon/browserconfig.xml?v=3\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Kavenio\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#111827\">\u003clink data-mint-head rel=\"canonical\" href=\"https://kavenio.com/docs/api-reference/ads/create-a-click-to-whatsapp-ad\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/docs/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/docs/api-reference/ads/create-a-click-to-whatsapp-ad.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://kavenio.com/#organization\",\"name\":\"Kavenio\",\"url\":\"https://kavenio.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/kavenio/2b-EvfPCz2lVvy_Y/logo/kavenio-light.svg?fit=max\u0026auto=format\u0026n=2b-EvfPCz2lVvy_Y\u0026q=85\u0026s=4d05ac261edfadda2151f002652c7183\"}},{\"@type\":\"WebSite\",\"@id\":\"https://kavenio.com/docs#website\",\"name\":\"Kavenio\",\"url\":\"https://kavenio.com/docs\",\"publisher\":{\"@id\":\"https://kavenio.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://kavenio.com/docs/api-reference/ads/create-a-click-to-whatsapp-ad#webpage\",\"url\":\"https://kavenio.com/docs/api-reference/ads/create-a-click-to-whatsapp-ad\",\"name\":\"Create a click-to-WhatsApp ad\",\"description\":\"Creates a Meta click-to-WhatsApp ad.\",\"dateModified\":\"2026-07-30T11:51:29.632Z\",\"isPartOf\":{\"@id\":\"https://kavenio.com/docs#website\"},\"breadcrumb\":{\"@id\":\"https://kavenio.com/docs/api-reference/ads/create-a-click-to-whatsapp-ad#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://kavenio.com/docs/api-reference/ads/create-a-click-to-whatsapp-ad#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Documentation\",\"item\":\"https://kavenio.com/docs/index\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"API\",\"item\":\"https://kavenio.com/docs/api/overview\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Reference\",\"item\":\"https://kavenio.com/docs/api-reference/integrations/get-integration-identity\"},{\"@type\":\"ListItem\",\"position\":4,\"name\":\"Ads\",\"item\":\"https://kavenio.com/docs/api-reference/ads/list-ad-accounts\"},{\"@type\":\"ListItem\",\"position\":5,\"name\":\"Create a click-to-WhatsApp ad\",\"item\":\"https://kavenio.com/docs/api-reference/ads/create-a-click-to-whatsapp-ad\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://kavenio.com/docs/api-reference/ads/create-a-click-to-whatsapp-ad#apireference\",\"headline\":\"Create a click-to-WhatsApp ad\",\"name\":\"Create a click-to-WhatsApp ad\",\"description\":\"Creates a Meta click-to-WhatsApp ad.\",\"url\":\"https://kavenio.com/docs/api-reference/ads/create-a-click-to-whatsapp-ad\",\"mainEntityOfPage\":{\"@id\":\"https://kavenio.com/docs/api-reference/ads/create-a-click-to-whatsapp-ad#webpage\"},\"dateModified\":\"2026-07-30T11:51:29.632Z\",\"publisher\":{\"@id\":\"https://kavenio.com/#organization\"},\"isPartOf\":{\"@id\":\"https://kavenio.com/docs#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Kavenio\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Kavenio","nav":{"global":null,"directory":"card","groups":[{"group":"Documentation","pages":[{"group":"Get started","expanded":false,"pages":[{"title":"Quickstart","sidebarTitle":"Human quickstart","icon":"user","mode":"wide","href":"/index"},{"title":"Agent quickstart","icon":"bot","mode":"wide","href":"/quickstart-agents"}]},{"title":"CLI","mode":"wide","href":"/cli/overview"},{"group":"SDK","expanded":false,"pages":[{"title":"Overview","mode":"wide","href":"/sdk/overview"},{"title":"Node SDK","icon":"js","mode":"wide","href":"/sdk/node"}]},{"group":"API","expanded":false,"directory":"none","pages":[{"title":"API Introduction","mode":"wide","href":"/api/overview"},{"title":"Authentication","mode":"wide","href":"/api/authentication"},{"title":"Connected accounts","mode":"wide","href":"/api/connected-accounts"},{"title":"Analytics","mode":"wide","href":"/api/analytics"},{"title":"Media","mode":"wide","href":"/api/media"},{"title":"Idempotency","mode":"wide","href":"/api/idempotency"},{"group":"Reference","pages":[{"group":"Integrations","pages":[{"title":"Get integration identity","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/integrations/me","href":"/api-reference/integrations/get-integration-identity"},{"title":"List integration subscriptions","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/integrations/subscriptions","href":"/api-reference/integrations/list-integration-subscriptions"},{"title":"Create integration subscription","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/integrations/subscriptions","href":"/api-reference/integrations/create-integration-subscription"},{"title":"Delete integration subscription","deprecated":null,"version":null,"openapi":"/api/openapi.json delete /v1/integrations/subscriptions/{subscriptionId}","href":"/api-reference/integrations/delete-integration-subscription"},{"title":"List recent integration events","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/integrations/events","href":"/api-reference/integrations/list-recent-integration-events"}]},{"group":"API keys","pages":[{"title":"List API keys","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/api-keys","href":"/api-reference/api-keys/list-api-keys"},{"title":"Create API key","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/api-keys","href":"/api-reference/api-keys/create-an-api-key"},{"title":"Revoke API key","deprecated":null,"version":null,"openapi":"/api/openapi.json delete /v1/api-keys/{apiKeyId}","href":"/api-reference/api-keys/revoke-an-api-key"}]},{"group":"Feature requests","pages":[{"title":"Create feature request","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/feature-requests","href":"/api-reference/feature-requests/create-a-feature-request"}]},{"group":"Posts","pages":[{"title":"List posts","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/posts","href":"/api-reference/posts/list-posts"},{"title":"Create post","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/posts","href":"/api-reference/posts/create-a-post"},{"title":"Bulk upload posts","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/posts/bulk-upload","href":"/api-reference/posts/bulk-upload-posts"},{"title":"Get post analytics","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/posts/{postId}/analytics","href":"/api-reference/posts/get-post-analytics"},{"title":"List post comments","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/posts/{postId}/comments","href":"/api-reference/posts/list-post-comments"},{"title":"Delete post comment","deprecated":null,"version":null,"openapi":"/api/openapi.json delete /v1/posts/{postId}/comments","href":"/api-reference/posts/delete-a-post-comment"},{"title":"Reply to post comment","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/posts/{postId}/comments/reply","href":"/api-reference/posts/reply-to-a-post-comment"},{"title":"Like post comment","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/posts/{postId}/comments/like","href":"/api-reference/posts/like-a-post-comment"},{"title":"Unlike post comment","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/posts/{postId}/comments/unlike","href":"/api-reference/posts/unlike-a-post-comment"},{"title":"Get post","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/posts/{postId}","href":"/api-reference/posts/get-a-post"},{"title":"Replace post","deprecated":null,"version":null,"openapi":"/api/openapi.json put /v1/posts/{postId}","href":"/api-reference/posts/replace-post-fields"},{"title":"Delete post","deprecated":null,"version":null,"openapi":"/api/openapi.json delete /v1/posts/{postId}","href":"/api-reference/posts/delete-a-post"},{"title":"Update post","deprecated":null,"version":null,"openapi":"/api/openapi.json patch /v1/posts/{postId}","href":"/api-reference/posts/update-a-post"},{"title":"Retry post","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/posts/{postId}/retry","href":"/api-reference/posts/retry-post-publishing"},{"title":"Unpublish post","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/posts/{postId}/unpublish","href":"/api-reference/posts/unpublish-a-post"},{"title":"Edit published post","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/posts/{postId}/edit","href":"/api-reference/posts/edit-a-published-post"}]},{"group":"Queue","pages":[{"title":"List queue schedules","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/queue/slots","href":"/api-reference/queue/list-queue-schedules"},{"title":"Update queue schedule","deprecated":null,"version":null,"openapi":"/api/openapi.json put /v1/queue/slots","href":"/api-reference/queue/update-a-queue-schedule"},{"title":"Create queue schedule","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/queue/slots","href":"/api-reference/queue/create-a-queue-schedule"},{"title":"Delete queue schedule","deprecated":null,"version":null,"openapi":"/api/openapi.json delete /v1/queue/slots","href":"/api-reference/queue/delete-a-queue-schedule"},{"title":"Preview queue slots","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/queue/preview","href":"/api-reference/queue/preview-queue-slots"},{"title":"Get next queue slot","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/queue/next-slot","href":"/api-reference/queue/get-next-queue-slot"}]},{"group":"Validation","pages":[{"title":"Validate post","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/tools/validate/post","href":"/api-reference/validation/validate-a-post"},{"title":"Validate post length","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/tools/validate/post-length","href":"/api-reference/validation/validate-post-length"}]},{"group":"Connect","pages":[{"title":"Complete hosted connect callback","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/connect/callback","href":"/api-reference/connect/complete-hosted-oauth-callback"},{"title":"List connect providers","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/connect/providers","href":"/api-reference/connect/list-connect-providers"},{"title":"Start Telegram Business pairing","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/connect/telegram/business/session","href":"/api-reference/connect/start-automatic-telegram-business-pairing"},{"title":"Get Telegram Business pairing status","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/connect/telegram/business/session/{sessionId}","href":"/api-reference/connect/get-telegram-business-pairing-status"},{"title":"Begin connect","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/connect/begin","href":"/api-reference/connect/begin-oauth-connect"},{"title":"Complete connect","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/connect/complete","href":"/api-reference/connect/complete-oauth-connect"},{"title":"Complete token connect","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/connect/token","href":"/api-reference/connect/complete-token-connect"},{"title":"Connect Bluesky credentials","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/connect/bluesky/credentials","href":"/api-reference/connect/connect-bluesky-credentials"},{"title":"Connect Telegram chat","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/connect/telegram","href":"/api-reference/connect/connect-telegram-chat"},{"title":"Create Telegram access code","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/connect/telegram/access-code","href":"/api-reference/connect/create-telegram-access-code"},{"title":"Get Telegram access-code status","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/connect/telegram/access-code/{code}","href":"/api-reference/connect/get-telegram-access-code-status"},{"title":"Claim Telegram Business connection","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/connect/telegram/business/claim","href":"/api-reference/connect/claim-telegram-business-connection"},{"title":"Connect Telegram credentials","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/connect/telegram/credentials","href":"/api-reference/connect/connect-telegram-credentials"},{"title":"List Facebook Pages","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/connect/facebook/pages","href":"/api-reference/connect/list-facebook-pages"},{"title":"Select Facebook Page","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/connect/facebook/select-page","href":"/api-reference/connect/select-facebook-page"},{"title":"List Instagram accounts","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/connect/instagram/accounts","href":"/api-reference/connect/list-instagram-accounts"},{"title":"Select Instagram account","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/connect/instagram/select-account","href":"/api-reference/connect/select-instagram-account"},{"title":"List LinkedIn organizations","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/connect/linkedin/organizations","href":"/api-reference/connect/linkedin-organization-discovery-unavailable"},{"title":"Select LinkedIn organization","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/connect/linkedin/select-organization","href":"/api-reference/connect/linkedin-organization-selection-unavailable"},{"title":"List Pinterest boards","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/connect/pinterest/boards","href":"/api-reference/connect/list-pinterest-boards"},{"title":"Select Pinterest board","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/connect/pinterest/select-board","href":"/api-reference/connect/select-pinterest-board"},{"title":"List Reddit subreddits","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/connect/reddit/subreddits","href":"/api-reference/connect/list-reddit-subreddits"},{"title":"List Reddit flairs","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/connect/reddit/flairs","href":"/api-reference/connect/list-reddit-flairs"},{"title":"List YouTube channels","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/connect/youtube/channels","href":"/api-reference/connect/list-youtube-channels"},{"title":"Select YouTube channel","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/connect/youtube/select-channel","href":"/api-reference/connect/select-youtube-channel"},{"title":"List YouTube playlists","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/connect/youtube/playlists","href":"/api-reference/connect/list-youtube-playlists"},{"title":"List Google Business connect locations","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/connect/googlebusiness/locations","href":"/api-reference/connect/list-google-business-connect-locations"},{"title":"Select Google Business location","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/connect/googlebusiness/select-location","href":"/api-reference/connect/select-google-business-location"},{"title":"List Discord connect channels","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/connect/discord/channels","href":"/api-reference/connect/list-discord-connect-channels"},{"title":"Select Discord channel","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/connect/discord/select-channel","href":"/api-reference/connect/select-discord-channel"},{"title":"Receive Telegram webhook update","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/telegram/updates","href":"/api-reference/connect/receive-telegram-webhook-update"}]},{"group":"Accounts","pages":[{"title":"List accounts","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/accounts","href":"/api-reference/accounts/list-connected-accounts"},{"title":"Get account","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/accounts/{accountId}","href":"/api-reference/accounts/get-a-connected-account"},{"title":"Replace account","deprecated":null,"version":null,"openapi":"/api/openapi.json put /v1/accounts/{accountId}","href":"/api-reference/accounts/replace-account-fields"},{"title":"Update account","deprecated":null,"version":null,"openapi":"/api/openapi.json patch /v1/accounts/{accountId}","href":"/api-reference/accounts/update-a-connected-account"},{"title":"Move account","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/accounts/{accountId}/move","href":"/api-reference/accounts/move-a-connected-account"},{"title":"Disconnect account","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/accounts/{accountId}/disconnect","href":"/api-reference/accounts/disconnect-an-account"},{"title":"Check account health","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/accounts/{accountId}/health","href":"/api-reference/accounts/check-account-health"},{"title":"Refresh TikTok creator info","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/accounts/{accountId}/tiktok/creator-info","href":"/api-reference/accounts/refresh-tiktok-creator-info"},{"title":"List Mastodon notifications","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/accounts/{accountId}/mastodon-notifications","href":"/api-reference/accounts/list-mastodon-notifications"},{"title":"List Mastodon engagement items","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/accounts/{accountId}/mastodon-engagement","href":"/api-reference/accounts/list-mastodon-engagement-items"},{"title":"Dismiss Mastodon notification","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/accounts/{accountId}/mastodon-notifications/{notificationId}/dismiss","href":"/api-reference/accounts/dismiss-a-mastodon-notification"},{"title":"List Mastodon conversations","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/accounts/{accountId}/mastodon-conversations","href":"/api-reference/accounts/list-mastodon-conversations"},{"title":"Mark Mastodon conversation read","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/accounts/{accountId}/mastodon-conversations/{conversationId}/read","href":"/api-reference/accounts/mark-a-mastodon-conversation-read"},{"title":"List Bluesky conversations","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/accounts/{accountId}/bluesky-conversations","href":"/api-reference/accounts/list-bluesky-conversations"},{"title":"List Bluesky messages","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/accounts/{accountId}/bluesky-conversations/{conversationId}/messages","href":"/api-reference/accounts/list-bluesky-messages"},{"title":"Send Bluesky message","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/accounts/{accountId}/bluesky-conversations/{conversationId}/messages","href":"/api-reference/accounts/send-a-bluesky-message"},{"title":"Mark Bluesky conversation read","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/accounts/{accountId}/bluesky-conversations/{conversationId}/read","href":"/api-reference/accounts/mark-bluesky-conversation-read"},{"title":"Archive Bluesky conversation","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/accounts/{accountId}/bluesky-conversations/{conversationId}/archive","href":"/api-reference/accounts/archive-a-bluesky-conversation"},{"title":"Get Mastodon status context","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/accounts/{accountId}/mastodon-statuses/{statusId}/context","href":"/api-reference/accounts/get-mastodon-status-context"},{"title":"Run Mastodon status action","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/accounts/{accountId}/mastodon-statuses/{statusId}/{action}","href":"/api-reference/accounts/run-a-mastodon-status-action"}]},{"group":"Discord","pages":[{"title":"Get Discord settings","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/accounts/{accountId}/discord-settings","href":"/api-reference/discord/get-discord-settings"},{"title":"Update Discord settings","deprecated":null,"version":null,"openapi":"/api/openapi.json patch /v1/accounts/{accountId}/discord-settings","href":"/api-reference/discord/update-discord-settings"},{"title":"List Discord channels","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/accounts/{accountId}/discord-channels","href":"/api-reference/discord/list-discord-channels"},{"title":"Send Discord DM","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/discord/dms","href":"/api-reference/discord/send-discord-direct-message"},{"title":"List Discord roles","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/discord/guilds/{guildId}/roles","href":"/api-reference/discord/list-discord-roles"},{"title":"List Discord members","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/discord/guilds/{guildId}/members","href":"/api-reference/discord/list-discord-members"},{"title":"Assign Discord role","deprecated":null,"version":null,"openapi":"/api/openapi.json put /v1/discord/guilds/{guildId}/members/{userId}/roles/{roleId}","href":"/api-reference/discord/assign-discord-role"},{"title":"Remove Discord role","deprecated":null,"version":null,"openapi":"/api/openapi.json delete /v1/discord/guilds/{guildId}/members/{userId}/roles/{roleId}","href":"/api-reference/discord/remove-discord-role"},{"title":"List Discord pins","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/discord/channels/{channelId}/pins","href":"/api-reference/discord/list-discord-pins"},{"title":"Pin Discord message","deprecated":null,"version":null,"openapi":"/api/openapi.json put /v1/discord/channels/{channelId}/pins/{messageId}","href":"/api-reference/discord/pin-discord-message"},{"title":"Unpin Discord message","deprecated":null,"version":null,"openapi":"/api/openapi.json delete /v1/discord/channels/{channelId}/pins/{messageId}","href":"/api-reference/discord/unpin-discord-message"},{"title":"List Discord events","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/discord/guilds/{guildId}/events","href":"/api-reference/discord/list-discord-scheduled-events"},{"title":"Create Discord event","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/discord/guilds/{guildId}/events","href":"/api-reference/discord/create-discord-scheduled-event"},{"title":"Get Discord event","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/discord/guilds/{guildId}/events/{eventId}","href":"/api-reference/discord/get-discord-scheduled-event"},{"title":"Delete Discord event","deprecated":null,"version":null,"openapi":"/api/openapi.json delete /v1/discord/guilds/{guildId}/events/{eventId}","href":"/api-reference/discord/delete-discord-scheduled-event"},{"title":"Update Discord event","deprecated":null,"version":null,"openapi":"/api/openapi.json patch /v1/discord/guilds/{guildId}/events/{eventId}","href":"/api-reference/discord/update-discord-scheduled-event"}]},{"group":"Telegram","pages":[{"title":"Get Telegram commands","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/accounts/{accountId}/telegram-commands","href":"/api-reference/telegram/get-telegram-command-menu"},{"title":"Set Telegram commands","deprecated":null,"version":null,"openapi":"/api/openapi.json put /v1/accounts/{accountId}/telegram-commands","href":"/api-reference/telegram/set-telegram-command-menu"},{"title":"Clear Telegram commands","deprecated":null,"version":null,"openapi":"/api/openapi.json delete /v1/accounts/{accountId}/telegram-commands","href":"/api-reference/telegram/clear-telegram-command-menu"},{"title":"List Telegram conversations","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/accounts/{accountId}/telegram-conversations","href":"/api-reference/telegram/list-telegram-conversations"},{"title":"List Telegram messages","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/accounts/{accountId}/telegram-conversations/{conversationId}/messages","href":"/api-reference/telegram/list-telegram-messages"},{"title":"Send Telegram message","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/accounts/{accountId}/telegram-conversations/{conversationId}/messages","href":"/api-reference/telegram/send-a-telegram-message"},{"title":"Archive Telegram conversation","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/accounts/{accountId}/telegram-conversations/{conversationId}/archive","href":"/api-reference/telegram/archive-a-telegram-conversation"}]},{"group":"Google Business","pages":[{"title":"Get Google Business location details","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/accounts/{accountId}/gmb-location-details","href":"/api-reference/google-business/get-google-business-location-details"},{"title":"Update Google Business location details","deprecated":null,"version":null,"openapi":"/api/openapi.json put /v1/accounts/{accountId}/gmb-location-details","href":"/api-reference/google-business/update-google-business-location-details"},{"title":"Get Google Business attributes","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/accounts/{accountId}/gmb-attributes","href":"/api-reference/google-business/get-google-business-attributes"},{"title":"Update Google Business attributes","deprecated":null,"version":null,"openapi":"/api/openapi.json put /v1/accounts/{accountId}/gmb-attributes","href":"/api-reference/google-business/update-google-business-attributes"},{"title":"List Google Business attribute metadata","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/accounts/{accountId}/gmb-attribute-metadata","href":"/api-reference/google-business/list-google-business-attribute-metadata"},{"title":"Get Google Business services","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/accounts/{accountId}/gmb-services","href":"/api-reference/google-business/get-google-business-services"},{"title":"Replace Google Business services","deprecated":null,"version":null,"openapi":"/api/openapi.json put /v1/accounts/{accountId}/gmb-services","href":"/api-reference/google-business/replace-google-business-services"},{"title":"Get Google Business food menus","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/accounts/{accountId}/gmb-food-menus","href":"/api-reference/google-business/get-google-business-food-menus"},{"title":"Update Google Business food menus","deprecated":null,"version":null,"openapi":"/api/openapi.json put /v1/accounts/{accountId}/gmb-food-menus","href":"/api-reference/google-business/update-google-business-food-menus"},{"title":"List Google Business media","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/accounts/{accountId}/gmb-media","href":"/api-reference/google-business/list-google-business-media"},{"title":"Create Google Business media","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/accounts/{accountId}/gmb-media","href":"/api-reference/google-business/create-google-business-media"},{"title":"Delete Google Business media","deprecated":null,"version":null,"openapi":"/api/openapi.json delete /v1/accounts/{accountId}/gmb-media","href":"/api-reference/google-business/delete-google-business-media"},{"title":"List Google Business reviews","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/accounts/{accountId}/gmb-reviews","href":"/api-reference/google-business/list-google-business-reviews"},{"title":"Reply to Google Business review","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/accounts/{accountId}/gmb-reviews/{reviewId}/reply","href":"/api-reference/google-business/reply-to-a-google-business-review"},{"title":"Delete Google Business review reply","deprecated":null,"version":null,"openapi":"/api/openapi.json delete /v1/accounts/{accountId}/gmb-reviews/{reviewId}/reply","href":"/api-reference/google-business/delete-a-google-business-review-reply"},{"title":"Get Google Business verification state","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/accounts/{accountId}/gmb-verifications","href":"/api-reference/google-business/get-google-business-verification-state"},{"title":"Start Google Business verification","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/accounts/{accountId}/gmb-verifications","href":"/api-reference/google-business/start-google-business-verification"},{"title":"Fetch Google Business verification options","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/accounts/{accountId}/gmb-verifications/options","href":"/api-reference/google-business/fetch-google-business-verification-options"},{"title":"Complete Google Business verification","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/accounts/{accountId}/gmb-verifications/{verificationId}/complete","href":"/api-reference/google-business/complete-google-business-verification"},{"title":"List Google Business place actions","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/accounts/{accountId}/gmb-place-actions","href":"/api-reference/google-business/list-google-business-place-actions"},{"title":"Update Google Business place action","deprecated":null,"version":null,"openapi":"/api/openapi.json put /v1/accounts/{accountId}/gmb-place-actions","href":"/api-reference/google-business/update-google-business-place-action"},{"title":"Create Google Business place action","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/accounts/{accountId}/gmb-place-actions","href":"/api-reference/google-business/create-google-business-place-action"},{"title":"Delete Google Business place action","deprecated":null,"version":null,"openapi":"/api/openapi.json delete /v1/accounts/{accountId}/gmb-place-actions","href":"/api-reference/google-business/delete-google-business-place-action"}]},{"group":"Media","pages":[{"title":"Upload media","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/media/upload","href":"/api-reference/media/upload-media"},{"title":"Create media presign URL","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/media/presign","href":"/api-reference/media/create-a-media-presign-url"},{"title":"Validate media","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/tools/validate/media","href":"/api-reference/media/validate-media"}]},{"group":"Activity","pages":[{"title":"List activity events","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/activity","href":"/api-reference/activity/list-activity-events"}]},{"group":"Webhooks","pages":[{"title":"List webhooks","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/webhooks","href":"/api-reference/webhooks/list-webhooks"},{"title":"Replace webhook","deprecated":null,"version":null,"openapi":"/api/openapi.json put /v1/webhooks","href":"/api-reference/webhooks/replace-webhook-settings"},{"title":"Create webhook","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/webhooks","href":"/api-reference/webhooks/create-a-webhook"},{"title":"Delete webhook","deprecated":null,"version":null,"openapi":"/api/openapi.json delete /v1/webhooks","href":"/api-reference/webhooks/delete-a-webhook"},{"title":"Update webhook","deprecated":null,"version":null,"openapi":"/api/openapi.json patch /v1/webhooks","href":"/api-reference/webhooks/update-a-webhook"},{"title":"Send test webhook","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/webhooks/test","href":"/api-reference/webhooks/send-a-test-webhook"},{"title":"List webhook delivery logs","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/webhooks/logs","href":"/api-reference/webhooks/list-webhook-delivery-logs"}]},{"group":"Ad audiences","pages":[{"title":"List ad audiences","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/ads/audiences","href":"/api-reference/ad-audiences/list-ad-audiences"},{"title":"Create an ad audience","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/ads/audiences","href":"/api-reference/ad-audiences/create-an-ad-audience"},{"title":"Get an ad audience","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/ads/audiences/{audienceId}","href":"/api-reference/ad-audiences/get-an-ad-audience"},{"title":"Delete an ad audience","deprecated":null,"version":null,"openapi":"/api/openapi.json delete /v1/ads/audiences/{audienceId}","href":"/api-reference/ad-audiences/delete-an-ad-audience"},{"title":"Add users to an ad audience","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/ads/audiences/{audienceId}/users","href":"/api-reference/ad-audiences/add-users-to-an-ad-audience"}]},{"group":"Ad catalogs","pages":[{"title":"List ad catalogs","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/ads/catalogs","href":"/api-reference/ad-catalogs/list-ad-catalogs"},{"title":"List ad catalog product sets","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/ads/catalogs/{catalogId}/product-sets","href":"/api-reference/ad-catalogs/list-ad-catalog-product-sets"}]},{"group":"Ad conversions","pages":[{"title":"List conversion destinations","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/accounts/{accountId}/conversion-destinations","href":"/api-reference/ad-conversions/list-conversion-destinations"},{"title":"Create a conversion destination","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/accounts/{accountId}/conversion-destinations","href":"/api-reference/ad-conversions/create-a-conversion-destination"},{"title":"Get a conversion destination","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/accounts/{accountId}/conversion-destinations/{destinationId}","href":"/api-reference/ad-conversions/get-a-conversion-destination"},{"title":"Delete a conversion destination","deprecated":null,"version":null,"openapi":"/api/openapi.json delete /v1/accounts/{accountId}/conversion-destinations/{destinationId}","href":"/api-reference/ad-conversions/delete-a-conversion-destination"},{"title":"Update a conversion destination","deprecated":null,"version":null,"openapi":"/api/openapi.json patch /v1/accounts/{accountId}/conversion-destinations/{destinationId}","href":"/api-reference/ad-conversions/update-a-conversion-destination"},{"title":"Get conversion metrics","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/accounts/{accountId}/conversion-destinations/{destinationId}/metrics","href":"/api-reference/ad-conversions/get-conversion-metrics"},{"title":"List conversion associations","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/accounts/{accountId}/conversion-destinations/{destinationId}/associations","href":"/api-reference/ad-conversions/list-conversion-associations"},{"title":"Add conversion associations","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/accounts/{accountId}/conversion-destinations/{destinationId}/associations","href":"/api-reference/ad-conversions/add-conversion-associations"},{"title":"Remove conversion associations","deprecated":null,"version":null,"openapi":"/api/openapi.json delete /v1/accounts/{accountId}/conversion-destinations/{destinationId}/associations","href":"/api-reference/ad-conversions/remove-conversion-associations"},{"title":"Get conversions quality","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/ads/conversions/quality","href":"/api-reference/ad-conversions/get-conversions-quality"},{"title":"Send conversion adjustments","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/ads/conversions/adjustments","href":"/api-reference/ad-conversions/send-conversion-adjustments"},{"title":"Send conversion events","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/ads/conversions","href":"/api-reference/ad-conversions/send-conversion-events"}]},{"group":"Ad leads","pages":[{"title":"List ad leads","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/ads/leads","href":"/api-reference/ad-leads/list-ad-leads"},{"title":"List lead forms","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/ads/lead-forms","href":"/api-reference/ad-leads/list-lead-forms"},{"title":"Create a lead form","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/ads/lead-forms","href":"/api-reference/ad-leads/create-a-lead-form"},{"title":"Create a test lead","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/ads/lead-forms/{formId}/test-leads","href":"/api-reference/ad-leads/create-a-test-lead"},{"title":"List lead form leads","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/ads/lead-forms/{formId}/leads","href":"/api-reference/ad-leads/list-lead-form-leads"},{"title":"Get a lead form","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/ads/lead-forms/{formId}","href":"/api-reference/ad-leads/get-a-lead-form"},{"title":"Archive a lead form","deprecated":null,"version":null,"openapi":"/api/openapi.json delete /v1/ads/lead-forms/{formId}","href":"/api-reference/ad-leads/archive-a-lead-form"}]},{"group":"Ad targeting","pages":[{"title":"Search ad targeting","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/ads/targeting/search","href":"/api-reference/ad-targeting/search-ad-targeting"},{"title":"Search ad interests","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/ads/interests","href":"/api-reference/ad-targeting/search-ad-interests"},{"title":"Estimate ad reach","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/ads/targeting/reach-estimate","href":"/api-reference/ad-targeting/estimate-ad-reach"}]},{"group":"Ads","pages":[{"title":"List ad accounts","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/ads/accounts","href":"/api-reference/ads/list-ad-accounts"},{"title":"Create an ad","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/ads/create","href":"/api-reference/ads/create-an-ad"},{"title":"Boost a post","description":"Creates a provider-backed ad from an existing post.","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/ads/boost","href":"/api-reference/ads/boost-a-post"},{"title":"Create a click-to-WhatsApp ad","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/ads/ctwa","href":"/api-reference/ads/create-a-click-to-whatsapp-ad"},{"title":"List ads","description":"Returns Kavenio-created and optionally provider-derived ads with filters and pagination.","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/ads","href":"/api-reference/ads/list-ads"},{"title":"List ad campaigns","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/ads/campaigns","href":"/api-reference/ads/list-ad-campaigns"},{"title":"Update ad campaign status","deprecated":null,"version":null,"openapi":"/api/openapi.json put /v1/ads/campaigns/{campaignId}/status","href":"/api-reference/ads/update-ad-campaign-status"},{"title":"Update ad set status","deprecated":null,"version":null,"openapi":"/api/openapi.json put /v1/ads/ad-sets/{adSetId}/status","href":"/api-reference/ads/update-ad-set-status"},{"title":"Get ad campaign tree","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/ads/tree","href":"/api-reference/ads/get-ad-campaign-tree"},{"title":"Get ads timeline","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/ads/timeline","href":"/api-reference/ads/get-ads-timeline"},{"title":"Get ad analytics","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/ads/{adId}/analytics","href":"/api-reference/ads/get-ad-analytics"},{"title":"Get ad tracking tags","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/ads/{adId}/tracking-tags","href":"/api-reference/ads/get-ad-tracking-tags"},{"title":"Update ad tracking tags","deprecated":null,"version":null,"openapi":"/api/openapi.json patch /v1/ads/{adId}/tracking-tags","href":"/api-reference/ads/update-ad-tracking-tags"},{"title":"Get an ad","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/ads/{adId}","href":"/api-reference/ads/get-an-ad"},{"title":"Cancel an ad","deprecated":null,"version":null,"openapi":"/api/openapi.json delete /v1/ads/{adId}","href":"/api-reference/ads/cancel-an-ad"}]},{"group":"Analytics","pages":[{"title":"Get unified post analytics","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/analytics","href":"/api-reference/analytics/get-unified-post-analytics"},{"title":"Get Google Business performance","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/analytics/googlebusiness/performance","href":"/api-reference/analytics/get-google-business-performance"},{"title":"Get Google Business search keywords","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/analytics/googlebusiness/search-keywords","href":"/api-reference/analytics/get-google-business-search-keywords"},{"title":"List inbox reviews","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/inbox/reviews","href":"/api-reference/analytics/list-inbox-reviews"},{"title":"List inbox engagement","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/inbox/engagement","href":"/api-reference/analytics/list-inbox-engagement"}]},{"group":"Platform credentials","pages":[{"title":"List platform credential catalog","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/platform-app-credentials/catalog","href":"/api-reference/platform-credentials/list-platform-credential-catalog"},{"title":"List platform app credentials","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/platform-app-credentials","href":"/api-reference/platform-credentials/list-platform-app-credentials"},{"title":"Upsert platform app credential","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/platform-app-credentials","href":"/api-reference/platform-credentials/upsert-platform-app-credential"},{"title":"Get platform app credential","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/platform-app-credentials/{credentialId}","href":"/api-reference/platform-credentials/get-platform-app-credential"},{"title":"Delete platform app credential","deprecated":null,"version":null,"openapi":"/api/openapi.json delete /v1/platform-app-credentials/{credentialId}","href":"/api-reference/platform-credentials/delete-platform-app-credential"},{"title":"Test platform app credential","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/platform-app-credentials/test","href":"/api-reference/platform-credentials/test-platform-app-credential"},{"title":"Disable platform app credential","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/platform-app-credentials/{credentialId}/disable","href":"/api-reference/platform-credentials/disable-platform-app-credential"},{"title":"Reset platform app credential","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/platform-app-credentials/{credentialId}/reset","href":"/api-reference/platform-credentials/reset-platform-app-credential"},{"title":"Mark accounts needs reconnect","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/platform-app-credentials/{credentialId}/mark-accounts-needs-reconnect","href":"/api-reference/platform-credentials/mark-accounts-needs-reconnect"}]},{"group":"Tracking tags","pages":[{"title":"List tracking tags","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/accounts/{accountId}/tracking-tags","href":"/api-reference/tracking-tags/list-tracking-tags"},{"title":"Create tracking tag","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/accounts/{accountId}/tracking-tags","href":"/api-reference/tracking-tags/create-tracking-tag"},{"title":"List tracking tag shared accounts","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/accounts/{accountId}/tracking-tags/{tagId}/shared-accounts","href":"/api-reference/tracking-tags/list-tracking-tag-shared-accounts"},{"title":"Share tracking tag with account","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/accounts/{accountId}/tracking-tags/{tagId}/shared-accounts","href":"/api-reference/tracking-tags/share-tracking-tag-with-account"},{"title":"Remove tracking tag shared account","deprecated":null,"version":null,"openapi":"/api/openapi.json delete /v1/accounts/{accountId}/tracking-tags/{tagId}/shared-accounts","href":"/api-reference/tracking-tags/remove-tracking-tag-shared-account"},{"title":"Get tracking tag stats","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/accounts/{accountId}/tracking-tags/{tagId}/stats","href":"/api-reference/tracking-tags/get-tracking-tag-stats"},{"title":"Get tracking tag","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/accounts/{accountId}/tracking-tags/{tagId}","href":"/api-reference/tracking-tags/get-tracking-tag"},{"title":"Update tracking tag","deprecated":null,"version":null,"openapi":"/api/openapi.json patch /v1/accounts/{accountId}/tracking-tags/{tagId}","href":"/api-reference/tracking-tags/update-tracking-tag"}]},{"group":"WhatsApp conversions","pages":[{"title":"List WhatsApp conversions","deprecated":null,"version":null,"openapi":"/api/openapi.json get /v1/whatsapp/conversions","href":"/api-reference/whatsapp-conversions/list-whatsapp-conversions"},{"title":"Send WhatsApp conversion","deprecated":null,"version":null,"openapi":"/api/openapi.json post /v1/whatsapp/conversions","href":"/api-reference/whatsapp-conversions/send-whatsapp-conversion"}]}]},{"title":"Webhooks","mode":"wide","href":"/api/webhooks"},{"title":"Examples","mode":"wide","href":"/api/examples"},{"title":"Errors","mode":"wide","href":"/api/errors"},{"title":"Pagination","mode":"wide","href":"/api/pagination"},{"title":"Rate limits","mode":"wide","href":"/api/rate-limits"},{"title":"Versioning","mode":"wide","href":"/api/versioning"}]},{"group":"Platforms","expanded":false,"pages":[{"title":"Platforms","mode":"wide","href":"/platforms/overview"},{"title":"Facebook Page Posting API Documentation | Kavenio Docs","sidebarTitle":"Facebook","mode":"wide","href":"/platforms/facebook"},{"title":"Instagram Publishing API Documentation | Kavenio Docs","sidebarTitle":"Instagram","mode":"wide","href":"/platforms/instagram"},{"title":"Threads Publishing API Documentation | Kavenio Docs","sidebarTitle":"Threads","mode":"wide","href":"/platforms/threads"},{"title":"X (Twitter) Posting API Documentation | Kavenio Docs","sidebarTitle":"X / Twitter","mode":"wide","href":"/platforms/x-twitter"},{"title":"LinkedIn Publishing API Documentation | Kavenio Docs","sidebarTitle":"LinkedIn","mode":"wide","href":"/platforms/linkedin"},{"title":"TikTok Publishing API Documentation | Kavenio Docs","sidebarTitle":"TikTok","mode":"wide","href":"/platforms/tiktok"},{"title":"YouTube Videos \u0026 Shorts API Documentation | Kavenio Docs","sidebarTitle":"YouTube","mode":"wide","href":"/platforms/youtube"},{"title":"Google Business","mode":"wide","href":"/platforms/google-business"},{"title":"Pinterest Posting API Documentation | Kavenio Docs","sidebarTitle":"Pinterest","mode":"wide","href":"/platforms/pinterest"},{"title":"Reddit","mode":"wide","href":"/platforms/reddit"},{"title":"Bluesky Posting API Documentation | Kavenio Docs","sidebarTitle":"Bluesky","mode":"wide","href":"/platforms/bluesky"},{"title":"Mastodon Posting API Documentation | Kavenio Docs","sidebarTitle":"Mastodon","mode":"wide","href":"/platforms/mastodon"},{"title":"Discord","mode":"wide","href":"/platforms/discord"},{"title":"Telegram","mode":"wide","href":"/platforms/telegram"}]},{"group":"Changelog","expanded":false,"pages":[{"title":"Discord support","href":"/changelog/discord-support"},{"title":"Telegram Support","mode":"wide","href":"/changelog/telegram-support"}]},{"group":"Guides","expanded":false,"pages":[{"title":"All guides","mode":"wide","href":"/guides/overview"},{"title":"Connect a social account","mode":"wide","href":"/guides/connect-social-account"},{"title":"Platform keys","mode":"wide","href":"/guides/platform-keys"},{"title":"Publish your first post","mode":"wide","href":"/guides/publish-first-post"},{"title":"Schedule posts","mode":"wide","href":"/guides/schedule-posts"},{"title":"Cross-posting","mode":"wide","href":"/guides/cross-posting"},{"title":"Upload media","mode":"wide","href":"/guides/upload-media"},{"title":"Validate posts","mode":"wide","href":"/guides/validate-posts"},{"title":"Use Google Business","mode":"wide","href":"/guides/google-business"},{"title":"Manage ads","mode":"wide","href":"/guides/manage-ads"},{"title":"Set up webhooks","mode":"wide","href":"/guides/setup-webhooks"},{"title":"Use Kavenio with agents","mode":"wide","href":"/guides/use-kavenio-with-agents"}]}]}]},"basePath":"","title":"Create a click-to-WhatsApp ad - Kavenio","buildId":"dpl_6cCEiK8XNNvaLBBkWzcBhdE9QfLC","deploymentId":"dpl_6cCEiK8XNNvaLBBkWzcBhdE9QfLC","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CLz2_Z5D.js","utils-7A5jZhOT.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-BVWmkKuv.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-4SOfrh0F.js","snippetPresets-CMc8KicP.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-Ba9tX7z3.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-Be8krXvv.js","shallow-CBC3K1uB.js","getApiPlaygroundDisplay-4tKcUAYo.js","CodeSnippet-C1Xa06ft.js","CodeSnippets-vqiz27A_.js","Page-DeQN5MDd.js","getPastedJson-NUwRfM32.js","icon-DkIVqWh9.js","MethodPill-qmhT7_wz.js","DuplicateIcon-_gWp1vhn.js","createIcon-NA1p_TVA.js","DynamicMarkdown-Bas9A7wq.js","SectionHeading-a1cS-24U.js","axios-vUo_bRtp.js","Markdown-D3ZTwq_a.js","clsx-BcghKhHb.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-B66mVNPp.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-DmooSyTN.js"]}