{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Notifique","description":"API multicanal para WhatsApp, SMS, e-mail, push e mais. Integre, teste no sandbox e use IA com llms.txt e MCP.","colors":{"primary":"#fbbf24","light":"#fbbf24","dark":"#fbbf24"},"logo":{"light":"https://mintcdn.com/tribus/bZe-7RiENjmeF_O7/logo/light.png?fit=max\u0026auto=format\u0026n=bZe-7RiENjmeF_O7\u0026q=85\u0026s=64d67c9a1c52ec357777b5632f714882","dark":"https://mintcdn.com/tribus/bZe-7RiENjmeF_O7/logo/dark.png?fit=max\u0026auto=format\u0026n=bZe-7RiENjmeF_O7\u0026q=85\u0026s=2df6ca04be3fb36c080492c1c205975f"},"favicon":"https://mintcdn.com/tribus/bZe-7RiENjmeF_O7/favicon.svg?fit=max\u0026auto=format\u0026n=bZe-7RiENjmeF_O7\u0026q=85\u0026s=3ea7b1631da416de0c1a7ee57d439c56","api":{"playground":{"display":"interactive"},"examples":{"languages":["curl","javascript","python","go"],"prefill":true,"autogenerate":true}},"navbar":{"links":[{"href":"https://status.notifique.dev","label":"Status"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.notifique.dev"}},"styling":{"latex":true},"navigation":{"languages":[{"language":"pt-BR","default":true,"navbar":{"links":[{"href":"https://status.notifique.dev","label":"Status"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.notifique.dev"}},"href":"welcome/welcome"},{"language":"en","href":"en/welcome/welcome"},{"language":"es","href":"es/welcome/welcome"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"tribus","hasAudioNarration":false,"actualSubdomain":"tribus","customDomains":["docs.notifique.dev"],"gitSource":{"type":"github","owner":"notifique-dev","repo":"notifique-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ad52bcc29f358e945e24eef","collectionId":"53455186-1186-4cb7-b9b1-ff28dfb2c0ce","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ad52bcc29f358e945e24eef"},"feedback":{"thumbs":true},"entitlements":{},"buildId":"6ad52bcc29f358e945e24eef","clientVersion":"0.0.4045","searchFilterCounts":[{"language":"default","tag":"Guias","count":56},{"language":"default","tag":"Automações","count":53},{"language":"en","tag":"WhatsApp","count":50},{"language":"default","tag":"Contatos","count":49},{"language":"pt-BR","tag":"WhatsApp","count":46},{"language":"es","tag":"WhatsApp","count":46},{"language":"pt-BR","tag":"Guias","count":40},{"language":"en","tag":"Guides","count":40},{"language":"es","tag":"Guías","count":40},{"language":"pt-BR","tag":"Automações","count":38},{"language":"en","tag":"Add-ons","count":37},{"language":"en","tag":"Automations","count":35},{"language":"es","tag":"Add-ons","count":35},{"language":"pt-BR","tag":"Add-ons","count":34},{"language":"en","tag":"Instagram","count":33},{"language":"pt-BR","tag":"Instagram","count":32},{"language":"es","tag":"Automatizaciones","count":32},{"language":"es","tag":"Instagram","count":32},{"language":"en","tag":"Contacts","count":29},{"language":"pt-BR","tag":"Contatos","count":28},{"language":"en","tag":"Telegram","count":28},{"language":"es","tag":"Contactos","count":28},{"language":"es","tag":"Telegram","count":27},{"language":"pt-BR","tag":"Telegram","count":25},{"language":"pt-BR","tag":"Instâncias","count":25},{"language":"default","tag":"Voz","count":23},{"language":"en","tag":"Instâncias","count":22},{"language":"es","tag":"Instâncias","count":21},{"language":"default","tag":"Chat","count":21},{"language":"default","tag":"WhatsApp","count":19},{"language":"en","tag":"Mensagens","count":18},{"language":"en","tag":"Voice","count":17},{"language":"es","tag":"Mensagens","count":17},{"language":"pt-BR","tag":"Voz","count":15},{"language":"pt-BR","tag":"Mensagens","count":15},{"language":"es","tag":"Voz","count":15},{"language":"default","tag":"Assistentes","count":14},{"language":"default","tag":"Add-ons","count":14},{"language":"default","tag":"Mensagens","count":13},{"language":"default","tag":"Push","count":13}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"welcome-hero.css","content":"@keyframes welcome-line-flow{0%{stroke-dashoffset:0}to{stroke-dashoffset:-240}}@keyframes welcome-node-pulse{0%,to{opacity:.55;transform:scale(1)}50%{opacity:1;transform:scale(1.35)}}@keyframes welcome-ring-expand{0%{opacity:.5;transform:scale(.6)}70%,to{opacity:0;transform:scale(2.2)}}@keyframes welcome-glow-drift{0%,to{transform:translate(0,0) scale(1)}33%{transform:translate(24px,-16px) scale(1.05)}66%{transform:translate(-18px,12px) scale(.95)}}@keyframes welcome-grid-pulse{0%,to{opacity:.35}50%{opacity:.9}}.welcome-hero{position:relative;overflow:hidden;text-align:center;padding:96px 24px;margin-bottom:-16px;background:#09090b;-webkit-mask-image:linear-gradient(to bottom,#000 0,#000 calc(100% - 56px),rgba(0,0,0,.98) calc(100% - 49px),rgba(0,0,0,.96) calc(100% - 44px),rgba(0,0,0,.93) calc(100% - 39px),rgba(0,0,0,.89) calc(100% - 34px),rgba(0,0,0,.84) calc(100% - 29px),rgba(0,0,0,.78) calc(100% - 25px),rgba(0,0,0,.71) calc(100% - 21px),rgba(0,0,0,.63) calc(100% - 17px),rgba(0,0,0,.54) calc(100% - 13px),rgba(0,0,0,.44) calc(100% - 10px),rgba(0,0,0,.34) calc(100% - 7px),rgba(0,0,0,.24) calc(100% - 5px),rgba(0,0,0,.15) calc(100% - 3px),rgba(0,0,0,.08) calc(100% - 1px),transparent 100%);mask-image:linear-gradient(to bottom,#000 0,#000 calc(100% - 56px),rgba(0,0,0,.98) calc(100% - 49px),rgba(0,0,0,.96) calc(100% - 44px),rgba(0,0,0,.93) calc(100% - 39px),rgba(0,0,0,.89) calc(100% - 34px),rgba(0,0,0,.84) calc(100% - 29px),rgba(0,0,0,.78) calc(100% - 25px),rgba(0,0,0,.71) calc(100% - 21px),rgba(0,0,0,.63) calc(100% - 17px),rgba(0,0,0,.54) calc(100% - 13px),rgba(0,0,0,.44) calc(100% - 10px),rgba(0,0,0,.34) calc(100% - 7px),rgba(0,0,0,.24) calc(100% - 5px),rgba(0,0,0,.15) calc(100% - 3px),rgba(0,0,0,.08) calc(100% - 1px),transparent 100%);-webkit-mask-size:100% 100%;mask-size:100% 100%}.welcome-hero-bg{position:absolute;inset:0;pointer-events:none;overflow:hidden}.welcome-hero-glow{position:absolute;border-radius:50%;filter:blur(72px);opacity:.45;animation:welcome-glow-drift 18s ease-in-out infinite}.welcome-hero-glow-1{width:420px;height:420px;top:-120px;left:8%;background:rgba(251,191,36,.22);animation-delay:0s}.welcome-hero-glow-2{width:360px;height:360px;top:10%;right:5%;background:rgba(245,158,11,.14);animation-delay:-6s}.welcome-hero-glow-3{width:280px;height:280px;bottom:-40px;left:42%;background:rgba(251,191,36,.1);animation-delay:-12s}.welcome-hero-svg{position:absolute;inset:0;width:100%;height:100%;opacity:.9}.welcome-hero-grid line{stroke:rgba(251,191,36,.06);stroke-width:1}.welcome-hero-grid line:nth-child(odd){animation:welcome-grid-pulse 8s ease-in-out infinite}.welcome-hero-grid line:nth-child(even){animation:welcome-grid-pulse 8s ease-in-out infinite reverse;animation-delay:-4s}.welcome-hero-path{fill:none;stroke:url(#welcome-line-gradient);stroke-width:1.5;stroke-linecap:round;stroke-dasharray:6 14;animation:welcome-line-flow 22s linear infinite}.welcome-hero-path-2{animation-duration:28s;animation-direction:reverse;stroke-dasharray:4 18;opacity:.7}.welcome-hero-path-3{animation-duration:18s;stroke-dasharray:8 10;opacity:.55}.welcome-hero-node{fill:#fbbf24;filter:drop-shadow(0 0 8px rgba(251,191,36,.65));animation:welcome-node-pulse 4s ease-in-out infinite}.welcome-hero-node-2{animation-delay:-1.2s}.welcome-hero-node-3{animation-delay:-2.4s}.welcome-hero-node-4{animation-delay:-.6s}.welcome-hero-node-5{animation-delay:-1.8s}.welcome-hero-node-6{animation-delay:-3s}.welcome-hero-ring{fill:none;stroke:rgba(251,191,36,.2);stroke-width:1;transform-origin:center;animation:welcome-ring-expand 5s ease-out infinite}.welcome-hero-ring-2{animation-delay:-2.5s}.welcome-hero-content{position:relative;z-index:2}@media (prefers-reduced-motion:reduce){.welcome-hero-glow,.welcome-hero-grid line,.welcome-hero-node,.welcome-hero-path,.welcome-hero-ring{animation:none!important}}"}],"page":{"pagePath":"en/contacts-api/como-funciona/campanhas-escopos-da-api-key","slug":"/en/contacts-api/como-funciona/campanhas-escopos-da-api-key","pageMetadata":{"title":"Scopes — Campaigns","description":"API Key permissions to create and monitor campaigns (`campaigns:*`).","icon":"key","slug":"escopos-campanhas","href":"/en/contacts-api/como-funciona/campanhas-escopos-da-api-key"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"API Key permissions to create and monitor campaigns (\", _jsx(_components.code, {\n children: \"campaigns:*\"\n }), \").\"]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,li:`li`,p:`p`,strong:`strong`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,ul:`ul`,..._provideComponents(),...props.components},{Heading,Table,Tip}=_components;if(!Heading)_missingMdxReference(`Heading`,true);if(!Table)_missingMdxReference(`Table`,true);if(!Tip)_missingMdxReference(`Tip`,true);return _jsxs(_Fragment,{children:[_jsx(Tip,{children:_jsxs(_components.p,{children:[`Campaigns use `,_jsx(_components.strong,{children:_jsx(_components.code,{children:`campaigns:*`})}),`. Creating a campaign requires audience and content — `,_jsx(_components.strong,{children:`segments`}),`, `,_jsx(_components.strong,{children:`templates`}),`, and `,_jsx(_components.strong,{children:`messages`}),` scopes in the full flow.`]})}),`\n`,_jsx(Heading,{level:`2`,id:`scopes`,children:`Scopes`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Scope`}),_jsx(_components.th,{children:`Allows`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.strong,{children:_jsx(_components.code,{children:`campaigns:read`})})}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`GET /v1/campaigns`}),`, `,_jsx(_components.code,{children:`GET /v1/campaigns/{id}`})]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.strong,{children:_jsx(_components.code,{children:`campaigns:create`})})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`POST /v1/campaigns`})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.strong,{children:_jsx(_components.code,{children:`campaigns:update`})})}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`PATCH /v1/campaigns/{id}`}),`, cancel`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.strong,{children:_jsx(_components.code,{children:`campaigns:delete`})})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`DELETE /v1/campaigns/{id}`})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.strong,{children:_jsx(_components.code,{children:`campaigns:run`})})}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`POST /v1/campaigns/{id}/run`}),`, run preview`]})]})]})]}),`\n`,_jsx(Heading,{level:`2`,id:`common-combinations`,children:`Common combinations`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Flow`}),_jsx(_components.th,{children:`Scopes`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Monitor campaigns only`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`campaigns:read`})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Automation triggers campaigns`}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`campaigns:read`}),`, `,_jsx(_components.code,{children:`campaigns:create`}),`, `,_jsx(_components.code,{children:`campaigns:run`}),`, `,_jsx(_components.code,{children:`segments:read`})]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:`Full management`}),_jsx(_components.td,{children:_jsx(_components.code,{children:`campaigns:*`})})]})]})]}),`\n`,_jsx(_components.p,{children:`Related scopes on the same integrator:`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:_jsx(_components.code,{children:`segments:read`})}),` — validate audience`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:_jsx(_components.code,{children:`templates:read`})}),` — choose template`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:_jsx(_components.code,{children:`messages:send`})}),` — if sending goes through the messages API instead of campaigns`]}),`\n`]}),`\n`,_jsx(Heading,{level:`2`,id:`common-errors`,children:`Common errors`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Code`}),_jsx(_components.th,{children:`Cause`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.strong,{children:`403`})}),_jsxs(_components.td,{children:[`Missing `,_jsx(_components.code,{children:`campaigns:create`})]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.strong,{children:`400`})}),_jsx(_components.td,{children:`Empty segment, template incompatible with channel`})]}),_jsxs(_components.tr,{children:[_jsxs(_components.td,{children:[_jsx(_components.strong,{children:`403`}),` `,_jsx(_components.code,{children:`PLAN_LIMIT`})]}),_jsx(_components.td,{children:`Campaign or send limit for the plan`})]})]})]}),`\n`,_jsx(Heading,{level:`2`,id:`next-steps`,children:`Next steps`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:_jsx(_components.a,{href:`/en/contacts-api/como-funciona/campanhas-quick-start`,children:`Quick Start — Campaigns`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.a,{href:`/en/contacts-api/como-funciona/campanhas-no-painel`,children:`Campaigns in the dashboard`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.a,{href:`/en/contacts-api/como-funciona/escopos-da-api-key`,children:`General scopes`})}),`\n`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Scopes — Campaigns","description":"API Key permissions to create and monitor campaigns (`campaigns:*`).","icon":"key","slug":"escopos-campanhas","href":"/en/contacts-api/como-funciona/campanhas-escopos-da-api-key"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Scopes","slug":"scopes","depth":2,"children":[]},{"title":"Common combinations","slug":"common-combinations","depth":2,"children":[]},{"title":"Common errors","slug":"common-errors","depth":2,"children":[]},{"title":"Next steps","slug":"next-steps","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"tribus","siteName":"Notifique","title":"Scopes — Campaigns - Notifique","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"pt-BR":{"href":"/en/contacts-api/como-funciona/campanhas-escopos-da-api-key","matchLevel":0},"en":{"href":"/en/welcome/welcome","matchLevel":4},"es":{"href":"/es/welcome/welcome","matchLevel":4}}},"lastModified":"2026-09-03T00:08:42.830Z","originalFileLocation":"en/contacts-api/como-funciona/campanhas-escopos-da-api-key.md","locale":"pt-BR"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"API Key permissions to create and monitor campaigns (campaigns:*).\">\u003cmeta data-mint-head name=\"application-name\" content=\"Notifique\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/tribus/lrSzNckWGT07xfjB/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/tribus/lrSzNckWGT07xfjB/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/tribus/lrSzNckWGT07xfjB/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/tribus/lrSzNckWGT07xfjB/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/tribus/lrSzNckWGT07xfjB/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/tribus/lrSzNckWGT07xfjB/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/tribus/lrSzNckWGT07xfjB/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/tribus/lrSzNckWGT07xfjB/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/tribus/lrSzNckWGT07xfjB/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Scopes — Campaigns - Notifique\">\u003cmeta data-mint-head property=\"og:description\" content=\"API Key permissions to create and monitor campaigns (campaigns:*).\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Notifique\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.notifique.dev/en/contacts-api/como-funciona/campanhas-escopos-da-api-key\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://tribus.mintlify.app/_mintlify/api/og/v2?division=Documentation\u0026amp;title=Scopes+%E2%80%94+Campaigns\u0026amp;description=API+Key+permissions+to+create+and+monitor+campaigns+%28%60campaigns%3A*%60%29.\u0026amp;theme=8c9a8f58518c7b0a360dbb49\u0026amp;signature=c2caad8e00f16ea34f6d04b54b6922899466df9ceaf94c8719c418a18865592a\">\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=\"Scopes — Campaigns - Notifique\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"API Key permissions to create and monitor campaigns (campaigns:*).\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://tribus.mintlify.app/_mintlify/api/og/v2?division=Documentation\u0026amp;title=Scopes+%E2%80%94+Campaigns\u0026amp;description=API+Key+permissions+to+create+and+monitor+campaigns+%28%60campaigns%3A*%60%29.\u0026amp;theme=8c9a8f58518c7b0a360dbb49\u0026amp;signature=c2caad8e00f16ea34f6d04b54b6922899466df9ceaf94c8719c418a18865592a\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/tribus/lrSzNckWGT07xfjB/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Notifique\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#fbbf24\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.notifique.dev/en/contacts-api/como-funciona/campanhas-escopos-da-api-key\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/en/contacts-api/como-funciona/campanhas-escopos-da-api-key.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Notifique\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Notifique","nav":{"global":null,"languages":[{"language":"pt-BR","default":true,"navbar":{"links":[{"href":"https://status.notifique.dev","label":"Status"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.notifique.dev"}},"tabs":[{"tab":"Bem-vindo","pages":[{"title":"Notifique.dev","mode":"custom","href":"/welcome/welcome"}]},{"tab":"Guias","groups":[{"group":"Guias simples","pages":[{"title":"Comece aqui","icon":"golf-flag-hole","href":"/guides/introducao/comece-aqui"},{"title":"Sandbox","icon":"flask","href":"/guides/sandbox/index"},{"title":"Chaves de API","icon":"key","href":"/guides/api-key/index"},{"title":"Webhooks","icon":"webhook","href":"/guides/webhooks/index"}]},{"group":"Conheça mais","pages":[{"title":"Respostas de Erro","icon":"block-brick","href":"/guides/conceitos/resposta-de-erros"},{"title":"Identificadores de remetente","href":"/guides/conceitos/identificadores-de-remetente"},{"title":"Cobrança","icon":"wallet","href":"/guides/introducao/cobranca-e-pague-pelo-uso"},{"title":"Segurança e Confiabilidade","icon":"lock-hashtag","href":"/guides/conceitos/seguranca-e-confiabilidade"},{"title":"Logs da API","icon":"list-ul","href":"/guides/logs/index"},{"title":"API de denúncias (FELCA)","icon":"shield-exclamation","href":"/guides/compliance/report-api"}]},{"group":"Workspaces","pages":[{"title":"Workspaces","icon":"building","href":"/guides/workspaces/index"},{"title":"Trust Factor","icon":"shield-check","href":"/guides/workspaces/trust-factor"}]},{"group":"OAuth 2.1","pages":[{"title":"Introdução","icon":"shield-halved","href":"/oauth-api/como-funciona/introducao"},{"title":"Quick Start","icon":"bolt","href":"/oauth-api/como-funciona/quick-start"},{"title":"Escopos","icon":"key","href":"/oauth-api/como-funciona/escopos"},{"title":"MCP","icon":"plug","href":"/oauth-api/como-funciona/mcp"},{"title":"Construir um cliente","icon":"code","href":"/oauth-api/como-funciona/construir-cliente"},{"title":"Guia técnico do cliente","icon":"diagram-project","href":"/oauth-api/como-funciona/guia-tecnico-cliente"}]},{"group":"IA e no-code","pages":[{"title":"Construa com IA","icon":"flag","href":"/build-with-ai/hub"},{"title":"MCP da Notifique","icon":"robot","href":"/build-with-ai/mcp-notifique"},{"title":"Skills da Notifique","icon":"sparkles","href":"/build-with-ai/skills"},{"title":"LLMs.txt da Notifique","icon":"book-open","href":"/build-with-ai/llm"},{"title":"n8n + Notifique","icon":"user-robot","href":"/build-with-ai/n8n"}]},{"group":"BYOK","pages":[{"title":"BYOK, Bring Your Own Key","icon":"key","href":"/byok/index"},{"title":"Resend (e-mail)","icon":"mailbox-flag-up","href":"/byok/resend"},{"title":"Amazon SES (e-mail)","icon":"cloud","href":"/byok/ses"}]},{"group":"Changelog","pages":[{"title":"Changelog","icon":"up-down","href":"/changelog"}]},{"group":"Platform API","pages":[{"title":"Introdução","icon":"server","href":"/platform-api/como-funciona/introducao"},{"title":"Quick Start","icon":"bolt","href":"/platform-api/como-funciona/quick-start"},{"title":"Registro e verificação","icon":"id-card","href":"/platform-api/como-funciona/registro-e-verificacao"},{"title":"Billing via API","icon":"credit-card","href":"/platform-api/como-funciona/billing"},{"title":"Escopos da API Key","icon":"key","href":"/platform-api/como-funciona/escopos-api-key"},{"title":"Webhooks","icon":"webhook","href":"/platform-api/como-funciona/webhooks"},{"title":"Workspaces","icon":"building","href":"/platform-api/como-funciona/workspaces"},{"title":"Logs da API","icon":"list-ul","href":"/platform-api/como-funciona/logs"},{"title":"Métricas (overview)","icon":"chart-line","href":"/platform-api/como-funciona/metrics"},{"title":"Notify (fallback multicanal)","icon":"layer-group","href":"/platform-api/como-funciona/notify"},{"title":"OAuth","icon":"shield-halved","href":"/platform-api/como-funciona/oauth"}]},{"group":"Conta","pages":[{"title":"Registrar conta","deprecated":null,"version":null,"openapi":"/es/platform-api/api-reference/openapi-platform.json post /v1/platform/register","href":"/api-reference/platform:-conta/registrar-conta"},{"title":"Verificar telefone","deprecated":null,"version":null,"openapi":"/es/platform-api/api-reference/openapi-platform.json post /v1/platform/verify","href":"/api-reference/platform:-conta/verificar-telefone"},{"title":"Login","deprecated":null,"version":null,"openapi":"/es/platform-api/api-reference/openapi-platform.json post /v1/platform/login","href":"/api-reference/platform:-conta/login"},{"title":"Perfil da sessão","deprecated":null,"version":null,"openapi":"/es/platform-api/api-reference/openapi-platform.json get /v1/platform/me","href":"/api-reference/platform:-conta/perfil-da-sessão"},{"title":"Listar workspaces do usuário","deprecated":null,"version":null,"openapi":"/es/platform-api/api-reference/openapi-platform.json get /v1/platform/workspaces","href":"/api-reference/platform:-workspaces/listar-workspaces-do-usuário"}]},{"group":"API Keys","pages":[{"title":"Listar API keys","deprecated":null,"version":null,"openapi":"/es/platform-api/api-reference/openapi-platform.json get /v1/platform/api-keys","href":"/api-reference/platform:-api-keys/listar-api-keys"},{"title":"Criar API key","deprecated":null,"version":null,"openapi":"/es/platform-api/api-reference/openapi-platform.json post /v1/platform/api-keys","href":"/api-reference/platform:-api-keys/criar-api-key"},{"title":"Consultar API key","deprecated":null,"version":null,"openapi":"/es/platform-api/api-reference/openapi-platform.json get /v1/platform/api-keys/{id}","href":"/api-reference/platform:-api-keys/consultar-api-key"},{"title":"Editar API key","deprecated":null,"version":null,"openapi":"/es/platform-api/api-reference/openapi-platform.json patch /v1/platform/api-keys/{id}","href":"/api-reference/platform:-api-keys/editar-api-key"},{"title":"Revogar API key","deprecated":null,"version":null,"openapi":"/es/platform-api/api-reference/openapi-platform.json post /v1/platform/api-keys/{id}/revoke","href":"/api-reference/platform:-api-keys/revogar-api-key"},{"title":"Excluir API key","deprecated":null,"version":null,"openapi":"/platform-api/api-reference/openapi-platform.json delete /v1/platform/api-keys/{id}","href":"/api-reference/platform:-api-keys/excluir-api-key"}]},{"group":"Billing","pages":[{"title":"Consultar assinatura","deprecated":null,"version":null,"openapi":"/es/platform-api/api-reference/openapi-platform.json get /v1/platform/workspaces/{id}/subscription","href":"/api-reference/platform:-billing/consultar-assinatura"},{"title":"Assinar ou mudar plano","deprecated":null,"version":null,"openapi":"/es/platform-api/api-reference/openapi-platform.json post /v1/platform/workspaces/{id}/subscription","href":"/api-reference/platform:-billing/assinar-ou-mudar-plano"},{"title":"Cancelar assinatura","deprecated":null,"version":null,"openapi":"/es/platform-api/api-reference/openapi-platform.json delete /v1/platform/workspaces/{id}/subscription","href":"/api-reference/platform:-billing/cancelar-assinatura"},{"title":"Consultar saldo","deprecated":null,"version":null,"openapi":"/es/platform-api/api-reference/openapi-platform.json get /v1/platform/workspaces/{id}/balance","href":"/api-reference/platform:-billing/consultar-saldo"},{"title":"Recarregar saldo","deprecated":null,"version":null,"openapi":"/es/platform-api/api-reference/openapi-platform.json post /v1/platform/workspaces/{id}/balance/recharge","href":"/api-reference/platform:-billing/recarregar-saldo"},{"title":"Listar cartões","deprecated":null,"version":null,"openapi":"/es/platform-api/api-reference/openapi-platform.json get /v1/platform/workspaces/{id}/payment-methods","href":"/api-reference/platform:-billing/listar-cartões"},{"title":"Cadastrar cartão","deprecated":null,"version":null,"openapi":"/es/platform-api/api-reference/openapi-platform.json post /v1/platform/workspaces/{id}/payment-methods","href":"/api-reference/platform:-billing/cadastrar-cartão"},{"title":"Atualizar cartão","deprecated":null,"version":null,"openapi":"/es/platform-api/api-reference/openapi-platform.json patch /v1/platform/workspaces/{id}/payment-methods/{pmId}","href":"/api-reference/platform:-billing/atualizar-cartão"},{"title":"Remover cartão","deprecated":null,"version":null,"openapi":"/es/platform-api/api-reference/openapi-platform.json delete /v1/platform/workspaces/{id}/payment-methods/{pmId}","href":"/api-reference/platform:-billing/remover-cartão"}]},{"group":"Créditos","pages":[{"title":"Histórico detalhado de uso de créditos","deprecated":null,"version":null,"openapi":"/es/platform-api/api-reference/openapi-platform.json get /v1/platform/workspaces/{id}/credits/usage","href":"/api-reference/platform:-billing/histórico-detalhado-de-uso-de-créditos"}]},{"group":"Equipe","pages":[{"title":"Listar membros","deprecated":null,"version":null,"openapi":"/es/platform-api/api-reference/openapi-platform.json get /v1/platform/workspaces/{id}/members","href":"/api-reference/platform:-equipe/listar-membros"},{"title":"Remover membro","deprecated":null,"version":null,"openapi":"/es/platform-api/api-reference/openapi-platform.json delete /v1/platform/workspaces/{id}/members/{userId}","href":"/api-reference/platform:-equipe/remover-membro"},{"title":"Listar convites pendentes","deprecated":null,"version":null,"openapi":"/es/platform-api/api-reference/openapi-platform.json get /v1/platform/workspaces/{id}/invites","href":"/api-reference/platform:-equipe/listar-convites-pendentes"},{"title":"Convidar membro","deprecated":null,"version":null,"openapi":"/es/platform-api/api-reference/openapi-platform.json post /v1/platform/workspaces/{id}/invites","href":"/api-reference/platform:-equipe/convidar-membro"},{"title":"Cancelar convite","deprecated":null,"version":null,"openapi":"/es/platform-api/api-reference/openapi-platform.json delete /v1/platform/workspaces/{id}/invites/{inviteId}","href":"/api-reference/platform:-equipe/cancelar-convite"}]},{"group":"Metadados","pages":[{"title":"Metadados do Authorization Server","deprecated":null,"version":null,"openapi":"/es/oauth-api/api-reference/openapi-oauth.json get /.well-known/oauth-authorization-server","href":"/api-reference/metadados/metadados-do-authorization-server"},{"title":"Chaves públicas (JWKS)","deprecated":null,"version":null,"openapi":"/es/oauth-api/api-reference/openapi-oauth.json get /.well-known/jwks.json","href":"/api-reference/metadados/chaves-públicas-jwks"},{"title":"Metadados do recurso MCP","deprecated":null,"version":null,"openapi":"/es/oauth-api/api-reference/openapi-oauth.json get /.well-known/oauth-protected-resource","href":"/api-reference/metadados/metadados-do-recurso-mcp"}]},{"group":"OAuth","pages":[{"title":"Registrar cliente (DCR)","deprecated":null,"version":null,"openapi":"/es/oauth-api/api-reference/openapi-oauth.json post /oauth/register","href":"/api-reference/oauth/registrar-cliente-dcr"},{"title":"Autorizar (browser)","deprecated":null,"version":null,"openapi":"/es/oauth-api/api-reference/openapi-oauth.json get /oauth/authorize","href":"/api-reference/oauth/autorizar-browser"},{"title":"Obter ou renovar tokens","deprecated":null,"version":null,"openapi":"/es/oauth-api/api-reference/openapi-oauth.json post /oauth/token","href":"/api-reference/oauth/obter-ou-renovar-tokens"},{"title":"Revogar token","deprecated":null,"version":null,"openapi":"/es/oauth-api/api-reference/openapi-oauth.json post /oauth/revoke","href":"/api-reference/oauth/revogar-token"},{"title":"Listar OAuth apps do workspace","deprecated":null,"version":null,"openapi":"/es/oauth-api/api-reference/openapi-oauth.json get /v1/oauth/apps","href":"/api-reference/oauth-apps/listar-oauth-apps-do-workspace"},{"title":"Criar OAuth app","deprecated":null,"version":null,"openapi":"/es/oauth-api/api-reference/openapi-oauth.json post /v1/oauth/apps","href":"/api-reference/oauth-apps/criar-oauth-app"},{"title":"Consultar OAuth app","deprecated":null,"version":null,"openapi":"/es/oauth-api/api-reference/openapi-oauth.json get /v1/oauth/apps/{id}","href":"/api-reference/oauth-apps/consultar-oauth-app"},{"title":"Atualizar OAuth app","deprecated":null,"version":null,"openapi":"/es/oauth-api/api-reference/openapi-oauth.json patch /v1/oauth/apps/{id}","href":"/api-reference/oauth-apps/atualizar-oauth-app"},{"title":"Excluir OAuth app","deprecated":null,"version":null,"openapi":"/es/oauth-api/api-reference/openapi-oauth.json delete /v1/oauth/apps/{id}","href":"/api-reference/oauth-apps/excluir-oauth-app"},{"title":"Rotacionar client secret","deprecated":null,"version":null,"openapi":"/es/oauth-api/api-reference/openapi-oauth.json post /v1/oauth/apps/{id}/rotate-secret","href":"/api-reference/oauth-apps/rotacionar-client-secret"},{"title":"Listar apps conectados","deprecated":null,"version":null,"openapi":"/es/oauth-api/api-reference/openapi-oauth.json get /v1/oauth/connections","href":"/api-reference/oauth-apps/listar-apps-conectados"},{"title":"Revogar conexão","deprecated":null,"version":null,"openapi":"/es/oauth-api/api-reference/openapi-oauth.json post /v1/oauth/connections/{id}/revoke","href":"/api-reference/oauth-apps/revogar-conexão"}]},{"group":"Webhooks","pages":[{"title":"Listar webhooks","deprecated":null,"version":null,"openapi":"/es/guides/webhooks/api-reference/openapi-webhooks.json get /v1/webhooks","href":"/api-reference/webhooks/listar-webhooks"},{"title":"Criar webhook","deprecated":null,"version":null,"openapi":"/es/guides/webhooks/api-reference/openapi-webhooks.json post /v1/webhooks","href":"/api-reference/webhooks/criar-webhook"},{"title":"Consultar webhook","deprecated":null,"version":null,"openapi":"/es/guides/webhooks/api-reference/openapi-webhooks.json get /v1/webhooks/{id}","href":"/api-reference/webhooks/consultar-webhook"},{"title":"Atualizar webhook","deprecated":null,"version":null,"openapi":"/es/guides/webhooks/api-reference/openapi-webhooks.json put /v1/webhooks/{id}","href":"/api-reference/webhooks/atualizar-webhook"},{"title":"Atualizar cabeçalhos/URL","deprecated":null,"version":null,"openapi":"/guides/webhooks/api-reference/openapi-webhooks.json patch /v1/webhooks/{id}","href":"/api-reference/webhooks/atualizar-cabeçalhosurl"},{"title":"Excluir webhook","deprecated":null,"version":null,"openapi":"/es/guides/webhooks/api-reference/openapi-webhooks.json delete /v1/webhooks/{id}","href":"/api-reference/webhooks/excluir-webhook"},{"title":"Rotacionar secret do webhook","deprecated":null,"version":null,"openapi":"/es/guides/webhooks/api-reference/openapi-webhooks.json post /v1/webhooks/{id}/rotate-secret","href":"/api-reference/webhooks/rotacionar-secret-do-webhook"}]},{"group":"Entregas","pages":[{"title":"Listar entregas","deprecated":null,"version":null,"openapi":"/es/guides/webhooks/api-reference/openapi-webhooks.json get /v1/webhooks/deliveries","href":"/api-reference/entregas/listar-entregas"},{"title":"Detalhe da entrega","deprecated":null,"version":null,"openapi":"/es/guides/webhooks/api-reference/openapi-webhooks.json get /v1/webhooks/deliveries/{deliveryId}","href":"/api-reference/entregas/detalhe-da-entrega"},{"title":"Reenviar entrega","deprecated":null,"version":null,"openapi":"/es/guides/webhooks/api-reference/openapi-webhooks.json post /v1/webhooks/deliveries/{deliveryId}/resend","href":"/api-reference/entregas/reenviar-entrega"}]},{"group":"Logs","pages":[{"title":"Listar logs","deprecated":null,"version":null,"openapi":"/es/guides/logs/api-reference/openapi-logs.json get /v1/logs","href":"/api-reference/logs/listar-logs"},{"title":"Detalhe do log","deprecated":null,"version":null,"openapi":"/es/guides/logs/api-reference/openapi-logs.json get /v1/logs/{id}","href":"/api-reference/logs/detalhe-do-log"}]},{"group":"Workspaces","pages":[{"title":"Listar workspace da chave","deprecated":null,"version":null,"openapi":"/es/guides/workspaces/api-reference/openapi-workspaces.json get /v1/workspaces","href":"/api-reference/workspaces/listar-workspace-da-chave"},{"title":"Criar workspace","deprecated":null,"version":null,"openapi":"/es/guides/workspaces/api-reference/openapi-workspaces.json post /v1/workspaces","href":"/api-reference/workspaces/criar-workspace"},{"title":"Obter workspace","deprecated":null,"version":null,"openapi":"/es/guides/workspaces/api-reference/openapi-workspaces.json get /v1/workspaces/{id}","href":"/api-reference/workspaces/obter-workspace"},{"title":"Editar workspace","deprecated":null,"version":null,"openapi":"/es/guides/workspaces/api-reference/openapi-workspaces.json put /v1/workspaces/{id}","href":"/api-reference/workspaces/editar-workspace"},{"title":"Deletar workspace","deprecated":null,"version":null,"openapi":"/es/guides/workspaces/api-reference/openapi-workspaces.json delete /v1/workspaces/{id}","href":"/api-reference/workspaces/deletar-workspace"}]}]},{"tab":"WhatsApp","groups":[{"group":"API WhatsApp","pages":[{"title":"Introdução","icon":"whatsapp","href":"/whatsapp-api/como-funciona/introducao"},{"title":"Indicador de digitação","icon":"message-circle","href":"/whatsapp-api/como-funciona/presenca"},{"title":"Quick Start","icon":"bolt","href":"/whatsapp-api/como-funciona/quick-start"},{"title":"Grupos","sidebarTitle":"Grupos","icon":"users","href":"/whatsapp-api/grupos/introducao"},{"title":"Chamadas","sidebarTitle":"Chamadas","icon":"phone","href":"/whatsapp-api/chamadas/introducao"},{"title":"Modos de conexão","icon":"split","href":"/whatsapp-api/como-funciona/modos-de-conexao"},{"title":"Política anti-banimento","icon":"lock-hashtag","href":"/whatsapp-api/como-funciona/politica-anti-banimento"},{"title":"Escopos da API Key","icon":"key","href":"/whatsapp-api/como-funciona/escopos-api-key"},{"title":"Eventos dos Webhooks","icon":"code-merge","href":"/whatsapp-api/como-funciona/eventos-do-webhooks"},{"title":"Sending Pools (múltiplos números)","icon":"shuffle","href":"/whatsapp-api/como-funciona/sending-pools"}]},{"group":"Mensagens","pages":[{"title":"Listar mensagens WhatsApp","deprecated":null,"version":null,"openapi":"/whatsapp-api/api-reference/openapi-whatsapp.json get /v1/whatsapp/messages","href":"/api-reference/mensagens/listar-mensagens-whatsapp"},{"title":"Enviar mensagem WhatsApp","deprecated":null,"version":null,"openapi":"/whatsapp-api/api-reference/openapi-whatsapp.json post /v1/whatsapp/messages","href":"/api-reference/mensagens/enviar-mensagem-whatsapp"},{"title":"Listar recebidos WhatsApp","deprecated":null,"version":null,"openapi":"/es/whatsapp-api/api-reference/openapi-whatsapp.json get /v1/whatsapp/messages/inbound","href":"/api-reference/mensagens/listar-recebidos-whatsapp"},{"title":"Consultar recebido WhatsApp","deprecated":null,"version":null,"openapi":"/es/whatsapp-api/api-reference/openapi-whatsapp.json get /v1/whatsapp/messages/inbound/{id}","href":"/api-reference/mensagens/consultar-recebido-whatsapp"},{"title":"Baixar mídia recebida (base64)","deprecated":null,"version":null,"openapi":"/es/whatsapp-api/api-reference/openapi-whatsapp.json post /v1/whatsapp/messages/inbound/{id}/media","href":"/api-reference/mensagens/baixar-mídia-recebida-base64"},{"title":"Baixar mídia recebida (arquivo)","deprecated":null,"version":null,"openapi":"/es/whatsapp-api/api-reference/openapi-whatsapp.json get /v1/whatsapp/messages/inbound/{id}/media/download","href":"/api-reference/mensagens/baixar-mídia-recebida-arquivo"},{"title":"Enviar presença no chat WhatsApp","deprecated":null,"version":null,"openapi":"/whatsapp-api/api-reference/openapi-whatsapp.json post /v1/whatsapp/messages/presence","href":"/api-reference/mensagens/enviar-presença-no-chat-whatsapp"},{"title":"Consultar envio WhatsApp","deprecated":null,"version":null,"openapi":"/whatsapp-api/api-reference/openapi-whatsapp.json get /v1/whatsapp/messages/{messageId}","href":"/api-reference/mensagens/consultar-envio-whatsapp"},{"title":"Apagar mensagem WhatsApp","deprecated":null,"version":null,"openapi":"/whatsapp-api/api-reference/openapi-whatsapp.json delete /v1/whatsapp/messages/{messageId}","href":"/api-reference/mensagens/apagar-mensagem-whatsapp"},{"title":"Editar mensagem WhatsApp","deprecated":null,"version":null,"openapi":"/whatsapp-api/api-reference/openapi-whatsapp.json patch /v1/whatsapp/messages/{messageId}/edit","href":"/api-reference/mensagens/editar-mensagem-whatsapp"},{"title":"Cancelar WhatsApp agendado","deprecated":null,"version":null,"openapi":"/whatsapp-api/api-reference/openapi-whatsapp.json post /v1/whatsapp/messages/{messageId}/cancel","href":"/api-reference/mensagens/cancelar-whatsapp-agendado"}]},{"group":"Instâncias","pages":[{"title":"Listar conexões WhatsApp","deprecated":null,"version":null,"openapi":"/whatsapp-api/api-reference/openapi-whatsapp.json get /v1/whatsapp/instances","href":"/api-reference/instâncias/listar-conexões-whatsapp"},{"title":"Criar instância WhatsApp","deprecated":null,"version":null,"openapi":"/whatsapp-api/api-reference/openapi-whatsapp.json post /v1/whatsapp/instances","href":"/api-reference/instâncias/criar-instância-whatsapp"},{"title":"Consultar conexão WhatsApp","deprecated":null,"version":null,"openapi":"/whatsapp-api/api-reference/openapi-whatsapp.json get /v1/whatsapp/instances/{instanceId}","href":"/api-reference/instâncias/consultar-conexão-whatsapp"},{"title":"Remover conexão WhatsApp","deprecated":null,"version":null,"openapi":"/whatsapp-api/api-reference/openapi-whatsapp.json delete /v1/whatsapp/instances/{instanceId}","href":"/api-reference/instâncias/remover-conexão-whatsapp"},{"title":"Atualizar instância WhatsApp","deprecated":null,"version":null,"openapi":"/whatsapp-api/api-reference/openapi-whatsapp.json patch /v1/whatsapp/instances/{instanceId}","href":"/api-reference/instâncias/atualizar-instância-whatsapp"},{"title":"Status do link WhatsApp","deprecated":null,"version":null,"openapi":"/whatsapp-api/api-reference/openapi-whatsapp.json get /v1/whatsapp/instances/{instanceId}/connect-page","href":"/api-reference/instâncias/status-do-link-whatsapp"},{"title":"Ativar link WhatsApp","deprecated":null,"version":null,"openapi":"/whatsapp-api/api-reference/openapi-whatsapp.json post /v1/whatsapp/instances/{instanceId}/connect-page/enable","href":"/api-reference/instâncias/ativar-link-whatsapp"},{"title":"Renovar secret do link WhatsApp","deprecated":null,"version":null,"openapi":"/whatsapp-api/api-reference/openapi-whatsapp.json post /v1/whatsapp/instances/{instanceId}/connect-page/rotate-secret","href":"/api-reference/instâncias/renovar-secret-do-link-whatsapp"},{"title":"Desativar link WhatsApp","deprecated":null,"version":null,"openapi":"/whatsapp-api/api-reference/openapi-whatsapp.json post /v1/whatsapp/instances/{instanceId}/connect-page/disable","href":"/api-reference/instâncias/desativar-link-whatsapp"},{"title":"Obter código de pareamento","deprecated":null,"version":null,"openapi":"/whatsapp-api/api-reference/openapi-whatsapp.json get /v1/whatsapp/instances/{instanceId}/pairing-code","href":"/api-reference/instâncias/obter-código-de-pareamento"},{"title":"Obter QR WhatsApp","deprecated":null,"version":null,"openapi":"/whatsapp-api/api-reference/openapi-whatsapp.json get /v1/whatsapp/instances/{instanceId}/qr","href":"/api-reference/instâncias/obter-qr-whatsapp"},{"title":"Desconectar WhatsApp","deprecated":null,"version":null,"openapi":"/es/whatsapp-api/api-reference/openapi-whatsapp.json post /v1/whatsapp/instances/{instanceId}/disconnect","href":"/api-reference/instâncias/desconectar-whatsapp"},{"title":"Sincronizar templates Meta","deprecated":null,"version":null,"openapi":"/whatsapp-api/api-reference/openapi-whatsapp.json post /v1/whatsapp/instances/{instanceId}/meta/sync-templates","href":"/api-reference/instâncias/sincronizar-templates-meta"},{"title":"Enviar template para Meta","deprecated":null,"version":null,"openapi":"/whatsapp-api/api-reference/openapi-whatsapp.json post /v1/whatsapp/instances/{instanceId}/meta/push-template","href":"/api-reference/instâncias/enviar-template-para-meta"}]},{"group":"Grupos","pages":[{"title":"Listar grupos WhatsApp","deprecated":null,"version":null,"openapi":"/es/whatsapp-api/api-reference/openapi-whatsapp.json get /v1/whatsapp/instances/{instanceId}/groups","href":"/api-reference/grupos/listar-grupos-whatsapp"},{"title":"Criar grupo WhatsApp","deprecated":null,"version":null,"openapi":"/whatsapp-api/api-reference/openapi-whatsapp.json post /v1/whatsapp/instances/{instanceId}/groups","href":"/api-reference/grupos/criar-grupo-whatsapp"},{"title":"Listar participantes do grupo","deprecated":null,"version":null,"openapi":"/whatsapp-api/api-reference/openapi-whatsapp.json get /v1/whatsapp/instances/{instanceId}/groups/{groupId}/participants","href":"/api-reference/grupos/listar-participantes-do-grupo"},{"title":"Atualizar participantes do grupo","deprecated":null,"version":null,"openapi":"/whatsapp-api/api-reference/openapi-whatsapp.json post /v1/whatsapp/instances/{instanceId}/groups/participants","href":"/api-reference/grupos/atualizar-participantes-do-grupo"},{"title":"Enviar convite de grupo","deprecated":null,"version":null,"openapi":"/whatsapp-api/api-reference/openapi-whatsapp.json post /v1/whatsapp/instances/{instanceId}/groups/invite","href":"/api-reference/grupos/enviar-convite-de-grupo"},{"title":"Revogar convite de grupo","deprecated":null,"version":null,"openapi":"/whatsapp-api/api-reference/openapi-whatsapp.json post /v1/whatsapp/instances/{instanceId}/groups/invite/revoke","href":"/api-reference/grupos/revogar-convite-de-grupo"},{"title":"Obter código de convite","deprecated":null,"version":null,"openapi":"/whatsapp-api/api-reference/openapi-whatsapp.json get /v1/whatsapp/instances/{instanceId}/groups/invite-code","href":"/api-reference/grupos/obter-código-de-convite"},{"title":"Entrar em grupo via link","deprecated":null,"version":null,"openapi":"/whatsapp-api/api-reference/openapi-whatsapp.json post /v1/whatsapp/instances/{instanceId}/groups/join","href":"/api-reference/grupos/entrar-em-grupo-via-link"},{"title":"Detalhes do grupo","deprecated":null,"version":null,"openapi":"/whatsapp-api/api-reference/openapi-whatsapp.json get /v1/whatsapp/instances/{instanceId}/groups/{groupId}","href":"/api-reference/grupos/detalhes-do-grupo"},{"title":"Atualizar grupo","deprecated":null,"version":null,"openapi":"/whatsapp-api/api-reference/openapi-whatsapp.json patch /v1/whatsapp/instances/{instanceId}/groups/{groupId}","href":"/api-reference/grupos/atualizar-grupo"},{"title":"Criar grupo (legado)","deprecated":null,"version":null,"openapi":"/whatsapp-api/api-reference/openapi-whatsapp.json post /v1/whatsapp/groups","href":"/api-reference/grupos/criar-grupo-legado"},{"title":"Enviar mensagem em grupos","deprecated":null,"version":null,"openapi":"/whatsapp-api/api-reference/openapi-whatsapp.json post /v1/whatsapp/groups/messages","href":"/api-reference/grupos/enviar-mensagem-em-grupos"},{"title":"Listar grupos (legado)","deprecated":null,"version":null,"openapi":"/es/whatsapp-api/api-reference/openapi-whatsapp.json get /v1/whatsapp/{instanceId}/groups","href":"/api-reference/grupos/listar-grupos-legado"},{"title":"Atualizar grupos (legado)","deprecated":null,"version":null,"openapi":"/whatsapp-api/api-reference/openapi-whatsapp.json patch /v1/whatsapp/{instanceId}/groups","href":"/api-reference/grupos/atualizar-grupos-legado"},{"title":"Criar grupo (legado path)","deprecated":null,"version":null,"openapi":"/whatsapp-api/api-reference/openapi-whatsapp.json post /v1/whatsapp/{instanceId}/groups","href":"/api-reference/grupos/criar-grupo-legado-path"},{"title":"Listar participantes (legado)","deprecated":null,"version":null,"openapi":"/es/whatsapp-api/api-reference/openapi-whatsapp.json get /v1/whatsapp/{instanceId}/groups/participants","href":"/api-reference/grupos/listar-participantes-legado"}]},{"group":"Chamadas","pages":[{"title":"Listar chamadas WhatsApp","deprecated":null,"version":null,"openapi":"/whatsapp-api/api-reference/openapi-whatsapp.json get /v1/whatsapp/calls","href":"/api-reference/chamadas/listar-chamadas-whatsapp"},{"title":"Iniciar chamada WhatsApp","deprecated":null,"version":null,"openapi":"/whatsapp-api/api-reference/openapi-whatsapp.json post /v1/whatsapp/calls","href":"/api-reference/chamadas/iniciar-chamada-whatsapp"},{"title":"Consultar chamada WhatsApp","deprecated":null,"version":null,"openapi":"/whatsapp-api/api-reference/openapi-whatsapp.json get /v1/whatsapp/calls/{id}","href":"/api-reference/chamadas/consultar-chamada-whatsapp"},{"title":"Settings de chamada","deprecated":null,"version":null,"openapi":"/es/whatsapp-api/api-reference/openapi-whatsapp.json get /v1/whatsapp/instances/{instanceId}/calling/settings","href":"/api-reference/chamadas/settings-de-chamada"},{"title":"Atualizar settings","deprecated":null,"version":null,"openapi":"/es/whatsapp-api/api-reference/openapi-whatsapp.json patch /v1/whatsapp/instances/{instanceId}/calling/settings","href":"/api-reference/chamadas/atualizar-settings"},{"title":"Permissão de chamada","deprecated":null,"version":null,"openapi":"/es/whatsapp-api/api-reference/openapi-whatsapp.json get /v1/whatsapp/instances/{instanceId}/calling/permissions","href":"/api-reference/chamadas/permissão-de-chamada"},{"title":"Solicitar permissão","deprecated":null,"version":null,"openapi":"/es/whatsapp-api/api-reference/openapi-whatsapp.json post /v1/whatsapp/instances/{instanceId}/calling/permissions/request","href":"/api-reference/chamadas/solicitar-permissão"}]},{"group":"Sending pools","pages":[{"title":"Listar pools","deprecated":null,"version":null,"openapi":"/es/whatsapp-api/api-reference/openapi-whatsapp.json get /v1/sending-pools","href":"/api-reference/sending-pools/listar-pools"},{"title":"Criar pool","deprecated":null,"version":null,"openapi":"/es/whatsapp-api/api-reference/openapi-whatsapp.json post /v1/sending-pools","href":"/api-reference/sending-pools/criar-pool"},{"title":"Obter pool","deprecated":null,"version":null,"openapi":"/es/whatsapp-api/api-reference/openapi-whatsapp.json get /v1/sending-pools/{id}","href":"/api-reference/sending-pools/obter-pool"},{"title":"Atualizar pool","deprecated":null,"version":null,"openapi":"/es/whatsapp-api/api-reference/openapi-whatsapp.json put /v1/sending-pools/{id}","href":"/api-reference/sending-pools/atualizar-pool"},{"title":"Excluir pool","deprecated":null,"version":null,"openapi":"/es/whatsapp-api/api-reference/openapi-whatsapp.json delete /v1/sending-pools/{id}","href":"/api-reference/sending-pools/excluir-pool"},{"title":"Adicionar membro","deprecated":null,"version":null,"openapi":"/es/whatsapp-api/api-reference/openapi-whatsapp.json post /v1/sending-pools/{id}/members","href":"/api-reference/sending-pools/adicionar-membro"},{"title":"Atualizar membro","deprecated":null,"version":null,"openapi":"/es/whatsapp-api/api-reference/openapi-whatsapp.json put /v1/sending-pools/{id}/members/{memberId}","href":"/api-reference/sending-pools/atualizar-membro"},{"title":"Remover membro","deprecated":null,"version":null,"openapi":"/es/whatsapp-api/api-reference/openapi-whatsapp.json delete /v1/sending-pools/{id}/members/{memberId}","href":"/api-reference/sending-pools/remover-membro"},{"title":"Stats do pool","deprecated":null,"version":null,"openapi":"/es/whatsapp-api/api-reference/openapi-whatsapp.json get /v1/sending-pools/{id}/stats","href":"/api-reference/sending-pools/stats-do-pool"}]}]},{"tab":"SMS","groups":[{"group":"API SMS","pages":[{"title":"Introdução","icon":"comment-sms","href":"/sms-api/como-funciona/introducao"},{"title":"Quick Start","icon":"bolt","href":"/sms-api/como-funciona/quick-start"},{"title":"Escopos da API Key","icon":"key","href":"/sms-api/como-funciona/escopos-da-api-key"},{"title":"Eventos dos Webhooks","icon":"code-merge","href":"/sms-api/como-funciona/eventos-do-webhooks"}]},{"group":"SMS","pages":[{"title":"Listar SMS","deprecated":null,"version":null,"openapi":"/es/sms-api/api-reference/openapi-sms.json get /v1/sms/messages","href":"/api-reference/sms/listar-sms"},{"title":"Enviar SMS","deprecated":null,"version":null,"openapi":"/es/sms-api/api-reference/openapi-sms.json post /v1/sms/messages","href":"/api-reference/sms/enviar-sms"},{"title":"Consultar status de um SMS","deprecated":null,"version":null,"openapi":"/es/sms-api/api-reference/openapi-sms.json get /v1/sms/messages/{id}","href":"/api-reference/sms/consultar-status-de-um-sms"},{"title":"Cancelar SMS agendado","deprecated":null,"version":null,"openapi":"/es/sms-api/api-reference/openapi-sms.json post /v1/sms/messages/{id}/cancel","href":"/api-reference/sms/cancelar-sms-agendado"},{"title":"Listar SMS recebidos","deprecated":null,"version":null,"openapi":"/es/sms-api/api-reference/openapi-sms.json get /v1/sms/inbound","href":"/api-reference/sms/listar-sms-recebidos"},{"title":"Consultar SMS recebido","deprecated":null,"version":null,"openapi":"/es/sms-api/api-reference/openapi-sms.json get /v1/sms/inbound/{id}","href":"/api-reference/sms/consultar-sms-recebido"}]}]},{"tab":"Telegram","groups":[{"group":"API Telegram","pages":[{"title":"Introdução","icon":"paper-plane","href":"/telegram-api/como-funciona/introducao"},{"title":"Quick Start","icon":"bolt","href":"/telegram-api/como-funciona/quick-start"},{"title":"Modos de conexão","icon":"split","href":"/telegram-api/como-funciona/modos-de-conexao"},{"title":"Escopos da API Key","icon":"key","href":"/telegram-api/como-funciona/escopos-api-key"},{"title":"Eventos dos Webhooks","icon":"code-merge","href":"/telegram-api/como-funciona/eventos-do-webhooks"}]},{"group":"Mensagens","pages":[{"title":"Listar mensagens Telegram","deprecated":null,"version":null,"openapi":"/telegram-api/api-reference/openapi-telegram.json get /v1/telegram/messages","href":"/api-reference/mensagens/listar-mensagens-telegram"},{"title":"Enviar mensagem no Telegram","deprecated":null,"version":null,"openapi":"/telegram-api/api-reference/openapi-telegram.json post /v1/telegram/messages","href":"/api-reference/mensagens/enviar-mensagem-no-telegram"},{"title":"Listar chats Telegram","deprecated":null,"version":null,"openapi":"/es/telegram-api/api-reference/openapi-telegram.json get /v1/telegram/chats","href":"/api-reference/mensagens/listar-chats-telegram"},{"title":"Listar recebidos Telegram","deprecated":null,"version":null,"openapi":"/telegram-api/api-reference/openapi-telegram.json get /v1/telegram/messages/inbound","href":"/api-reference/mensagens/listar-recebidos-telegram"},{"title":"Consultar recebido Telegram","deprecated":null,"version":null,"openapi":"/telegram-api/api-reference/openapi-telegram.json get /v1/telegram/messages/inbound/{id}","href":"/api-reference/mensagens/consultar-recebido-telegram"},{"title":"Baixar mídia recebida (base64)","deprecated":null,"version":null,"openapi":"/es/whatsapp-api/api-reference/openapi-whatsapp.json post /v1/whatsapp/messages/inbound/{id}/media","href":"/api-reference/mensagens/baixar-mídia-recebida-base64"},{"title":"Baixar mídia recebida (arquivo)","deprecated":null,"version":null,"openapi":"/es/whatsapp-api/api-reference/openapi-whatsapp.json get /v1/whatsapp/messages/inbound/{id}/media/download","href":"/api-reference/mensagens/baixar-mídia-recebida-arquivo"},{"title":"Consultar envio Telegram","deprecated":null,"version":null,"openapi":"/telegram-api/api-reference/openapi-telegram.json get /v1/telegram/messages/{messageId}","href":"/api-reference/mensagens/consultar-envio-telegram"},{"title":"Apagar mensagem Telegram","deprecated":null,"version":null,"openapi":"/telegram-api/api-reference/openapi-telegram.json delete /v1/telegram/messages/{messageId}","href":"/api-reference/mensagens/apagar-mensagem-telegram"},{"title":"Cancelar Telegram agendado","deprecated":null,"version":null,"openapi":"/telegram-api/api-reference/openapi-telegram.json post /v1/telegram/messages/{messageId}/cancel","href":"/api-reference/mensagens/cancelar-telegram-agendado"},{"title":"Editar mensagem Telegram","deprecated":null,"version":null,"openapi":"/telegram-api/api-reference/openapi-telegram.json patch /v1/telegram/messages/{messageId}/edit","href":"/api-reference/mensagens/editar-mensagem-telegram"}]},{"group":"Instâncias","pages":[{"title":"Listar conexões Telegram","deprecated":null,"version":null,"openapi":"/telegram-api/api-reference/openapi-telegram.json get /v1/telegram/instances","href":"/api-reference/instâncias/listar-conexões-telegram"},{"title":"Criar instância Telegram","deprecated":null,"version":null,"openapi":"/telegram-api/api-reference/openapi-telegram.json post /v1/telegram/instances","href":"/api-reference/instâncias/criar-instância-telegram"},{"title":"Consultar conexão Telegram","deprecated":null,"version":null,"openapi":"/telegram-api/api-reference/openapi-telegram.json get /v1/telegram/instances/{instanceId}","href":"/api-reference/instâncias/consultar-conexão-telegram"},{"title":"Remover conexão Telegram","deprecated":null,"version":null,"openapi":"/telegram-api/api-reference/openapi-telegram.json delete /v1/telegram/instances/{instanceId}","href":"/api-reference/instâncias/remover-conexão-telegram"},{"title":"Status do link Telegram","deprecated":null,"version":null,"openapi":"/telegram-api/api-reference/openapi-telegram.json get /v1/telegram/instances/{instanceId}/connect-page","href":"/api-reference/instâncias/status-do-link-telegram"},{"title":"Ativar link Telegram","deprecated":null,"version":null,"openapi":"/telegram-api/api-reference/openapi-telegram.json post /v1/telegram/instances/{instanceId}/connect-page/enable","href":"/api-reference/instâncias/ativar-link-telegram"},{"title":"Renovar secret do link Telegram","deprecated":null,"version":null,"openapi":"/telegram-api/api-reference/openapi-telegram.json post /v1/telegram/instances/{instanceId}/connect-page/rotate-secret","href":"/api-reference/instâncias/renovar-secret-do-link-telegram"},{"title":"Desativar link Telegram","deprecated":null,"version":null,"openapi":"/telegram-api/api-reference/openapi-telegram.json post /v1/telegram/instances/{instanceId}/connect-page/disable","href":"/api-reference/instâncias/desativar-link-telegram"},{"title":"Obter QR Telegram","deprecated":null,"version":null,"openapi":"/telegram-api/api-reference/openapi-telegram.json get /v1/telegram/instances/{instanceId}/qr","href":"/api-reference/instâncias/obter-qr-telegram"},{"title":"Cancelar Telegram agendado","deprecated":null,"version":null,"openapi":"/telegram-api/api-reference/openapi-telegram.json post /v1/telegram/instances/{instanceId}/qr/cancel","href":"/api-reference/instâncias/cancelar-telegram-agendado"},{"title":"Salvar sessão Telegram","deprecated":null,"version":null,"openapi":"/telegram-api/api-reference/openapi-telegram.json post /v1/telegram/instances/{instanceId}/session","href":"/api-reference/instâncias/salvar-sessão-telegram"},{"title":"Ativar bot com token","deprecated":null,"version":null,"openapi":"/telegram-api/api-reference/openapi-telegram.json post /v1/telegram/instances/{instanceId}/bot-token","href":"/api-reference/instâncias/ativar-bot-com-token"}]}]},{"tab":"Instagram","groups":[{"group":"API Instagram","pages":[{"title":"Introdução","icon":"instagram","href":"/instagram-api/como-funciona/introducao"},{"title":"Quick Start","icon":"bolt","href":"/instagram-api/como-funciona/quick-start"},{"title":"Política anti-suspensão","icon":"shield-halved","href":"/instagram-api/como-funciona/politica-anti-banimento"},{"title":"Escopos da API Key","icon":"key","href":"/instagram-api/como-funciona/escopos-api-key"},{"title":"Eventos dos Webhooks","icon":"code-merge","href":"/instagram-api/como-funciona/eventos-do-webhooks"}]},{"group":"Instagram: instâncias","pages":[{"title":"Listar conexões Instagram","deprecated":null,"version":null,"openapi":"/instagram-api/api-reference/openapi-instagram.json get /v1/instagram/instances","href":"/api-reference/instagram:-instâncias/listar-conexões-instagram"},{"title":"Criar instância Instagram","deprecated":null,"version":null,"openapi":"/instagram-api/api-reference/openapi-instagram.json post /v1/instagram/instances","href":"/api-reference/instagram:-instâncias/criar-instância-instagram"},{"title":"Consultar conexão Instagram","deprecated":null,"version":null,"openapi":"/instagram-api/api-reference/openapi-instagram.json get /v1/instagram/instances/{instanceId}","href":"/api-reference/instagram:-instâncias/consultar-conexão-instagram"},{"title":"Remover conexão Instagram","deprecated":null,"version":null,"openapi":"/instagram-api/api-reference/openapi-instagram.json delete /v1/instagram/instances/{instanceId}","href":"/api-reference/instagram:-instâncias/remover-conexão-instagram"},{"title":"Status da conexão Instagram","deprecated":null,"version":null,"openapi":"/instagram-api/api-reference/openapi-instagram.json get /v1/instagram/instances/{instanceId}/connection","href":"/api-reference/instagram:-instâncias/status-da-conexão-instagram"},{"title":"Desconectar Instagram","deprecated":null,"version":null,"openapi":"/es/instagram-api/api-reference/openapi-instagram.json post /v1/instagram/instances/{instanceId}/disconnect","href":"/api-reference/instagram:-instâncias/desconectar-instagram"},{"title":"Status do link Instagram","deprecated":null,"version":null,"openapi":"/instagram-api/api-reference/openapi-instagram.json get /v1/instagram/instances/{instanceId}/connect-page","href":"/api-reference/instagram:-instâncias/status-do-link-instagram"},{"title":"Ativar link Instagram","deprecated":null,"version":null,"openapi":"/instagram-api/api-reference/openapi-instagram.json post /v1/instagram/instances/{instanceId}/connect-page/enable","href":"/api-reference/instagram:-instâncias/ativar-link-instagram"},{"title":"Renovar secret do link Instagram","deprecated":null,"version":null,"openapi":"/instagram-api/api-reference/openapi-instagram.json post /v1/instagram/instances/{instanceId}/connect-page/rotate-secret","href":"/api-reference/instagram:-instâncias/renovar-secret-do-link-instagram"},{"title":"Desativar link Instagram","deprecated":null,"version":null,"openapi":"/instagram-api/api-reference/openapi-instagram.json post /v1/instagram/instances/{instanceId}/connect-page/disable","href":"/api-reference/instagram:-instâncias/desativar-link-instagram"},{"title":"Resolver verificação Instagram","deprecated":null,"version":null,"openapi":"/instagram-api/api-reference/openapi-instagram.json post /v1/instagram/instances/{instanceId}/challenge/resolve","href":"/api-reference/instagram:-instâncias/resolver-verificação-instagram"}]},{"group":"Instagram: mensagens","pages":[{"title":"Listar mensagens Instagram","deprecated":null,"version":null,"openapi":"/instagram-api/api-reference/openapi-instagram.json get /v1/instagram/messages","href":"/api-reference/instagram:-mensagens/listar-mensagens-instagram"},{"title":"Enviar mensagem no Instagram","deprecated":null,"version":null,"openapi":"/instagram-api/api-reference/openapi-instagram.json post /v1/instagram/messages","href":"/api-reference/instagram:-mensagens/enviar-mensagem-no-instagram"},{"title":"Listar recebidos Instagram","deprecated":null,"version":null,"openapi":"/instagram-api/api-reference/openapi-instagram.json get /v1/instagram/messages/inbound","href":"/api-reference/instagram:-mensagens/listar-recebidos-instagram"},{"title":"Consultar recebido Instagram","deprecated":null,"version":null,"openapi":"/instagram-api/api-reference/openapi-instagram.json get /v1/instagram/messages/inbound/{id}","href":"/api-reference/instagram:-mensagens/consultar-recebido-instagram"},{"title":"Baixar mídia recebida (base64)","deprecated":null,"version":null,"openapi":"/instagram-api/api-reference/openapi-instagram.json post /v1/instagram/messages/inbound/{id}/media","href":"/api-reference/instagram:-mensagens/baixar-mídia-recebida-base64"},{"title":"Baixar mídia recebida (arquivo)","deprecated":null,"version":null,"openapi":"/instagram-api/api-reference/openapi-instagram.json get /v1/instagram/messages/inbound/{id}/media/download","href":"/api-reference/instagram:-mensagens/baixar-mídia-recebida-arquivo"},{"title":"Consultar envio Instagram","deprecated":null,"version":null,"openapi":"/instagram-api/api-reference/openapi-instagram.json get /v1/instagram/messages/{messageId}","href":"/api-reference/instagram:-mensagens/consultar-envio-instagram"},{"title":"Apagar mensagem Instagram","deprecated":null,"version":null,"openapi":"/instagram-api/api-reference/openapi-instagram.json delete /v1/instagram/messages/{messageId}","href":"/api-reference/instagram:-mensagens/apagar-mensagem-instagram"},{"title":"Editar mensagem Instagram","deprecated":null,"version":null,"openapi":"/instagram-api/api-reference/openapi-instagram.json patch /v1/instagram/messages/{messageId}/edit","href":"/api-reference/instagram:-mensagens/editar-mensagem-instagram"},{"title":"Cancelar Instagram agendado","deprecated":null,"version":null,"openapi":"/instagram-api/api-reference/openapi-instagram.json post /v1/instagram/messages/{messageId}/cancel","href":"/api-reference/instagram:-mensagens/cancelar-instagram-agendado"}]},{"group":"Instagram: comentários","pages":[{"title":"Listar comentários Instagram","deprecated":null,"version":null,"openapi":"/instagram-api/api-reference/openapi-instagram.json get /v1/instagram/comments","href":"/api-reference/instagram:-comentários/listar-comentários-instagram"},{"title":"Consultar comentário Instagram","deprecated":null,"version":null,"openapi":"/instagram-api/api-reference/openapi-instagram.json get /v1/instagram/comments/{commentId}","href":"/api-reference/instagram:-comentários/consultar-comentário-instagram"},{"title":"Apagar comentário Instagram","deprecated":null,"version":null,"openapi":"/instagram-api/api-reference/openapi-instagram.json delete /v1/instagram/comments/{commentId}","href":"/api-reference/instagram:-comentários/apagar-comentário-instagram"},{"title":"Ocultar comentário Instagram","deprecated":null,"version":null,"openapi":"/instagram-api/api-reference/openapi-instagram.json post /v1/instagram/comments/{commentId}/hide","href":"/api-reference/instagram:-comentários/ocultar-comentário-instagram"},{"title":"Responder comentário Instagram","deprecated":null,"version":null,"openapi":"/instagram-api/api-reference/openapi-instagram.json post /v1/instagram/comments/{commentId}/reply","href":"/api-reference/instagram:-comentários/responder-comentário-instagram"},{"title":"Responder comentário via DM (Private Reply)","deprecated":null,"version":null,"openapi":"/instagram-api/api-reference/openapi-instagram.json post /v1/instagram/comments/{commentId}/private-reply","href":"/api-reference/instagram:-comentários/responder-comentário-via-dm-private-reply"}]},{"group":"Instagram: mídia","pages":[{"title":"Listar mídia Instagram","deprecated":null,"version":null,"openapi":"/instagram-api/api-reference/openapi-instagram.json get /v1/instagram/media","href":"/api-reference/instagram:-mídia/listar-mídia-instagram"}]}]},{"tab":"Emails","groups":[{"group":"API E-mail","pages":[{"title":"Introdução","icon":"envelope","href":"/emails-api/como-funciona/introducao"},{"title":"Quick Start","icon":"bolt","href":"/emails-api/como-funciona/quick-start"},{"title":"Recebimento de e-mails","icon":"inbox","href":"/emails-api/como-funciona/recebimento-de-emails"},{"title":"Escopos da API Key","icon":"key","href":"/emails-api/como-funciona/escopos-da-api-key"},{"title":"Eventos dos Webhooks","icon":"code-merge","href":"/emails-api/como-funciona/eventos-do-webhooks"},{"title":"One-click unsubscribe (RFC 8058)","icon":"hand","href":"/emails-api/como-funciona/one-click-unsubscribe-rfc-8058"}]},{"group":"E-mail","pages":[{"title":"Listar mensagens e-mail","deprecated":null,"version":null,"openapi":"/es/emails-api/api-reference/openapi-email.json get /v1/email/messages","href":"/api-reference/e-mail/listar-mensagens-e-mail"},{"title":"Enviar e-mail","deprecated":null,"version":null,"openapi":"/es/emails-api/api-reference/openapi-email.json post /v1/email/messages","href":"/api-reference/e-mail/enviar-e-mail"},{"title":"Consultar envio e-mail","deprecated":null,"version":null,"openapi":"/es/emails-api/api-reference/openapi-email.json get /v1/email/messages/{id}","href":"/api-reference/e-mail/consultar-envio-e-mail"},{"title":"Cancelar e-mail agendado","deprecated":null,"version":null,"openapi":"/es/emails-api/api-reference/openapi-email.json post /v1/email/messages/{id}/cancel","href":"/api-reference/e-mail/cancelar-e-mail-agendado"}]},{"group":"Domínios","pages":[{"title":"Listar domínios de e-mail","deprecated":null,"version":null,"openapi":"/es/emails-api/api-reference/openapi-email.json get /v1/email/domains","href":"/api-reference/domínios/listar-domínios-de-e-mail"},{"title":"Cadastrar domínio de e-mail","deprecated":null,"version":null,"openapi":"/es/emails-api/api-reference/openapi-email.json post /v1/email/domains","href":"/api-reference/domínios/cadastrar-domínio-de-e-mail"},{"title":"Consultar domínio de e-mail","deprecated":null,"version":null,"openapi":"/es/emails-api/api-reference/openapi-email.json get /v1/email/domains/{id}","href":"/api-reference/domínios/consultar-domínio-de-e-mail"},{"title":"Verificar domínio de e-mail","deprecated":null,"version":null,"openapi":"/es/emails-api/api-reference/openapi-email.json post /v1/email/domains/{id}/verify","href":"/api-reference/domínios/verificar-domínio-de-e-mail"},{"title":"Expandir provedores do domínio","deprecated":null,"version":null,"openapi":"/es/emails-api/api-reference/openapi-email.json post /v1/email/domains/{id}/expand-providers","href":"/api-reference/domínios/expandir-provedores-do-domínio"},{"title":"Listar domínios (legado)","deprecated":null,"version":null,"openapi":"/emails-api/api-reference/openapi-email.json get /v1/email","href":"/api-reference/domínios/listar-domínios-legado"},{"title":"Registrar domínio (legado)","deprecated":null,"version":null,"openapi":"/emails-api/api-reference/openapi-email.json post /v1/email","href":"/api-reference/domínios/registrar-domínio-legado"},{"title":"Consultar domínio (legado)","deprecated":null,"version":null,"openapi":"/emails-api/api-reference/openapi-email.json get /v1/email/{id}","href":"/api-reference/domínios/consultar-domínio-legado"},{"title":"Verificar domínio (legado)","deprecated":null,"version":null,"openapi":"/emails-api/api-reference/openapi-email.json post /v1/email/{id}/verify","href":"/api-reference/domínios/verificar-domínio-legado"},{"title":"Expandir provedores (legado)","deprecated":null,"version":null,"openapi":"/emails-api/api-reference/openapi-email.json post /v1/email/{id}/expand-providers","href":"/api-reference/domínios/expandir-provedores-legado"}]},{"group":"E-mails recebidos","pages":[{"title":"Listar e-mails recebidos","deprecated":null,"version":null,"openapi":"/es/emails-api/api-reference/openapi-email.json get /v1/email/inbound","href":"/api-reference/e-mails-recebidos/listar-e-mails-recebidos"},{"title":"Detalhe do e-mail recebido","deprecated":null,"version":null,"openapi":"/es/emails-api/api-reference/openapi-email.json get /v1/email/inbound/{id}","href":"/api-reference/e-mails-recebidos/detalhe-do-e-mail-recebido"}]}]},{"tab":"Push","groups":[{"group":"API Push","pages":[{"title":"Introdução","icon":"bell","href":"/push-api/como-funciona/introducao"},{"title":"Quick Start","icon":"bolt","href":"/push-api/como-funciona/quick-start"},{"title":"Escopos da API Key","icon":"key","href":"/push-api/como-funciona/escopos-da-api-key"},{"title":"Eventos dos Webhooks","icon":"code-merge","href":"/push-api/como-funciona/eventos-do-webhooks"}]},{"group":"Push Apps","pages":[{"title":"Listar apps push","deprecated":null,"version":null,"openapi":"/es/push-api/api-reference/openapi-push.json get /v1/push/apps","href":"/api-reference/push-apps/listar-apps-push"},{"title":"Criar app push","deprecated":null,"version":null,"openapi":"/es/push-api/api-reference/openapi-push.json post /v1/push/apps","href":"/api-reference/push-apps/criar-app-push"},{"title":"Consultar app push","deprecated":null,"version":null,"openapi":"/es/push-api/api-reference/openapi-push.json get /v1/push/apps/{id}","href":"/api-reference/push-apps/consultar-app-push"},{"title":"Atualizar app push","deprecated":null,"version":null,"openapi":"/es/push-api/api-reference/openapi-push.json put /v1/push/apps/{id}","href":"/api-reference/push-apps/atualizar-app-push"},{"title":"Remover app push","deprecated":null,"version":null,"openapi":"/es/push-api/api-reference/openapi-push.json delete /v1/push/apps/{id}","href":"/api-reference/push-apps/remover-app-push"}]},{"group":"Push Devices","pages":[{"title":"Registrar dispositivo push","deprecated":null,"version":null,"openapi":"/es/push-api/api-reference/openapi-push.json post /v1/push/devices","href":"/api-reference/push-devices/registrar-dispositivo-push"},{"title":"Listar dispositivos push","deprecated":null,"version":null,"openapi":"/es/push-api/api-reference/openapi-push.json get /v1/push/devices","href":"/api-reference/push-devices/listar-dispositivos-push"},{"title":"Consultar dispositivo push","deprecated":null,"version":null,"openapi":"/es/push-api/api-reference/openapi-push.json get /v1/push/devices/{id}","href":"/api-reference/push-devices/consultar-dispositivo-push"},{"title":"Remover dispositivo push","deprecated":null,"version":null,"openapi":"/es/push-api/api-reference/openapi-push.json delete /v1/push/devices/{id}","href":"/api-reference/push-devices/remover-dispositivo-push"}]},{"group":"Push Messages","pages":[{"title":"Enviar push","deprecated":null,"version":null,"openapi":"/es/push-api/api-reference/openapi-push.json post /v1/push/messages","href":"/api-reference/push-messages/enviar-push"},{"title":"Listar mensagens push","deprecated":null,"version":null,"openapi":"/es/push-api/api-reference/openapi-push.json get /v1/push/messages","href":"/api-reference/push-messages/listar-mensagens-push"},{"title":"Consultar envio push","deprecated":null,"version":null,"openapi":"/es/push-api/api-reference/openapi-push.json get /v1/push/messages/{id}","href":"/api-reference/push-messages/consultar-envio-push"},{"title":"Cancelar push agendado","deprecated":null,"version":null,"openapi":"/es/push-api/api-reference/openapi-push.json post /v1/push/messages/{id}/cancel","href":"/api-reference/push-messages/cancelar-push-agendado"}]}]},{"tab":"Chat","groups":[{"group":"API Chat","pages":[{"title":"Introdução","icon":"message","href":"/chat-api/como-funciona/introducao"},{"title":"Quick Start","icon":"bolt","href":"/chat-api/como-funciona/quick-start"},{"title":"Usuário e agente","icon":"user-helmet-safety","href":"/chat-api/como-funciona/usuario-e-agente"},{"title":"Enviar mensagens","icon":"paper-plane","href":"/chat-api/como-funciona/enviar-mensagens"},{"title":"Capacidades e bloqueio","icon":"shield","href":"/chat-api/como-funciona/capacidades-e-bloqueio"},{"title":"Escopos da API Key","icon":"key","href":"/chat-api/como-funciona/escopos-da-api-key"},{"title":"Eventos dos Webhooks","icon":"code-merge","href":"/chat-api/como-funciona/eventos-do-webhooks"}]},{"group":"Chat Apps","pages":[{"title":"Listar Chat Apps","deprecated":null,"version":null,"openapi":"/es/chat-api/api-reference/openapi-chat.json get /v1/chat/apps","href":"/api-reference/chat-apps/listar-chat-apps"},{"title":"Criar Chat App","deprecated":null,"version":null,"openapi":"/es/chat-api/api-reference/openapi-chat.json post /v1/chat/apps","href":"/api-reference/chat-apps/criar-chat-app"},{"title":"Obter Chat App","deprecated":null,"version":null,"openapi":"/es/chat-api/api-reference/openapi-chat.json get /v1/chat/apps/{id}","href":"/api-reference/chat-apps/obter-chat-app"},{"title":"Atualizar Chat App","deprecated":null,"version":null,"openapi":"/es/chat-api/api-reference/openapi-chat.json patch /v1/chat/apps/{id}","href":"/api-reference/chat-apps/atualizar-chat-app"},{"title":"Rotacionar signing secret","deprecated":null,"version":null,"openapi":"/es/chat-api/api-reference/openapi-chat.json post /v1/chat/apps/{id}/rotate-secret","href":"/api-reference/chat-apps/rotacionar-signing-secret"},{"title":"Excluir Chat App","deprecated":null,"version":null,"openapi":"/es/chat-api/api-reference/openapi-chat.json delete /v1/chat/apps/{id}","href":"/api-reference/chat-apps/excluir-chat-app"}]},{"group":"Chat Users","pages":[{"title":"Criar ou atualizar usuário","deprecated":null,"version":null,"openapi":"/es/chat-api/api-reference/openapi-chat.json put /v1/chat/users","href":"/api-reference/chat-users/criar-ou-atualizar-usuário"},{"title":"Emitir JWT do usuário","deprecated":null,"version":null,"openapi":"/es/chat-api/api-reference/openapi-chat.json post /v1/chat/users/token","href":"/api-reference/chat-users/emitir-jwt-do-usuário"},{"title":"Vincular agente da equipe","deprecated":null,"version":null,"openapi":"/es/chat-api/api-reference/openapi-chat.json post /v1/chat/agents","href":"/api-reference/chat-users/vincular-agente-da-equipe"}]},{"group":"Conversas","pages":[{"title":"Listar conversas","deprecated":null,"version":null,"openapi":"/es/chat-api/api-reference/openapi-chat.json get /v1/chat/conversations","href":"/api-reference/chat-conversations/listar-conversas"},{"title":"Criar conversa","deprecated":null,"version":null,"openapi":"/es/chat-api/api-reference/openapi-chat.json post /v1/chat/conversations","href":"/api-reference/chat-conversations/criar-conversa"},{"title":"Obter conversa","deprecated":null,"version":null,"openapi":"/es/chat-api/api-reference/openapi-chat.json get /v1/chat/conversations/{id}","href":"/api-reference/chat-conversations/obter-conversa"},{"title":"Atualizar capacidades da conversa","deprecated":null,"version":null,"openapi":"/chat-api/api-reference/openapi-chat.json patch /v1/chat/conversations/{id}","href":"/api-reference/chat-conversations/atualizar-capacidades-da-conversa"},{"title":"Excluir conversa","deprecated":null,"version":null,"openapi":"/es/chat-api/api-reference/openapi-chat.json delete /v1/chat/conversations/{id}","href":"/api-reference/chat-conversations/excluir-conversa"},{"title":"Entrar na conversa","deprecated":null,"version":null,"openapi":"/es/chat-api/api-reference/openapi-chat.json post /v1/chat/conversations/{id}/join","href":"/api-reference/chat-conversations/entrar-na-conversa"},{"title":"Silenciar conversa","deprecated":null,"version":null,"openapi":"/chat-api/api-reference/openapi-chat.json post /v1/chat/conversations/{id}/mute","href":"/api-reference/chat-conversations/silenciar-conversa"},{"title":"Adicionar membros","deprecated":null,"version":null,"openapi":"/es/chat-api/api-reference/openapi-chat.json post /v1/chat/conversations/{id}/members","href":"/api-reference/chat-conversations/adicionar-membros"},{"title":"Remover membro","deprecated":null,"version":null,"openapi":"/es/chat-api/api-reference/openapi-chat.json delete /v1/chat/conversations/{id}/members/{userId}","href":"/api-reference/chat-conversations/remover-membro"},{"title":"Alterar papel do membro","deprecated":null,"version":null,"openapi":"/es/chat-api/api-reference/openapi-chat.json post /v1/chat/conversations/{id}/members/{userId}/role","href":"/api-reference/chat-conversations/alterar-papel-do-membro"}]},{"group":"Bloqueios","pages":[{"title":"Listar bloqueios","deprecated":null,"version":null,"openapi":"/chat-api/api-reference/openapi-chat.json get /v1/chat/blocks","href":"/api-reference/chat-blocks/listar-bloqueios"},{"title":"Bloquear usuário","deprecated":null,"version":null,"openapi":"/chat-api/api-reference/openapi-chat.json put /v1/chat/blocks/{externalUserId}","href":"/api-reference/chat-blocks/bloquear-usuário"},{"title":"Desbloquear usuário","deprecated":null,"version":null,"openapi":"/chat-api/api-reference/openapi-chat.json delete /v1/chat/blocks/{externalUserId}","href":"/api-reference/chat-blocks/desbloquear-usuário"}]},{"group":"Mensagens","pages":[{"title":"Enviar mensagem","deprecated":null,"version":null,"openapi":"/es/chat-api/api-reference/openapi-chat.json post /v1/chat/conversations/{id}/messages","href":"/api-reference/chat-messages/enviar-mensagem"},{"title":"Listar mensagens","deprecated":null,"version":null,"openapi":"/es/chat-api/api-reference/openapi-chat.json get /v1/chat/conversations/{id}/messages","href":"/api-reference/chat-messages/listar-mensagens"},{"title":"Enviar mensagem","deprecated":null,"version":null,"openapi":"/es/chat-api/api-reference/openapi-chat.json post /v1/chat/conversations/{id}/messages","href":"/api-reference/chat-messages/enviar-mensagem"},{"title":"Excluir mensagem","deprecated":null,"version":null,"openapi":"/es/chat-api/api-reference/openapi-chat.json delete /v1/chat/conversations/{id}/messages/{messageId}","href":"/api-reference/chat-messages/excluir-mensagem"},{"title":"Marcar conversa como lida","deprecated":null,"version":null,"openapi":"/es/chat-api/api-reference/openapi-chat.json post /v1/chat/conversations/{id}/read","href":"/api-reference/chat-messages/marcar-conversa-como-lida"}]}]},{"tab":"RCS","groups":[{"group":"API RCS","pages":[{"title":"Introdução","icon":"mobile-screen","href":"/rcs-api/como-funciona/introducao"},{"title":"Quick Start","icon":"bolt","href":"/rcs-api/como-funciona/quick-start"},{"title":"Escopos da API Key","icon":"key","href":"/rcs-api/como-funciona/escopos-da-api-key"},{"title":"Eventos dos Webhooks","icon":"code-merge","href":"/rcs-api/como-funciona/eventos-do-webhooks"}]},{"group":"Mensagens","pages":[{"title":"Enviar RCS","deprecated":null,"version":null,"openapi":"/es/rcs-api/api-reference/openapi-rcs.json post /v1/rcs/messages","href":"/api-reference/mensagens/enviar-rcs"},{"title":"Listar mensagens RCS","deprecated":null,"version":null,"openapi":"/es/rcs-api/api-reference/openapi-rcs.json get /v1/rcs/messages","href":"/api-reference/mensagens/listar-mensagens-rcs"},{"title":"Consultar envio RCS","deprecated":null,"version":null,"openapi":"/es/rcs-api/api-reference/openapi-rcs.json get /v1/rcs/messages/{id}","href":"/api-reference/mensagens/consultar-envio-rcs"},{"title":"Cancelar RCS agendado ou na fila","deprecated":null,"version":null,"openapi":"/es/rcs-api/api-reference/openapi-rcs.json post /v1/rcs/messages/{id}/cancel","href":"/api-reference/mensagens/cancelar-rcs-agendado-ou-na-fila"}]},{"group":"Instâncias","pages":[{"title":"Listar instâncias RCS","deprecated":null,"version":null,"openapi":"/es/rcs-api/api-reference/openapi-rcs.json get /v1/rcs/instances","href":"/api-reference/instâncias/listar-instâncias-rcs"},{"title":"Criar instância RCS","deprecated":null,"version":null,"openapi":"/es/rcs-api/api-reference/openapi-rcs.json post /v1/rcs/instances","href":"/api-reference/instâncias/criar-instância-rcs"},{"title":"Detalhe da instância RCS","deprecated":null,"version":null,"openapi":"/es/rcs-api/api-reference/openapi-rcs.json get /v1/rcs/instances/{instanceId}","href":"/api-reference/instâncias/detalhe-da-instância-rcs"},{"title":"Atualizar instância RCS","deprecated":null,"version":null,"openapi":"/es/rcs-api/api-reference/openapi-rcs.json patch /v1/rcs/instances/{instanceId}","href":"/api-reference/instâncias/atualizar-instância-rcs"},{"title":"Remover instância RCS","deprecated":null,"version":null,"openapi":"/es/rcs-api/api-reference/openapi-rcs.json delete /v1/rcs/instances/{instanceId}","href":"/api-reference/instâncias/remover-instância-rcs"},{"title":"Submeter instância para provisionamento","deprecated":null,"version":null,"openapi":"/es/rcs-api/api-reference/openapi-rcs.json post /v1/rcs/instances/{instanceId}/submit","href":"/api-reference/instâncias/submeter-instância-para-provisionamento"}]},{"group":"Inbound","pages":[{"title":"Listar RCS recebidos","deprecated":null,"version":null,"openapi":"/es/rcs-api/api-reference/openapi-rcs.json get /v1/rcs/inbound","href":"/api-reference/inbound/listar-rcs-recebidos"},{"title":"Detalhe de RCS recebido","deprecated":null,"version":null,"openapi":"/es/rcs-api/api-reference/openapi-rcs.json get /v1/rcs/inbound/{id}","href":"/api-reference/inbound/detalhe-de-rcs-recebido"}]}]},{"tab":"Voz","groups":[{"group":"Voz","pages":[{"title":"Introdução","icon":"phone","href":"/voice-api/como-funciona/introducao"},{"title":"Quick Start","icon":"bolt","href":"/voice-api/como-funciona/quick-start"},{"title":"Escopos da API Key","icon":"key","href":"/voice-api/como-funciona/escopos-da-api-key"},{"title":"Eventos de webhooks","icon":"code-merge","href":"/voice-api/como-funciona/eventos-do-webhooks"}]},{"group":"Voice: Chamadas","pages":[{"title":"Listar ligações","deprecated":null,"version":null,"openapi":"/es/voice-api/api-reference/openapi-voice.json get /v1/voice/calls","href":"/api-reference/voice:-chamadas/listar-ligações"},{"title":"Iniciar ligação","deprecated":null,"version":null,"openapi":"/es/voice-api/api-reference/openapi-voice.json post /v1/voice/calls","href":"/api-reference/voice:-chamadas/iniciar-ligação"},{"title":"Consultar ligação","deprecated":null,"version":null,"openapi":"/es/voice-api/api-reference/openapi-voice.json get /v1/voice/calls/{id}","href":"/api-reference/voice:-chamadas/consultar-ligação"},{"title":"Controlar ligação em andamento","deprecated":null,"version":null,"openapi":"/es/voice-api/api-reference/openapi-voice.json post /v1/voice/calls/{id}/actions/{action}","href":"/api-reference/voice:-chamadas/controlar-ligação-em-andamento"},{"title":"Baixar gravação","deprecated":null,"version":null,"openapi":"/es/voice-api/api-reference/openapi-voice.json get /v1/voice/calls/{id}/recordings/{recordingId}/download","href":"/api-reference/voice:-chamadas/baixar-gravação"}]},{"group":"Voice: Fluxos IVR","pages":[{"title":"Listar fluxos IVR","deprecated":null,"version":null,"openapi":"/es/voice-api/api-reference/openapi-voice.json get /v1/voice/flows","href":"/api-reference/voice:-fluxos-ivr/listar-fluxos-ivr"},{"title":"Criar fluxo IVR (rascunho)","deprecated":null,"version":null,"openapi":"/es/voice-api/api-reference/openapi-voice.json post /v1/voice/flows","href":"/api-reference/voice:-fluxos-ivr/criar-fluxo-ivr-rascunho"},{"title":"Consultar fluxo","deprecated":null,"version":null,"openapi":"/es/voice-api/api-reference/openapi-voice.json get /v1/voice/flows/{id}","href":"/api-reference/voice:-fluxos-ivr/consultar-fluxo"},{"title":"Atualizar rascunho","deprecated":null,"version":null,"openapi":"/es/voice-api/api-reference/openapi-voice.json patch /v1/voice/flows/{id}","href":"/api-reference/voice:-fluxos-ivr/atualizar-rascunho"},{"title":"Excluir fluxo","deprecated":null,"version":null,"openapi":"/es/voice-api/api-reference/openapi-voice.json delete /v1/voice/flows/{id}","href":"/api-reference/voice:-fluxos-ivr/excluir-fluxo"},{"title":"Publicar fluxo","deprecated":null,"version":null,"openapi":"/es/voice-api/api-reference/openapi-voice.json post /v1/voice/flows/{id}/publish","href":"/api-reference/voice:-fluxos-ivr/publicar-fluxo"}]},{"group":"Números de telefone","pages":[{"title":"Números de telefone","icon":"hashtag","href":"/phone-numbers-api/como-funciona/introducao"},{"title":"Quick Start","icon":"bolt","href":"/phone-numbers-api/como-funciona/quick-start"},{"title":"Escopos da API Key","icon":"key","href":"/phone-numbers-api/como-funciona/escopos-da-api-key"},{"title":"Eventos de webhooks","icon":"webhook","href":"/phone-numbers-api/como-funciona/eventos-do-webhooks"}]},{"group":"Números de Telefone","pages":[{"title":"Listar números","deprecated":null,"version":null,"openapi":"/es/phone-numbers-api/api-reference/openapi-phone-numbers.json get /v1/phone-numbers","href":"/api-reference/números-de-telefone/listar-números"},{"title":"Buscar números disponíveis","deprecated":null,"version":null,"openapi":"/phone-numbers-api/api-reference/openapi-phone-numbers.json get /v1/phone-numbers/available","href":"/api-reference/números-de-telefone/buscar-números-disponíveis"},{"title":"Consultar número","deprecated":null,"version":null,"openapi":"/es/phone-numbers-api/api-reference/openapi-phone-numbers.json get /v1/phone-numbers/{id}","href":"/api-reference/números-de-telefone/consultar-número"},{"title":"Atualizar número","deprecated":null,"version":null,"openapi":"/phone-numbers-api/api-reference/openapi-phone-numbers.json patch /v1/phone-numbers/{id}","href":"/api-reference/números-de-telefone/atualizar-número"},{"title":"Excluir número","deprecated":null,"version":null,"openapi":"/phone-numbers-api/api-reference/openapi-phone-numbers.json delete /v1/phone-numbers/{id}","href":"/api-reference/números-de-telefone/excluir-número"},{"title":"Configuração e preço","deprecated":null,"version":null,"openapi":"/es/phone-numbers-api/api-reference/openapi-phone-numbers.json get /v1/phone-numbers/config","href":"/api-reference/números-de-telefone/configuração-e-preço"},{"title":"Criar pedido de número","deprecated":null,"version":null,"openapi":"/es/phone-numbers-api/api-reference/openapi-phone-numbers.json post /v1/phone-numbers/orders","href":"/api-reference/números-de-telefone/criar-pedido-de-número"},{"title":"Detalhe do pedido","deprecated":null,"version":null,"openapi":"/es/phone-numbers-api/api-reference/openapi-phone-numbers.json get /v1/phone-numbers/orders/{orderId}","href":"/api-reference/números-de-telefone/detalhe-do-pedido"},{"title":"Requisitos regulatórios","deprecated":null,"version":null,"openapi":"/es/phone-numbers-api/api-reference/openapi-phone-numbers.json get /v1/phone-numbers/regulatory/requirements","href":"/api-reference/números-de-telefone/requisitos-regulatórios"},{"title":"Salvar perfil regulatório","deprecated":null,"version":null,"openapi":"/es/phone-numbers-api/api-reference/openapi-phone-numbers.json put /v1/phone-numbers/regulatory/profile","href":"/api-reference/números-de-telefone/salvar-perfil-regulatório"},{"title":"Upload documento regulatório","deprecated":null,"version":null,"openapi":"/es/phone-numbers-api/api-reference/openapi-phone-numbers.json post /v1/phone-numbers/orders/{orderId}/regulatory/documents","href":"/api-reference/números-de-telefone/upload-documento-regulatório"},{"title":"Submeter regulatório","deprecated":null,"version":null,"openapi":"/es/phone-numbers-api/api-reference/openapi-phone-numbers.json post /v1/phone-numbers/orders/{orderId}/regulatory/submit","href":"/api-reference/números-de-telefone/submeter-regulatório"},{"title":"Status regulatório do pedido","deprecated":null,"version":null,"openapi":"/es/phone-numbers-api/api-reference/openapi-phone-numbers.json get /v1/phone-numbers/orders/{orderId}/regulatory/status","href":"/api-reference/números-de-telefone/status-regulatório-do-pedido"},{"title":"Opções de número substituto","deprecated":null,"version":null,"openapi":"/es/phone-numbers-api/api-reference/openapi-phone-numbers.json get /v1/phone-numbers/orders/{orderId}/replacement-options","href":"/api-reference/números-de-telefone/opções-de-número-substituto"},{"title":"Selecionar número substituto","deprecated":null,"version":null,"openapi":"/es/phone-numbers-api/api-reference/openapi-phone-numbers.json post /v1/phone-numbers/orders/{orderId}/select-replacement-number","href":"/api-reference/números-de-telefone/selecionar-número-substituto"}]}]},{"tab":"Chat no site","groups":[{"group":"Chat no site","pages":[{"title":"Chat com IA no site","icon":"robot","href":"/ai-web-widget"},{"title":"Personalizando o visual","icon":"palette","href":"/ai-web-widget/configuracao"},{"title":"Segurança e verificação","icon":"shield-halved","href":"/ai-web-widget/seguranca"},{"title":"Para desenvolvedores","icon":"code","href":"/ai-web-widget/api"},{"title":"Dicas para usar melhor","icon":"lightbulb","href":"/ai-web-widget/boas-praticas"}]},{"group":"Widget público","pages":[{"title":"Configuração do widget","deprecated":null,"version":null,"openapi":"/ai-web-widget/api-reference/openapi-ai-web-widget.json get /public/ai-widget/{publicKey}/config","href":"/api-reference/widget-público/configuração-do-widget"},{"title":"Criar ou retomar sessão do visitante","deprecated":null,"version":null,"openapi":"/es/ai-web-widget/api-reference/openapi-ai-web-widget.json post /public/ai-widget/{publicKey}/session","href":"/api-reference/widget-público/criar-ou-retomar-sessão-do-visitante"},{"title":"Enviar mensagem no widget","deprecated":null,"version":null,"openapi":"/ai-web-widget/api-reference/openapi-ai-web-widget.json post /public/ai-widget/{publicKey}/message","href":"/api-reference/widget-público/enviar-mensagem-no-widget"},{"title":"Buscar mensagens novas","deprecated":null,"version":null,"openapi":"/ai-web-widget/api-reference/openapi-ai-web-widget.json get /public/ai-widget/{publicKey}/messages","href":"/api-reference/widget-público/buscar-mensagens-novas"},{"title":"Solicitar código OTP","deprecated":null,"version":null,"openapi":"/es/ai-web-widget/api-reference/openapi-ai-web-widget.json post /public/ai-widget/{publicKey}/session/otp/request","href":"/api-reference/widget-público/solicitar-código-otp"},{"title":"Verificar OTP de identidade","deprecated":null,"version":null,"openapi":"/en/ai-web-widget/api-reference/openapi-ai-web-widget.json post /public/ai-widget/{publicKey}/session/otp/verify","href":"/api-reference/widget-público/verificar-otp-de-identidade"}]},{"group":"Widget admin","pages":[{"title":"Listar widgets","deprecated":null,"version":null,"openapi":"/es/ai-web-widget/api-reference/openapi-ai-web-widget.json get /v1/ai-web-widget/widgets","href":"/api-reference/widget-admin/listar-widgets"},{"title":"Criar widget","deprecated":null,"version":null,"openapi":"/es/ai-web-widget/api-reference/openapi-ai-web-widget.json post /v1/ai-web-widget/widgets","href":"/api-reference/widget-admin/criar-widget"},{"title":"Obter widget","deprecated":null,"version":null,"openapi":"/es/ai-web-widget/api-reference/openapi-ai-web-widget.json get /v1/ai-web-widget/widgets/{id}","href":"/api-reference/widget-admin/obter-widget"},{"title":"Atualizar widget","deprecated":null,"version":null,"openapi":"/es/ai-web-widget/api-reference/openapi-ai-web-widget.json patch /v1/ai-web-widget/widgets/{id}","href":"/api-reference/widget-admin/atualizar-widget"},{"title":"Excluir widget","deprecated":null,"version":null,"openapi":"/es/ai-web-widget/api-reference/openapi-ai-web-widget.json delete /v1/ai-web-widget/widgets/{id}","href":"/api-reference/widget-admin/excluir-widget"},{"title":"Rotacionar public key","deprecated":null,"version":null,"openapi":"/es/ai-web-widget/api-reference/openapi-ai-web-widget.json post /v1/ai-web-widget/widgets/{id}/rotate-key","href":"/api-reference/widget-admin/rotacionar-public-key"},{"title":"Rotacionar HMAC secret","deprecated":null,"version":null,"openapi":"/es/ai-web-widget/api-reference/openapi-ai-web-widget.json post /v1/ai-web-widget/widgets/{id}/rotate-identity-signing-secret","href":"/api-reference/widget-admin/rotacionar-hmac-secret"},{"title":"Duplicar widget","deprecated":null,"version":null,"openapi":"/es/ai-web-widget/api-reference/openapi-ai-web-widget.json post /v1/ai-web-widget/widgets/{id}/duplicate","href":"/api-reference/widget-admin/duplicar-widget"},{"title":"Listar mensagens","deprecated":null,"version":null,"openapi":"/es/ai-web-widget/api-reference/openapi-ai-web-widget.json get /v1/ai-web-widget/messages","href":"/api-reference/widget-admin/listar-mensagens"}]}]},{"tab":"Templates","groups":[{"group":"Templates","pages":[{"title":"Introdução","icon":"layer-group","href":"/template-api/como-funciona/introducao"},{"title":"Quick Start","icon":"bolt","href":"/template-api/como-funciona/quick-start"},{"title":"Templates oficiais Meta","icon":"file-lines","href":"/template-api/como-funciona/templates-oficiais-meta"},{"title":"Escopos da API Key","icon":"key","href":"/template-api/como-funciona/escopos-da-api-key"},{"title":"Eventos dos Webhooks","icon":"code-merge","href":"/template-api/como-funciona/eventos-do-webhooks"},{"title":"Variáveis, campos personalizados e CRUD","icon":"brackets-curly","href":"/template-api/como-funciona/variaveis-disponiveis-e-crud"}]},{"group":"Templates","pages":[{"title":"Listar templates","deprecated":null,"version":null,"openapi":"/es/template-api/api-reference/openapi-templates.json get /v1/templates","href":"/api-reference/templates/listar-templates"},{"title":"Criar template","deprecated":null,"version":null,"openapi":"/es/template-api/api-reference/openapi-templates.json post /v1/templates","href":"/api-reference/templates/criar-template"},{"title":"Obter template","deprecated":null,"version":null,"openapi":"/es/template-api/api-reference/openapi-templates.json get /v1/templates/{id}","href":"/api-reference/templates/obter-template"},{"title":"Atualizar template","deprecated":null,"version":null,"openapi":"/es/template-api/api-reference/openapi-templates.json patch /v1/templates/{id}","href":"/api-reference/templates/atualizar-template"},{"title":"Excluir template","deprecated":null,"version":null,"openapi":"/es/template-api/api-reference/openapi-templates.json delete /v1/templates/{id}","href":"/api-reference/templates/excluir-template"},{"title":"Enviar template","deprecated":null,"version":null,"openapi":"/es/template-api/api-reference/openapi-templates.json post /v1/templates/send","href":"/api-reference/templates/enviar-template"}]}]},{"tab":"Contatos","groups":[{"group":"Contatos","pages":[{"title":"Introdução","icon":"address-book","href":"/contacts-api/como-funciona/introducao"},{"title":"Quick Start","icon":"bolt","href":"/contacts-api/como-funciona/quick-start"},{"title":"Escopos da API Key","icon":"key","href":"/contacts-api/como-funciona/escopos-da-api-key"},{"title":"Tags na audiência","icon":"tag","href":"/contacts-api/como-funciona/tags-na-audiencia"},{"title":"Tópicos de comunicação","icon":"tags","href":"/contacts-api/como-funciona/topicos-de-comunicacao"},{"title":"Segmentos na audiência","icon":"filter","href":"/contacts-api/como-funciona/segmentos-na-audiencia"},{"title":"Campanhas no painel","icon":"paper-plane","href":"/contacts-api/como-funciona/campanhas-no-painel"}]},{"group":"Contatos","pages":[{"title":"Listar idiomas de contato","deprecated":null,"version":null,"openapi":"/es/contacts-api/api-reference/openapi-contacts.json get /v1/meta/contact-locales","href":"/api-reference/contatos/listar-idiomas-de-contato"},{"title":"Listar contatos","deprecated":null,"version":null,"openapi":"/es/contacts-api/api-reference/openapi-contacts.json get /v1/contacts","href":"/api-reference/contatos/listar-contatos"},{"title":"Criar contato","deprecated":null,"version":null,"openapi":"/es/contacts-api/api-reference/openapi-contacts.json post /v1/contacts","href":"/api-reference/contatos/criar-contato"},{"title":"Consultar contato","deprecated":null,"version":null,"openapi":"/es/contacts-api/api-reference/openapi-contacts.json get /v1/contacts/{id}","href":"/api-reference/contatos/consultar-contato"},{"title":"Atualizar contato","deprecated":null,"version":null,"openapi":"/es/contacts-api/api-reference/openapi-contacts.json put /v1/contacts/{id}","href":"/api-reference/contatos/atualizar-contato"},{"title":"Excluir contato","deprecated":null,"version":null,"openapi":"/es/contacts-api/api-reference/openapi-contacts.json delete /v1/contacts/{id}","href":"/api-reference/contatos/excluir-contato"},{"title":"Listar definições de propriedades","deprecated":null,"version":null,"openapi":"/contacts-api/api-reference/openapi-contacts.json get /v1/contacts/property-definitions","href":"/api-reference/contatos/listar-definições-de-propriedades"},{"title":"Inteligência do contato","deprecated":null,"version":null,"openapi":"/contacts-api/api-reference/openapi-contacts.json get /v1/contacts/{id}/intelligence","href":"/api-reference/contatos/inteligência-do-contato"},{"title":"Timeline do contato","deprecated":null,"version":null,"openapi":"/contacts-api/api-reference/openapi-contacts.json get /v1/contacts/{id}/timeline","href":"/api-reference/contatos/timeline-do-contato"}]},{"group":"Tags","pages":[{"title":"Listar tags","deprecated":null,"version":null,"openapi":"/es/contacts-api/api-reference/openapi-contacts.json get /v1/tags","href":"/api-reference/tags/listar-tags"},{"title":"Criar tag","deprecated":null,"version":null,"openapi":"/es/contacts-api/api-reference/openapi-contacts.json post /v1/tags","href":"/api-reference/tags/criar-tag"},{"title":"Consultar tag","deprecated":null,"version":null,"openapi":"/es/contacts-api/api-reference/openapi-contacts.json get /v1/tags/{id}","href":"/api-reference/tags/consultar-tag"},{"title":"Atualizar tag","deprecated":null,"version":null,"openapi":"/es/contacts-api/api-reference/openapi-contacts.json put /v1/tags/{id}","href":"/api-reference/tags/atualizar-tag"},{"title":"Excluir tag","deprecated":null,"version":null,"openapi":"/es/contacts-api/api-reference/openapi-contacts.json delete /v1/tags/{id}","href":"/api-reference/tags/excluir-tag"}]},{"group":"Tópicos","pages":[{"title":"Listar tópicos","deprecated":null,"version":null,"openapi":"/es/contacts-api/api-reference/openapi-contacts.json get /v1/topics","href":"/api-reference/tópicos/listar-tópicos"},{"title":"Criar tópico","deprecated":null,"version":null,"openapi":"/es/contacts-api/api-reference/openapi-contacts.json post /v1/topics","href":"/api-reference/tópicos/criar-tópico"},{"title":"Consultar tópico","deprecated":null,"version":null,"openapi":"/es/contacts-api/api-reference/openapi-contacts.json get /v1/topics/{topicId}","href":"/api-reference/tópicos/consultar-tópico"},{"title":"Atualizar tópico","deprecated":null,"version":null,"openapi":"/es/contacts-api/api-reference/openapi-contacts.json patch /v1/topics/{topicId}","href":"/api-reference/tópicos/atualizar-tópico"},{"title":"Excluir tópico","deprecated":null,"version":null,"openapi":"/es/contacts-api/api-reference/openapi-contacts.json delete /v1/topics/{topicId}","href":"/api-reference/tópicos/excluir-tópico"}]},{"group":"Segmentos","pages":[{"title":"Listar segmentos","deprecated":null,"version":null,"openapi":"/es/contacts-api/api-reference/openapi-contacts.json get /v1/segments","href":"/api-reference/segmentos/listar-segmentos"},{"title":"Criar segmento","deprecated":null,"version":null,"openapi":"/es/contacts-api/api-reference/openapi-contacts.json post /v1/segments","href":"/api-reference/segmentos/criar-segmento"},{"title":"Pré-visualizar segmento","deprecated":null,"version":null,"openapi":"/es/contacts-api/api-reference/openapi-contacts.json get /v1/segments/{segmentId}/preview","href":"/api-reference/segmentos/pré-visualizar-segmento"},{"title":"Consultar segmento","deprecated":null,"version":null,"openapi":"/es/contacts-api/api-reference/openapi-contacts.json get /v1/segments/{segmentId}","href":"/api-reference/segmentos/consultar-segmento"},{"title":"Atualizar segmento","deprecated":null,"version":null,"openapi":"/es/contacts-api/api-reference/openapi-contacts.json patch /v1/segments/{segmentId}","href":"/api-reference/segmentos/atualizar-segmento"},{"title":"Excluir segmento","deprecated":null,"version":null,"openapi":"/es/contacts-api/api-reference/openapi-contacts.json delete /v1/segments/{segmentId}","href":"/api-reference/segmentos/excluir-segmento"},{"title":"Preview de segmento","deprecated":null,"version":null,"openapi":"/contacts-api/api-reference/openapi-contacts.json post /v1/segments/preview","href":"/api-reference/segmentos/preview-de-segmento"}]},{"group":"Campanhas","pages":[{"title":"Listar campanhas","deprecated":null,"version":null,"openapi":"/es/contacts-api/api-reference/openapi-contacts.json get /v1/campaigns","href":"/api-reference/campanhas/listar-campanhas"},{"title":"Criar campanha","deprecated":null,"version":null,"openapi":"/es/contacts-api/api-reference/openapi-contacts.json post /v1/campaigns","href":"/api-reference/campanhas/criar-campanha"},{"title":"Executar campanha","deprecated":null,"version":null,"openapi":"/es/contacts-api/api-reference/openapi-contacts.json post /v1/campaigns/{campaignId}/run","href":"/api-reference/campanhas/executar-campanha"},{"title":"Consultar campanha","deprecated":null,"version":null,"openapi":"/es/contacts-api/api-reference/openapi-contacts.json get /v1/campaigns/{campaignId}","href":"/api-reference/campanhas/consultar-campanha"},{"title":"Atualizar campanha","deprecated":null,"version":null,"openapi":"/es/contacts-api/api-reference/openapi-contacts.json patch /v1/campaigns/{campaignId}","href":"/api-reference/campanhas/atualizar-campanha"},{"title":"Excluir campanha","deprecated":null,"version":null,"openapi":"/es/contacts-api/api-reference/openapi-contacts.json delete /v1/campaigns/{campaignId}","href":"/api-reference/campanhas/excluir-campanha"},{"title":"Cancelar mensagem agendado","deprecated":null,"version":null,"openapi":"/es/contacts-api/api-reference/openapi-contacts.json post /v1/campaigns/{campaignId}/cancel","href":"/api-reference/campanhas/cancelar-mensagem-agendado"},{"title":"Estatísticas da campanha","deprecated":null,"version":null,"openapi":"/es/contacts-api/api-reference/openapi-contacts.json get /v1/campaigns/{campaignId}/stats","href":"/api-reference/campanhas/estatísticas-da-campanha"},{"title":"Destinatários da campanha","deprecated":null,"version":null,"openapi":"/es/contacts-api/api-reference/openapi-contacts.json get /v1/campaigns/{campaignId}/recipients","href":"/api-reference/campanhas/destinatários-da-campanha"},{"title":"Preview de execução da campanha","deprecated":null,"version":null,"openapi":"/es/contacts-api/api-reference/openapi-contacts.json get /v1/campaigns/{campaignId}/run-preview","href":"/api-reference/campanhas/preview-de-execução-da-campanha"}]},{"group":"Pipelines","pages":[{"title":"Listar boards","deprecated":null,"version":null,"openapi":"/es/contacts-api/api-reference/openapi-contacts.json get /v1/pipelines/boards","href":"/api-reference/pipelines/listar-boards"},{"title":"Criar board","deprecated":null,"version":null,"openapi":"/es/contacts-api/api-reference/openapi-contacts.json post /v1/pipelines/boards","href":"/api-reference/pipelines/criar-board"},{"title":"Board completo","deprecated":null,"version":null,"openapi":"/es/contacts-api/api-reference/openapi-contacts.json get /v1/pipelines/boards/{boardId}","href":"/api-reference/pipelines/board-completo"},{"title":"Atualizar board","deprecated":null,"version":null,"openapi":"/es/contacts-api/api-reference/openapi-contacts.json patch /v1/pipelines/boards/{boardId}","href":"/api-reference/pipelines/atualizar-board"},{"title":"Overview do board","deprecated":null,"version":null,"openapi":"/es/contacts-api/api-reference/openapi-contacts.json get /v1/pipelines/boards/{boardId}/overview","href":"/api-reference/pipelines/overview-do-board"},{"title":"Substituir colunas","deprecated":null,"version":null,"openapi":"/es/contacts-api/api-reference/openapi-contacts.json put /v1/pipelines/boards/{boardId}/columns","href":"/api-reference/pipelines/substituir-colunas"},{"title":"Criar card","deprecated":null,"version":null,"openapi":"/es/contacts-api/api-reference/openapi-contacts.json post /v1/pipelines/boards/{boardId}/cards","href":"/api-reference/pipelines/criar-card"},{"title":"Atualizar card","deprecated":null,"version":null,"openapi":"/es/contacts-api/api-reference/openapi-contacts.json patch /v1/pipelines/cards/{cardId}","href":"/api-reference/pipelines/atualizar-card"},{"title":"Mover card","deprecated":null,"version":null,"openapi":"/es/contacts-api/api-reference/openapi-contacts.json post /v1/pipelines/cards/{cardId}/move","href":"/api-reference/pipelines/mover-card"},{"title":"Cards do contato","deprecated":null,"version":null,"openapi":"/es/contacts-api/api-reference/openapi-contacts.json get /v1/pipelines/contacts/{contactId}/cards","href":"/api-reference/pipelines/cards-do-contato"}]},{"group":"Meta","pages":[{"title":"Listar canais disponíveis","deprecated":null,"version":null,"openapi":"/contacts-api/api-reference/openapi-contacts.json get /v1/meta/channels","href":"/api-reference/meta/listar-canais-disponíveis"},{"title":"Aliases legados por rota","deprecated":null,"version":null,"openapi":"/contacts-api/api-reference/openapi-contacts.json get /v1/meta/legacy-fields","href":"/api-reference/meta/aliases-legados-por-rota"},{"title":"Status de mensagem por canal","deprecated":null,"version":null,"openapi":"/contacts-api/api-reference/openapi-contacts.json get /v1/meta/message-statuses","href":"/api-reference/meta/status-de-mensagem-por-canal"},{"title":"Eventos de webhook","deprecated":null,"version":null,"openapi":"/es/contacts-api/api-reference/openapi-contacts.json get /v1/meta/webhook-events","href":"/api-reference/meta/eventos-de-webhook"}]},{"group":"Tarefas","pages":[{"title":"Tarefas do contato","deprecated":null,"version":null,"openapi":"/contacts-api/api-reference/openapi-contacts.json get /v1/contacts/{id}/tasks","href":"/api-reference/tarefas/tarefas-do-contato"},{"title":"Criar tarefa do contato","deprecated":null,"version":null,"openapi":"/contacts-api/api-reference/openapi-contacts.json post /v1/contacts/{id}/tasks","href":"/api-reference/tarefas/criar-tarefa-do-contato"},{"title":"Atualizar tarefa do contato","deprecated":null,"version":null,"openapi":"/contacts-api/api-reference/openapi-contacts.json patch /v1/contacts/{id}/tasks/{taskId}","href":"/api-reference/tarefas/atualizar-tarefa-do-contato"},{"title":"Listar tarefas do workspace","deprecated":null,"version":null,"openapi":"/contacts-api/api-reference/openapi-contacts.json get /v1/tasks","href":"/api-reference/tarefas/listar-tarefas-do-workspace"}]}]},{"tab":"Automações","groups":[{"group":"Automações","pages":[{"title":"Introdução","icon":"diagram-project","href":"/automations-api/como-funciona/introducao"},{"title":"Quick Start","icon":"bolt","href":"/automations-api/como-funciona/quick-start"},{"title":"Escopos da API Key","icon":"key","href":"/automations-api/como-funciona/escopos-da-api-key"},{"title":"Eventos","icon":"bolt","href":"/automations-api/como-funciona/eventos"},{"title":"Eventos dos Webhooks","icon":"code-merge","href":"/automations-api/como-funciona/eventos-do-webhooks"},{"title":"Assistentes","icon":"user-robot","href":"/automations-api/como-funciona/assistentes"},{"title":"Base de conhecimento","icon":"book-open","href":"/automations-api/como-funciona/base-de-conhecimento"},{"title":"Integrações MCP","icon":"plug","href":"/automations-api/como-funciona/integracoes-mcp"},{"title":"Casos de uso","icon":"lightbulb","href":"/automations-api/como-funciona/casos-de-uso"}]},{"group":"Eventos","pages":[{"title":"Listar eventos","deprecated":null,"version":null,"openapi":"/es/automations-api/api-reference/openapi-automations.json get /v1/events","href":"/api-reference/eventos/listar-eventos"},{"title":"Cadastrar evento","deprecated":null,"version":null,"openapi":"/automations-api/api-reference/openapi-automations.json post /v1/events","href":"/api-reference/eventos/cadastrar-evento"},{"title":"Disparar evento","deprecated":null,"version":null,"openapi":"/es/automations-api/api-reference/openapi-automations.json post /v1/events/send","href":"/api-reference/eventos/disparar-evento"},{"title":"Consultar evento","deprecated":null,"version":null,"openapi":"/es/automations-api/api-reference/openapi-automations.json get /v1/events/{eventId}","href":"/api-reference/eventos/consultar-evento"},{"title":"Atualizar evento","deprecated":null,"version":null,"openapi":"/automations-api/api-reference/openapi-automations.json patch /v1/events/{eventId}","href":"/api-reference/eventos/atualizar-evento"},{"title":"Excluir evento","deprecated":null,"version":null,"openapi":"/automations-api/api-reference/openapi-automations.json delete /v1/events/{eventId}","href":"/api-reference/eventos/excluir-evento"},{"title":"Excluir eventos em lote","deprecated":null,"version":null,"openapi":"/es/automations-api/api-reference/openapi-automations.json post /v1/events/batch/delete","href":"/api-reference/eventos/excluir-eventos-em-lote"}]},{"group":"Automações","pages":[{"title":"Listar automações","deprecated":null,"version":null,"openapi":"/automations-api/api-reference/openapi-automations.json get /v1/automations","href":"/api-reference/automações/listar-automações"},{"title":"Criar automação","deprecated":null,"version":null,"openapi":"/automations-api/api-reference/openapi-automations.json post /v1/automations","href":"/api-reference/automações/criar-automação"},{"title":"Consultar automação","deprecated":null,"version":null,"openapi":"/automations-api/api-reference/openapi-automations.json get /v1/automations/{automationId}","href":"/api-reference/automações/consultar-automação"},{"title":"Atualizar automação","deprecated":null,"version":null,"openapi":"/automations-api/api-reference/openapi-automations.json patch /v1/automations/{automationId}","href":"/api-reference/automações/atualizar-automação"},{"title":"Excluir automação","deprecated":null,"version":null,"openapi":"/automations-api/api-reference/openapi-automations.json delete /v1/automations/{automationId}","href":"/api-reference/automações/excluir-automação"},{"title":"Parar automação","deprecated":null,"version":null,"openapi":"/automations-api/api-reference/openapi-automations.json post /v1/automations/{automationId}/stop","href":"/api-reference/automações/parar-automação"},{"title":"Compor automação com IA","deprecated":null,"version":null,"openapi":"/es/automations-api/api-reference/openapi-automations.json post /v1/automations/ai-compose","href":"/api-reference/automações/compor-automação-com-ia"},{"title":"Criar chatbot rápido WhatsApp","deprecated":null,"version":null,"openapi":"/es/automations-api/api-reference/openapi-automations.json post /v1/automations/quick-chatbot","href":"/api-reference/automações/criar-chatbot-rápido-whatsapp"},{"title":"Criar agente pós-disparo","deprecated":null,"version":null,"openapi":"/es/automations-api/api-reference/openapi-automations.json post /v1/automations/post-campaign-agent","href":"/api-reference/automações/criar-agente-pós-disparo"},{"title":"Excluir automações em lote","deprecated":null,"version":null,"openapi":"/es/automations-api/api-reference/openapi-automations.json post /v1/automations/batch/delete","href":"/api-reference/automações/excluir-automações-em-lote"},{"title":"Duplicar automação","deprecated":null,"version":null,"openapi":"/es/automations-api/api-reference/openapi-automations.json post /v1/automations/{automationId}/duplicate","href":"/api-reference/automações/duplicar-automação"},{"title":"Gerar ou revogar secret de webhook","deprecated":null,"version":null,"openapi":"/es/automations-api/api-reference/openapi-automations.json post /v1/automations/{automationId}/webhook-secret","href":"/api-reference/automações/gerar-ou-revogar-secret-de-webhook"},{"title":"Disparar teste da automação","deprecated":null,"version":null,"openapi":"/es/automations-api/api-reference/openapi-automations.json post /v1/automations/{automationId}/test-trigger","href":"/api-reference/automações/disparar-teste-da-automação"}]},{"group":"Runs","pages":[{"title":"Listar execuções","deprecated":null,"version":null,"openapi":"/automations-api/api-reference/openapi-automations.json get /v1/automations/{automationId}/runs","href":"/api-reference/runs/listar-execuções"},{"title":"Detalhe da execução","deprecated":null,"version":null,"openapi":"/automations-api/api-reference/openapi-automations.json get /v1/automations/{automationId}/runs/{runId}","href":"/api-reference/runs/detalhe-da-execução"}]},{"group":"Assistentes","pages":[{"title":"Listar assistentes","deprecated":null,"version":null,"openapi":"/es/automations-api/api-reference/openapi-automations.json get /v1/assistants","href":"/api-reference/assistentes/listar-assistentes"},{"title":"Criar assistente","deprecated":null,"version":null,"openapi":"/es/automations-api/api-reference/openapi-automations.json post /v1/assistants","href":"/api-reference/assistentes/criar-assistente"},{"title":"Obter assistente","deprecated":null,"version":null,"openapi":"/es/automations-api/api-reference/openapi-automations.json get /v1/assistants/{id}","href":"/api-reference/assistentes/obter-assistente"},{"title":"Atualizar assistente","deprecated":null,"version":null,"openapi":"/es/automations-api/api-reference/openapi-automations.json patch /v1/assistants/{id}","href":"/api-reference/assistentes/atualizar-assistente"},{"title":"Excluir assistente","deprecated":null,"version":null,"openapi":"/es/automations-api/api-reference/openapi-automations.json delete /v1/assistants/{id}","href":"/api-reference/assistentes/excluir-assistente"},{"title":"Invocar assistente (teste)","deprecated":null,"version":null,"openapi":"/es/automations-api/api-reference/openapi-automations.json post /v1/assistants/{id}/invoke","href":"/api-reference/assistentes/invocar-assistente-teste"},{"title":"Histórico do thread de teste","deprecated":null,"version":null,"openapi":"/es/automations-api/api-reference/openapi-automations.json get /v1/assistants/{id}/invoke/messages","href":"/api-reference/assistentes/histórico-do-thread-de-teste"},{"title":"Listar bindings MCP","deprecated":null,"version":null,"openapi":"/es/automations-api/api-reference/openapi-automations.json get /v1/assistants/{id}/mcp-bindings","href":"/api-reference/assistentes/listar-bindings-mcp"},{"title":"Vincular conexão MCP","deprecated":null,"version":null,"openapi":"/es/automations-api/api-reference/openapi-automations.json post /v1/assistants/{id}/mcp-bindings","href":"/api-reference/assistentes/vincular-conexão-mcp"},{"title":"Atualizar binding MCP","deprecated":null,"version":null,"openapi":"/es/automations-api/api-reference/openapi-automations.json patch /v1/assistants/{id}/mcp-bindings/{bindingId}","href":"/api-reference/assistentes/atualizar-binding-mcp"},{"title":"Remover binding MCP","deprecated":null,"version":null,"openapi":"/es/automations-api/api-reference/openapi-automations.json delete /v1/assistants/{id}/mcp-bindings/{bindingId}","href":"/api-reference/assistentes/remover-binding-mcp"},{"title":"Listar bindings HTTP tool","deprecated":null,"version":null,"openapi":"/es/automations-api/api-reference/openapi-automations.json get /v1/assistants/{id}/http-tool-bindings","href":"/api-reference/assistentes/listar-bindings-http-tool"},{"title":"Vincular HTTP tool","deprecated":null,"version":null,"openapi":"/es/automations-api/api-reference/openapi-automations.json post /v1/assistants/{id}/http-tool-bindings","href":"/api-reference/assistentes/vincular-http-tool"},{"title":"Remover binding HTTP tool","deprecated":null,"version":null,"openapi":"/es/automations-api/api-reference/openapi-automations.json delete /v1/assistants/{id}/http-tool-bindings/{bindingId}","href":"/api-reference/assistentes/remover-binding-http-tool"}]},{"group":"Bases de conhecimento","pages":[{"title":"Listar bases","deprecated":null,"version":null,"openapi":"/es/automations-api/api-reference/openapi-automations.json get /v1/knowledge-bases","href":"/api-reference/bases-de-conhecimento/listar-bases"},{"title":"Criar base","deprecated":null,"version":null,"openapi":"/es/automations-api/api-reference/openapi-automations.json post /v1/knowledge-bases","href":"/api-reference/bases-de-conhecimento/criar-base"},{"title":"Obter base","deprecated":null,"version":null,"openapi":"/es/automations-api/api-reference/openapi-automations.json get /v1/knowledge-bases/{id}","href":"/api-reference/bases-de-conhecimento/obter-base"},{"title":"Atualizar base","deprecated":null,"version":null,"openapi":"/es/automations-api/api-reference/openapi-automations.json patch /v1/knowledge-bases/{id}","href":"/api-reference/bases-de-conhecimento/atualizar-base"},{"title":"Excluir base","deprecated":null,"version":null,"openapi":"/es/automations-api/api-reference/openapi-automations.json delete /v1/knowledge-bases/{id}","href":"/api-reference/bases-de-conhecimento/excluir-base"},{"title":"Listar documentos","deprecated":null,"version":null,"openapi":"/es/automations-api/api-reference/openapi-automations.json get /v1/knowledge-bases/{id}/documents","href":"/api-reference/bases-de-conhecimento/listar-documentos"},{"title":"Criar documento","deprecated":null,"version":null,"openapi":"/es/automations-api/api-reference/openapi-automations.json post /v1/knowledge-bases/{id}/documents","href":"/api-reference/bases-de-conhecimento/criar-documento"},{"title":"Obter documento","deprecated":null,"version":null,"openapi":"/es/automations-api/api-reference/openapi-automations.json get /v1/knowledge-bases/{id}/documents/{docId}","href":"/api-reference/bases-de-conhecimento/obter-documento"},{"title":"Atualizar documento","deprecated":null,"version":null,"openapi":"/es/automations-api/api-reference/openapi-automations.json patch /v1/knowledge-bases/{id}/documents/{docId}","href":"/api-reference/bases-de-conhecimento/atualizar-documento"},{"title":"Excluir documento","deprecated":null,"version":null,"openapi":"/es/automations-api/api-reference/openapi-automations.json delete /v1/knowledge-bases/{id}/documents/{docId}","href":"/api-reference/bases-de-conhecimento/excluir-documento"}]},{"group":"MCP","pages":[{"title":"Listar conexões MCP","deprecated":null,"version":null,"openapi":"/es/automations-api/api-reference/openapi-automations.json get /v1/mcp-connections","href":"/api-reference/mcp/listar-conexões-mcp"},{"title":"Criar conexão MCP","deprecated":null,"version":null,"openapi":"/es/automations-api/api-reference/openapi-automations.json post /v1/mcp-connections","href":"/api-reference/mcp/criar-conexão-mcp"},{"title":"Obter conexão","deprecated":null,"version":null,"openapi":"/es/automations-api/api-reference/openapi-automations.json get /v1/mcp-connections/{id}","href":"/api-reference/mcp/obter-conexão"},{"title":"Atualizar conexão","deprecated":null,"version":null,"openapi":"/es/automations-api/api-reference/openapi-automations.json patch /v1/mcp-connections/{id}","href":"/api-reference/mcp/atualizar-conexão"},{"title":"Excluir conexão","deprecated":null,"version":null,"openapi":"/es/automations-api/api-reference/openapi-automations.json delete /v1/mcp-connections/{id}","href":"/api-reference/mcp/excluir-conexão"},{"title":"Atualizar manifest de tools (CUSTOM_URL)","deprecated":null,"version":null,"openapi":"/es/automations-api/api-reference/openapi-automations.json post /v1/mcp-connections/{id}/refresh-manifest","href":"/api-reference/mcp/atualizar-manifest-de-tools-custom_url"}]},{"group":"HTTP tools","pages":[{"title":"Listar HTTP tools","deprecated":null,"version":null,"openapi":"/es/automations-api/api-reference/openapi-automations.json get /v1/http-tools","href":"/api-reference/http-tools/listar-http-tools"},{"title":"Criar HTTP tool","deprecated":null,"version":null,"openapi":"/es/automations-api/api-reference/openapi-automations.json post /v1/http-tools","href":"/api-reference/http-tools/criar-http-tool"},{"title":"Obter HTTP tool","deprecated":null,"version":null,"openapi":"/es/automations-api/api-reference/openapi-automations.json get /v1/http-tools/{id}","href":"/api-reference/http-tools/obter-http-tool"},{"title":"Atualizar HTTP tool","deprecated":null,"version":null,"openapi":"/es/automations-api/api-reference/openapi-automations.json patch /v1/http-tools/{id}","href":"/api-reference/http-tools/atualizar-http-tool"},{"title":"Excluir HTTP tool","deprecated":null,"version":null,"openapi":"/es/automations-api/api-reference/openapi-automations.json delete /v1/http-tools/{id}","href":"/api-reference/http-tools/excluir-http-tool"}]},{"group":"Inbox","pages":[{"title":"Listar conversas","deprecated":null,"version":null,"openapi":"/automations-api/api-reference/openapi-automations.json get /v1/inbox/conversations","href":"/api-reference/inbox/listar-conversas"},{"title":"Detalhe da conversa","deprecated":null,"version":null,"openapi":"/automations-api/api-reference/openapi-automations.json get /v1/inbox/conversations/{conversationKey}","href":"/api-reference/inbox/detalhe-da-conversa"},{"title":"Métricas do inbox","deprecated":null,"version":null,"openapi":"/automations-api/api-reference/openapi-automations.json get /v1/inbox/metrics","href":"/api-reference/inbox/métricas-do-inbox"}]}]},{"tab":"Add-ons","groups":[{"group":"Add-ons","pages":[{"title":"Add-ons","icon":"puzzle-piece","href":"/addons"}]},{"group":"Forms","pages":[{"title":"Introdução","icon":"clipboard-list","href":"/marketing-addons-api/como-funciona/introducao"},{"title":"Quick Start","icon":"bolt","href":"/marketing-addons-api/como-funciona/quick-start"},{"title":"Escopos da API Key","icon":"key","href":"/marketing-addons-api/como-funciona/escopos-da-api-key"},{"title":"Templates e casos de uso","icon":"layer-group","href":"/marketing-addons-api/como-funciona/templates-e-casos-de-uso"},{"title":"Eventos de webhooks","icon":"webhook","href":"/marketing-addons-api/como-funciona/eventos-do-webhooks"}]},{"group":"Forms","pages":[{"title":"Criar formulário","deprecated":null,"version":null,"openapi":"/marketing-addons-api/api-reference/openapi-marketing-addons.json post /v1/forms/lists","href":"/api-reference/forms/criar-formulário"},{"title":"Listar formulários","deprecated":null,"version":null,"openapi":"/marketing-addons-api/api-reference/openapi-marketing-addons.json get /v1/forms/lists","href":"/api-reference/forms/listar-formulários"},{"title":"Atualizar formulário","deprecated":null,"version":null,"openapi":"/marketing-addons-api/api-reference/openapi-marketing-addons.json patch /v1/forms/lists/{id}","href":"/api-reference/forms/atualizar-formulário"},{"title":"Excluir formulário","deprecated":null,"version":null,"openapi":"/marketing-addons-api/api-reference/openapi-marketing-addons.json delete /v1/forms/lists/{id}","href":"/api-reference/forms/excluir-formulário"},{"title":"Consultar formulário","deprecated":null,"version":null,"openapi":"/marketing-addons-api/api-reference/openapi-marketing-addons.json get /v1/forms/lists/{id}","href":"/api-reference/forms/consultar-formulário"},{"title":"Criar inscrição","deprecated":null,"version":null,"openapi":"/marketing-addons-api/api-reference/openapi-marketing-addons.json post /v1/forms/subscriptions","href":"/api-reference/forms/criar-inscrição"},{"title":"Listar inscrições (workspace)","deprecated":null,"version":null,"openapi":"/es/marketing-addons-api/api-reference/openapi-marketing-addons.json get /v1/forms/subscriptions","href":"/api-reference/forms/listar-inscrições-workspace"},{"title":"Confirmar inscrição","deprecated":null,"version":null,"openapi":"/marketing-addons-api/api-reference/openapi-marketing-addons.json post /v1/forms/subscriptions/confirm","href":"/api-reference/forms/confirmar-inscrição"},{"title":"Cancelar inscrição (unsubscribe)","deprecated":null,"version":null,"openapi":"/en/marketing-addons-api/api-reference/openapi-marketing-addons.json post /v1/forms/subscriptions/{id}/cancel","href":"/api-reference/forms/cancelar-inscrição-unsubscribe"},{"title":"Listar inscrições","deprecated":null,"version":null,"openapi":"/marketing-addons-api/api-reference/openapi-marketing-addons.json get /v1/forms/lists/{id}/subscriptions","href":"/api-reference/forms/listar-inscrições"},{"title":"Estatísticas de inscrições","deprecated":null,"version":null,"openapi":"/es/marketing-addons-api/api-reference/openapi-marketing-addons.json get /v1/forms/lists/{id}/subscriptions/stats","href":"/api-reference/forms/estatísticas-de-inscrições"},{"title":"Exportar inscrições (CSV)","deprecated":null,"version":null,"openapi":"/es/marketing-addons-api/api-reference/openapi-marketing-addons.json get /v1/forms/lists/{id}/subscriptions/export","href":"/api-reference/forms/exportar-inscrições-csv"},{"title":"Remover inscrição","deprecated":null,"version":null,"openapi":"/es/marketing-addons-api/api-reference/openapi-marketing-addons.json delete /v1/forms/lists/{id}/subscriptions/{subscriptionId}","href":"/api-reference/forms/remover-inscrição"}]},{"group":"Links curtos","pages":[{"title":"Introdução","icon":"link","href":"/short-links-api/como-funciona/introducao"},{"title":"Quick Start","icon":"bolt","href":"/short-links-api/como-funciona/quick-start"},{"title":"Escopos da API Key","icon":"key","href":"/short-links-api/como-funciona/escopos-da-api-key"},{"title":"Smart Links e conversões","icon":"chart-line","href":"/short-links-api/como-funciona/smart-links-e-conversoes"},{"title":"Eventos de webhooks","icon":"webhook","href":"/short-links-api/como-funciona/eventos-do-webhooks"}]},{"group":"Short links","pages":[{"title":"Listar links curtos","deprecated":null,"version":null,"openapi":"/short-links-api/api-reference/openapi-short-links.json get /v1/short-links","href":"/api-reference/short-links/listar-links-curtos"},{"title":"Criar link curto","deprecated":null,"version":null,"openapi":"/short-links-api/api-reference/openapi-short-links.json post /v1/short-links","href":"/api-reference/short-links/criar-link-curto"},{"title":"Consultar link curto","deprecated":null,"version":null,"openapi":"/short-links-api/api-reference/openapi-short-links.json get /v1/short-links/{id}","href":"/api-reference/short-links/consultar-link-curto"},{"title":"Atualizar link curto","deprecated":null,"version":null,"openapi":"/short-links-api/api-reference/openapi-short-links.json patch /v1/short-links/{id}","href":"/api-reference/short-links/atualizar-link-curto"},{"title":"Remover link curto","deprecated":null,"version":null,"openapi":"/short-links-api/api-reference/openapi-short-links.json delete /v1/short-links/{id}","href":"/api-reference/short-links/remover-link-curto"},{"title":"Ver estatísticas do link","deprecated":null,"version":null,"openapi":"/short-links-api/api-reference/openapi-short-links.json get /v1/short-links/{id}/analytics","href":"/api-reference/short-links/ver-estatísticas-do-link"},{"title":"Listar cliques do link","deprecated":null,"version":null,"openapi":"/short-links-api/api-reference/openapi-short-links.json get /v1/short-links/{id}/clicks","href":"/api-reference/short-links/listar-cliques-do-link"}]},{"group":"Validações","pages":[{"title":"Validação de e-mail","icon":"envelope","href":"/validations-api/como-funciona/introducao"},{"title":"Validação de telefone","icon":"phone","href":"/validations-api/como-funciona/introducao-telefone"},{"title":"Consulta de CPF","icon":"id-card","href":"/validations-api/como-funciona/introducao-cpf"},{"title":"Modos e cobrança","icon":"coins","href":"/validations-api/como-funciona/modos-e-cobranca"},{"title":"Quick Start","icon":"bolt","href":"/validations-api/como-funciona/quick-start"},{"title":"Escopos da API Key","icon":"key","href":"/validations-api/como-funciona/escopos-da-api-key"}]},{"group":"Validação (API)","pages":[{"title":"Verificar e-mails (síncrono)","deprecated":null,"version":null,"openapi":"/es/validations-api/api-reference/openapi-validations.json post /v1/validations/email","href":"/api-reference/validação-de-e-mail/verificar-e-mails-síncrono"},{"title":"Iniciar verificação de e-mails em lote","deprecated":null,"version":null,"openapi":"/es/validations-api/api-reference/openapi-validations.json post /v1/validations/email/batch","href":"/api-reference/validação-de-e-mail/iniciar-verificação-de-e-mails-em-lote"},{"title":"Status do lote de e-mails","deprecated":null,"version":null,"openapi":"/es/validations-api/api-reference/openapi-validations.json get /v1/validations/email/batch/{jobId}","href":"/api-reference/validação-de-e-mail/status-do-lote-de-e-mails"},{"title":"Verificar telefones (síncrono)","deprecated":null,"version":null,"openapi":"/es/validations-api/api-reference/openapi-validations.json post /v1/validations/phone","href":"/api-reference/validação-de-telefone/verificar-telefones-síncrono"},{"title":"Iniciar verificação de telefones em lote","deprecated":null,"version":null,"openapi":"/es/validations-api/api-reference/openapi-validations.json post /v1/validations/phone/batch","href":"/api-reference/validação-de-telefone/iniciar-verificação-de-telefones-em-lote"},{"title":"Status do lote de telefones","deprecated":null,"version":null,"openapi":"/es/validations-api/api-reference/openapi-validations.json get /v1/validations/phone/batch/{jobId}","href":"/api-reference/validação-de-telefone/status-do-lote-de-telefones"},{"title":"Consultar CPF (síncrono)","deprecated":null,"version":null,"openapi":"/es/validations-api/api-reference/openapi-validations.json post /v1/validations/cpf","href":"/api-reference/consulta-de-cpf/consultar-cpf-síncrono"},{"title":"Iniciar consulta de CPF em lote","deprecated":null,"version":null,"openapi":"/es/validations-api/api-reference/openapi-validations.json post /v1/validations/cpf/batch","href":"/api-reference/consulta-de-cpf/iniciar-consulta-de-cpf-em-lote"},{"title":"Status do lote de CPF","deprecated":null,"version":null,"openapi":"/es/validations-api/api-reference/openapi-validations.json get /v1/validations/cpf/batch/{jobId}","href":"/api-reference/consulta-de-cpf/status-do-lote-de-cpf"}]},{"group":"Conversões","pages":[{"title":"Registrar conversão","deprecated":null,"version":null,"openapi":"/short-links-api/api-reference/openapi-conversions.json post /v1/conversions","href":"/api-reference/conversões/registrar-conversão"}]}]}]},{"language":"en","pages":[{"title":"en","href":"/en/welcome/welcome"}]},{"language":"es","pages":[{"title":"es","href":"/es/welcome/welcome"}]}]},"basePath":"","title":"Scopes — Campaigns - Notifique","buildId":"dpl_36EDyZCDfRuoUD9af5CH4M1bqY2h","deploymentId":"dpl_36EDyZCDfRuoUD9af5CH4M1bqY2h","dynamics":[],"chunks":[]}