{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"SendyKit","colors":{"primary":"#D4A843","light":"#E8C564","dark":"#B8922E"},"logo":{"light":"https://mintcdn.com/sendykitdev/37Z-ieYr9dkovmgo/logo/sendykit-light.svg?fit=max\u0026auto=format\u0026n=37Z-ieYr9dkovmgo\u0026q=85\u0026s=1385a835f33b7916cdb589d2f21b51ea","dark":"https://mintcdn.com/sendykitdev/37Z-ieYr9dkovmgo/logo/sendykit-dark.svg?fit=max\u0026auto=format\u0026n=37Z-ieYr9dkovmgo\u0026q=85\u0026s=839c7ebcf68b317557731d948cf077f4"},"favicon":"https://mintcdn.com/sendykitdev/gZPTpWfX9KF2Yk-p/favicon.svg?fit=max\u0026auto=format\u0026n=gZPTpWfX9KF2Yk-p\u0026q=85\u0026s=4c85b79eb966dc4540b2ebc30845c468","navbar":{"links":[{"href":"https://sendykit.dev","label":"Site"},{"href":"https://github.com/Philoveracity/sendykit","label":"GitHub"}],"primary":{"type":"button","label":"Get SendyKit","href":"https://sendykit.dev/pricing"}},"footer":{"socials":{"github":"https://github.com/Philoveracity/sendykit","x":"https://x.com/sendykit"}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"API Reference","icon":"code","href":"/api-reference/introduction"},{"anchor":"Pricing","icon":"credit-card","href":"https://sendykit.dev/pricing"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"sendykitdev","hasAudioNarration":false,"actualSubdomain":"sendykitdev","customDomains":["docs.sendykit.dev"],"gitSource":{"type":"github","owner":"philoveracity","repo":"sendykit-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6aa8e1bc46b81e606e317b0f","collectionId":"dbbbe90c-d603-42eb-bfaa-b08633dd1d53","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6aa8e1bc46b81e606e317b0f"},"feedback":{"edits":false,"issues":false,"thumbs":true},"entitlements":{},"buildId":"6aa8e1bc46b81e606e317b0f","clientVersion":"0.0.3965","searchFilterCounts":[{"language":"default","tag":"Guides","count":16},{"language":"default","tag":"API Reference","count":5},{"language":"default","tag":"Getting Started","count":4},{"language":"default","tag":"Billing","count":3},{"language":"default","tag":"Self-Hosted","count":3},{"language":"default","tag":"CLI","count":2},{"language":"default","tag":"Features","count":2},{"language":"default","tag":"Concepts","count":1},{"language":"default","tag":"Readiness","count":1}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"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":"editor-v7-file-tree","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":"pause-universal-search-reconcile","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":"per-site-search-delta","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":"editor-private-page-search","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":"editor-nav-generations","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":"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":"editor-agent-model-picker","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":"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}],"isAtlas":false,"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/errors","slug":"/api-reference/errors","pageMetadata":{"title":"Errors","description":"SendyKit API error format and common error codes","href":"/api-reference/errors"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"SendyKit API error format and common error codes\"\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={code:`code`,li:`li`,p:`p`,pre:`pre`,span:`span`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,ul:`ul`,..._provideComponents(),...props.components},{CodeBlock,Heading,Table}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Table)_missingMdxReference(`Table`,true);return _jsxs(_Fragment,{children:[_jsx(Heading,{level:`2`,id:`error-envelope`,children:`Error envelope`}),`\n`,_jsx(_components.p,{children:`SendyKit error responses use this shape:`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`4`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`4`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"error\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"subscriber not found\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"code\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"not_found\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsx(Heading,{level:`2`,id:`common-error-codes`,children:`Common error codes`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Code`}),_jsx(_components.th,{children:`Meaning`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`unauthorized`})}),_jsx(_components.td,{children:`Missing or invalid auth`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`forbidden`})}),_jsx(_components.td,{children:`Authenticated, but not allowed`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`not_found`})}),_jsx(_components.td,{children:`Resource does not exist`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`invalid_request`})}),_jsx(_components.td,{children:`Missing or invalid input`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`internal_error`})}),_jsx(_components.td,{children:`Unexpected server-side failure`})]})]})]}),`\n`,_jsx(Heading,{level:`2`,id:`common-statuses`,children:`Common statuses`}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Status`}),_jsx(_components.th,{children:`Typical cause`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`400`})}),_jsx(_components.td,{children:`Invalid request body, query, or params`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`401`})}),_jsx(_components.td,{children:`Missing or invalid API key / token`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`402`})}),_jsx(_components.td,{children:`Machine payment required for premium action`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`403`})}),_jsx(_components.td,{children:`Auth ok, permission denied`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`404`})}),_jsx(_components.td,{children:`Resource not found`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`409`})}),_jsx(_components.td,{children:`Idempotency or state conflict`})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`500`})}),_jsx(_components.td,{children:`Internal server error`})]})]})]}),`\n`,_jsx(Heading,{level:`2`,id:`source-of-truth`,children:`Source of truth`}),`\n`,_jsx(_components.p,{children:`Defined in:`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`internal/respond/respond.go`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.code,{children:`docs/AUTH-BILLING-MATRIX.md`})}),`\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":"Errors","description":"SendyKit API error format and common error codes","href":"/api-reference/errors"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Error envelope","slug":"error-envelope","depth":2,"children":[]},{"title":"Common error codes","slug":"common-error-codes","depth":2,"children":[]},{"title":"Common statuses","slug":"common-statuses","depth":2,"children":[]},{"title":"Source of truth","slug":"source-of-truth","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"sendykitdev","siteName":"SendyKit","title":"Errors - SendyKit","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-03-15T02:02:40.979Z","originalFileLocation":"api-reference/errors.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"SendyKit API error format and common error codes\">\u003cmeta data-mint-head name=\"application-name\" content=\"SendyKit\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/sendykitdev/s2G0ySkNcn2FkVin/_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/sendykitdev/s2G0ySkNcn2FkVin/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/sendykitdev/s2G0ySkNcn2FkVin/_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/sendykitdev/s2G0ySkNcn2FkVin/_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/sendykitdev/s2G0ySkNcn2FkVin/_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/sendykitdev/s2G0ySkNcn2FkVin/_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/sendykitdev/s2G0ySkNcn2FkVin/_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/sendykitdev/s2G0ySkNcn2FkVin/_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/sendykitdev/s2G0ySkNcn2FkVin/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Errors - SendyKit\">\u003cmeta data-mint-head property=\"og:description\" content=\"SendyKit API error format and common error codes\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"SendyKit\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.sendykit.dev/api-reference/errors\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://sendykitdev.mintlify.app/_mintlify/api/og/v2?division=Documentation\u0026amp;title=Errors\u0026amp;description=SendyKit+API+error+format+and+common+error+codes\u0026amp;theme=8035b3e0dc87f85ed02b6f26\u0026amp;signature=89c9a8aa27e7c15b7c91687942402a82a2f8755d7a5a3e7a53e13c53a7ccd830\">\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=\"Errors - SendyKit\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"SendyKit API error format and common error codes\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://sendykitdev.mintlify.app/_mintlify/api/og/v2?division=Documentation\u0026amp;title=Errors\u0026amp;description=SendyKit+API+error+format+and+common+error+codes\u0026amp;theme=8035b3e0dc87f85ed02b6f26\u0026amp;signature=89c9a8aa27e7c15b7c91687942402a82a2f8755d7a5a3e7a53e13c53a7ccd830\">\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/sendykitdev/s2G0ySkNcn2FkVin/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"SendyKit\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#D4A843\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.sendykit.dev/api-reference/errors\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/errors.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.sendykit.dev/#organization\",\"name\":\"SendyKit\",\"url\":\"https://docs.sendykit.dev\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/sendykitdev/37Z-ieYr9dkovmgo/logo/sendykit-light.svg?fit=max\u0026auto=format\u0026n=37Z-ieYr9dkovmgo\u0026q=85\u0026s=1385a835f33b7916cdb589d2f21b51ea\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.sendykit.dev#website\",\"name\":\"SendyKit\",\"url\":\"https://docs.sendykit.dev\",\"publisher\":{\"@id\":\"https://docs.sendykit.dev/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.sendykit.dev/api-reference/errors#webpage\",\"url\":\"https://docs.sendykit.dev/api-reference/errors\",\"name\":\"Errors\",\"description\":\"SendyKit API error format and common error codes\",\"dateModified\":\"2026-03-15T02:02:40.979Z\",\"isPartOf\":{\"@id\":\"https://docs.sendykit.dev#website\"}},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.sendykit.dev/api-reference/errors#article\",\"headline\":\"Errors\",\"name\":\"Errors\",\"description\":\"SendyKit API error format and common error codes\",\"url\":\"https://docs.sendykit.dev/api-reference/errors\",\"mainEntityOfPage\":{\"@id\":\"https://docs.sendykit.dev/api-reference/errors#webpage\"},\"dateModified\":\"2026-03-15T02:02:40.979Z\",\"publisher\":{\"@id\":\"https://docs.sendykit.dev/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.sendykit.dev#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"SendyKit\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"SendyKit","nav":{"global":{"anchors":[{"anchor":"API Reference","icon":"code","href":"/api-reference/introduction"},{"anchor":"Pricing","icon":"credit-card","href":"https://sendykit.dev/pricing"}]},"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":""}]},{"tab":"API Reference","pages":[{"title":"API Introduction","href":"/api-reference/introduction"},{"title":"Authentication","description":"How SendyKit API authentication works","href":"/api-reference/authentication"},{"title":"Errors","href":"/api-reference/errors"},{"title":"Pagination","description":"How SendyKit paginates list-style API responses","href":"/api-reference/pagination"},{"title":"Rate Limiting","href":"/api-reference/rate-limiting"}],"groups":[{"group":"Skills","pages":[{"title":"List skill definitions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /agent/skills","href":"/api-reference/skills/list-skill-definitions"},{"title":"Get a skill definition","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /agent/skills/{id}","href":"/api-reference/skills/get-a-skill-definition"},{"title":"Attach a skill","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /agent/skills/attach","href":"/api-reference/skills/attach-a-skill"},{"title":"Detach a skill attachment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /agent/skills/detach","href":"/api-reference/skills/detach-a-skill-attachment"},{"title":"Validate a skill attachment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /agent/skills/validate","href":"/api-reference/skills/validate-a-skill-attachment"}]},{"group":"Agent Runtime","pages":[{"title":"List canonical agent runs","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /agent/runs","href":"/api-reference/agent-runtime/list-canonical-agent-runs"},{"title":"Get a canonical agent run","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /agent/runs/{id}","href":"/api-reference/agent-runtime/get-a-canonical-agent-run"},{"title":"List canonical actions for a run","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /agent/runs/{id}/actions","href":"/api-reference/agent-runtime/list-canonical-actions-for-a-run"},{"title":"List canonical approvals for a run","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /agent/runs/{id}/approvals","href":"/api-reference/agent-runtime/list-canonical-approvals-for-a-run"},{"title":"List artifacts for a run","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /agent/artifacts","href":"/api-reference/agent-runtime/list-artifacts-for-a-run"},{"title":"Get latest artifact by type for a run","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /agent/artifacts/latest","href":"/api-reference/agent-runtime/get-latest-artifact-by-type-for-a-run"},{"title":"Get latest checkpoint for a run","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /agent/checkpoints","href":"/api-reference/agent-runtime/get-latest-checkpoint-for-a-run"},{"title":"Resolve a resume token to a checkpoint","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /agent/checkpoints/resolve","href":"/api-reference/agent-runtime/resolve-a-resume-token-to-a-checkpoint"},{"title":"Resolve an approval request","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /agent/approvals/{id}/resolve","href":"/api-reference/agent-runtime/resolve-an-approval-request"},{"title":"Issue run-bound capability lease","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /internal/agent/leases/issue","href":"/api-reference/agent-runtime/issue-run-bound-capability-lease"},{"title":"Revoke capability lease","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /internal/agent/leases/revoke","href":"/api-reference/agent-runtime/revoke-capability-lease"},{"title":"Launch harness session for run","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /internal/agent/harness/launch","href":"/api-reference/agent-runtime/launch-harness-session-for-run"},{"title":"Resume harness session for run","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /internal/agent/harness/resume","href":"/api-reference/agent-runtime/resume-harness-session-for-run"},{"title":"Cancel harness session for run","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /internal/agent/harness/cancel","href":"/api-reference/agent-runtime/cancel-harness-session-for-run"},{"title":"Record harness heartbeat callback","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /internal/agent/harness/callbacks/heartbeat","href":"/api-reference/agent-runtime/record-harness-heartbeat-callback"},{"title":"Record harness checkpoint callback","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /internal/agent/harness/callbacks/checkpoint","href":"/api-reference/agent-runtime/record-harness-checkpoint-callback"},{"title":"Record harness artifact callback","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /internal/agent/harness/callbacks/artifact","href":"/api-reference/agent-runtime/record-harness-artifact-callback"},{"title":"Record harness completion callback","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /internal/agent/harness/callbacks/complete","href":"/api-reference/agent-runtime/record-harness-completion-callback"},{"title":"Record harness failure callback","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /internal/agent/harness/callbacks/failed","href":"/api-reference/agent-runtime/record-harness-failure-callback"},{"title":"List canonical tool definitions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /agent/tools","href":"/api-reference/agent-runtime/list-canonical-tool-definitions"},{"title":"Get a canonical tool definition","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /agent/tools/{id}","href":"/api-reference/agent-runtime/get-a-canonical-tool-definition"},{"title":"List grants for an agent subject","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /agent/grants","href":"/api-reference/agent-runtime/list-grants-for-an-agent-subject"},{"title":"List schedules for an agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /agent/schedules","href":"/api-reference/agent-runtime/list-schedules-for-an-agent"},{"title":"Create a schedule","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /agent/schedules","href":"/api-reference/agent-runtime/create-a-schedule"},{"title":"Get a schedule","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /agent/schedules/{id}","href":"/api-reference/agent-runtime/get-a-schedule"},{"title":"Patch a schedule","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /agent/schedules/{id}","href":"/api-reference/agent-runtime/patch-a-schedule"},{"title":"Pause a schedule","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /agent/schedules/{id}/pause","href":"/api-reference/agent-runtime/pause-a-schedule"},{"title":"Resume a schedule","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /agent/schedules/{id}/resume","href":"/api-reference/agent-runtime/resume-a-schedule"},{"title":"List trigger deliveries for a schedule","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /agent/triggers/deliveries","href":"/api-reference/agent-runtime/list-trigger-deliveries-for-a-schedule"},{"title":"Execute agent action","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /agent/actions/execute","href":"/api-reference/agent-runtime/execute-agent-action"},{"title":"Plan agent action","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /agent/actions/plan","href":"/api-reference/agent-runtime/plan-agent-action"},{"title":"Simulate agent action","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /agent/actions/simulate","href":"/api-reference/agent-runtime/simulate-agent-action"},{"title":"Get agent action","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /agent/actions/{id}","href":"/api-reference/agent-runtime/get-agent-action"},{"title":"Evaluate agent policy","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /agent/policies/evaluate","href":"/api-reference/agent-runtime/evaluate-agent-policy"},{"title":"MCP JSON-RPC endpoint","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /mcp","href":"/api-reference/agent-runtime/mcp-json-rpc-endpoint"},{"title":"MCP client config","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /mcp/config","href":"/api-reference/agent-runtime/mcp-client-config"},{"title":"MCP config snippet (text)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /mcp/config/snippet","href":"/api-reference/agent-runtime/mcp-config-snippet-text"},{"title":"MCP SSE stream","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /mcp/sse","href":"/api-reference/agent-runtime/mcp-sse-stream"},{"title":"MCP SSE message","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /mcp/sse","href":"/api-reference/agent-runtime/mcp-sse-message"}]},{"group":"Agent Send","pages":[{"title":"Create branded-send setup","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /agent-send/setups","href":"/api-reference/agent-send/create-branded-send-setup"},{"title":"Get branded-send setup","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /agent-send/setups/{id}","href":"/api-reference/agent-send/get-branded-send-setup"},{"title":"Suspend branded-send setup","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /agent-send/setups/{id}/pause","href":"/api-reference/agent-send/suspend-branded-send-setup"},{"title":"Resume branded-send setup","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /agent-send/setups/{id}/resume","href":"/api-reference/agent-send/resume-branded-send-setup"},{"title":"Revoke branded-send setup","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /agent-send/setups/{id}/revoke","href":"/api-reference/agent-send/revoke-branded-send-setup"},{"title":"Reserve branded-send slot inventory","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /internal/agent-send/setups/{id}/reserve-slot","href":"/api-reference/agent-send/reserve-branded-send-slot-inventory"},{"title":"Record branded-send brand provisioning","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /internal/agent-send/setups/{id}/provision-brand","href":"/api-reference/agent-send/record-branded-send-brand-provisioning"},{"title":"Attach branded-send DNS requirements","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /internal/agent-send/setups/{id}/apply-dns","href":"/api-reference/agent-send/attach-branded-send-dns-requirements"},{"title":"Record branded-send verification check","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /internal/agent-send/setups/{id}/verify","href":"/api-reference/agent-send/record-branded-send-verification-check"},{"title":"Record branded-send smoke result","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /internal/agent-send/setups/{id}/smoke","href":"/api-reference/agent-send/record-branded-send-smoke-result"}]},{"group":"Core","pages":[{"title":"List Cards","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /agent/cards","href":"/api-reference/core/list-cards"},{"title":"Create cardholder","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /agent/cards/cardholder","href":"/api-reference/core/create-cardholder"},{"title":"Close virtual card","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /agent/cards/close","href":"/api-reference/core/close-virtual-card"},{"title":"Create virtual card","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /agent/cards/create","href":"/api-reference/core/create-virtual-card"},{"title":"Get credit balance","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /agent/credits","href":"/api-reference/core/get-credit-balance"},{"title":"Estimate credit cost","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /agent/credits/estimate","href":"/api-reference/core/estimate-credit-cost"},{"title":"List credit packages","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /agent/credits/packages","href":"/api-reference/core/list-credit-packages"},{"title":"Purchase credits","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /agent/credits/purchase","href":"/api-reference/core/purchase-credits"},{"title":"List credit transactions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /agent/credits/transactions","href":"/api-reference/core/list-credit-transactions"},{"title":"Transfer credits","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /agent/credits/transfer","href":"/api-reference/core/transfer-credits"},{"title":"List agents","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /agents","href":"/api-reference/core/list-agents"},{"title":"Register agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /agents","href":"/api-reference/core/register-agent"},{"title":"Create Autoresponders","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /autoresponders","href":"/api-reference/core/create-autoresponders"},{"title":"List Growth","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /billing/growth","href":"/api-reference/core/list-growth"},{"title":"List connected sites","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /connected-sites","href":"/api-reference/core/list-connected-sites"},{"title":"Create Connected Sites","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /connected-sites","href":"/api-reference/core/create-connected-sites"},{"title":"Create Score","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /content/score","href":"/api-reference/core/create-score"},{"title":"Create Action","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /copilot/action","href":"/api-reference/core/create-action"},{"title":"List Insights","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /copilot/insights","href":"/api-reference/core/list-insights"},{"title":"Create Query","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /copilot/query","href":"/api-reference/core/create-query"},{"title":"List Status","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /copilot/status","href":"/api-reference/core/list-status"},{"title":"List Subscriptions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /copilot/subscriptions","href":"/api-reference/core/list-subscriptions"},{"title":"Create Subscriptions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /copilot/subscriptions","href":"/api-reference/core/create-subscriptions"},{"title":"List credentials","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /credentials","href":"/api-reference/core/list-credentials"},{"title":"Update Credentials","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /credentials","href":"/api-reference/core/update-credentials"},{"title":"Store credential","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /credentials","href":"/api-reference/core/store-credential"},{"title":"Delete Credentials","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /credentials","href":"/api-reference/core/delete-credentials"},{"title":"List Signals","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /inbox/signals","href":"/api-reference/core/list-signals"},{"title":"Create Signals","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /inbox/signals","href":"/api-reference/core/create-signals"},{"title":"Create Signup","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /onboarding/signup","href":"/api-reference/core/create-signup"},{"title":"Create Rules","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rules","href":"/api-reference/core/create-rules"},{"title":"Activate instance","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /setup/activate","href":"/api-reference/core/activate-instance"},{"title":"Check for updates","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /system/update-check","href":"/api-reference/core/check-for-updates"},{"title":"List workers","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /system/workers","href":"/api-reference/core/list-workers"},{"title":"Batch send","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /tx/batch-send","href":"/api-reference/core/batch-send"},{"title":"Send transactional","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /tx/send","href":"/api-reference/core/send-transactional"},{"title":"Create template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /tx/templates","href":"/api-reference/core/create-template"},{"title":"Apply workflow","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /workflows/apply","href":"/api-reference/core/apply-workflow"},{"title":"Plan workflow","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /workflows/plan","href":"/api-reference/core/plan-workflow"},{"title":"Rollback workflow","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /workflows/rollback","href":"/api-reference/core/rollback-workflow"},{"title":"Simulate workflow","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /workflows/simulate","href":"/api-reference/core/simulate-workflow"},{"title":"Validate workflow","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /workflows/validate","href":"/api-reference/core/validate-workflow"},{"title":"Create Heartbeat","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /wp/heartbeat","href":"/api-reference/core/create-heartbeat"},{"title":"Create Verify Sender","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /x402/verify-sender","href":"/api-reference/core/create-verify-sender"},{"title":"Create Confirm","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /x402/verify-sender/confirm","href":"/api-reference/core/create-confirm"}]},{"group":"Agents","pages":[{"title":"Get agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /agents/{id}","href":"/api-reference/agents/get-agent"},{"title":"Update agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /agents/{id}","href":"/api-reference/agents/update-agent"},{"title":"Delete agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /agents/{id}","href":"/api-reference/agents/delete-agent"}]},{"group":"AI","pages":[{"title":"Generate email alias","deprecated":true,"version":null,"openapi":"/api-reference/openapi.json post /ai/generate","href":"/api-reference/ai/generate-email-alias"},{"title":"Generate email content from brief","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /ai/generate-email","href":"/api-reference/ai/generate-email-content-from-brief"},{"title":"Generate campaign insights","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /ai/insights/campaign","href":"/api-reference/ai/generate-campaign-insights"},{"title":"List available AI models","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /ai/models","href":"/api-reference/ai/list-available-ai-models"},{"title":"Rewrite post/blog content for email","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /ai/rewrite-for-email","href":"/api-reference/ai/rewrite-postblog-content-for-email"},{"title":"Generate subject line variants","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /ai/subject-lines","href":"/api-reference/ai/generate-subject-line-variants"},{"title":"Score subject-line variants for A/B test","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /ai/subject-lines/ab-test","href":"/api-reference/ai/score-subject-line-variants-for-ab-test"},{"title":"Suggest subject lines alias","deprecated":true,"version":null,"openapi":"/api-reference/openapi.json post /ai/suggest-subjects","href":"/api-reference/ai/suggest-subject-lines-alias"},{"title":"Generate weekly AI summary","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /ai/summary/weekly","href":"/api-reference/ai/generate-weekly-ai-summary"},{"title":"AI usage and cost report","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /ai/usage","href":"/api-reference/ai/ai-usage-and-cost-report"}]},{"group":"Analytics","pages":[{"title":"Campaign analytics report","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /analytics/campaign","href":"/api-reference/analytics/campaign-analytics-report"},{"title":"List analytics campaigns rollup","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /analytics/campaigns","href":"/api-reference/analytics/list-analytics-campaigns-rollup"},{"title":"Get client/device analytics","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /analytics/clients","href":"/api-reference/analytics/get-clientdevice-analytics"},{"title":"Get analytics dashboard","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /analytics/dashboard","href":"/api-reference/analytics/get-analytics-dashboard"},{"title":"Get engagement analytics","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /analytics/engagement","href":"/api-reference/analytics/get-engagement-analytics"},{"title":"Export analytics data","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /analytics/export","href":"/api-reference/analytics/export-analytics-data"},{"title":"Get geography analytics","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /analytics/geography","href":"/api-reference/analytics/get-geography-analytics"},{"title":"Get subscriber growth analytics","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /analytics/growth","href":"/api-reference/analytics/get-subscriber-growth-analytics"},{"title":"List analytics report","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /analytics/list","href":"/api-reference/analytics/list-analytics-report"},{"title":"Get send-time recommendations","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /analytics/send-time","href":"/api-reference/analytics/get-send-time-recommendations"},{"title":"Aggregated baseline analytics","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /analytics/summary","href":"/api-reference/analytics/aggregated-baseline-analytics"},{"title":"Unified cold+warm analytics","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /analytics/unified","href":"/api-reference/analytics/unified-cold+warm-analytics"}]},{"group":"Assets","pages":[{"title":"List uploaded assets","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /assets","href":"/api-reference/assets/list-uploaded-assets"},{"title":"Upload asset","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /assets","href":"/api-reference/assets/upload-asset"}]},{"group":"Audit","pages":[{"title":"List audit entries","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /audit","href":"/api-reference/audit/list-audit-entries"},{"title":"Purge old audit entries","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /audit/purge","href":"/api-reference/audit/purge-old-audit-entries"},{"title":"List audit entries by resource and ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /audit/{resource}/{resourceId}","href":"/api-reference/audit/list-audit-entries-by-resource-and-id"}]},{"group":"Auth","pages":[{"title":"Issue JWT token from API key","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /auth/token","href":"/api-reference/auth/issue-jwt-token-from-api-key"}]},{"group":"Automations","pages":[{"title":"List automations","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /automations","href":"/api-reference/automations/list-automations"},{"title":"Create automation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /automations","href":"/api-reference/automations/create-automation"},{"title":"Approve automation run","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /automations/runs/approve","href":"/api-reference/automations/approve-automation-run"},{"title":"Edit automation run","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /automations/runs/edit","href":"/api-reference/automations/edit-automation-run"},{"title":"Reject automation run","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /automations/runs/reject","href":"/api-reference/automations/reject-automation-run"},{"title":"Get automation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /automations/{id}","href":"/api-reference/automations/get-automation"},{"title":"Update automation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /automations/{id}","href":"/api-reference/automations/update-automation"},{"title":"Delete automation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /automations/{id}","href":"/api-reference/automations/delete-automation"}]},{"group":"Autoresponders","pages":[{"title":"List autoresponders","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /autoresponders","href":"/api-reference/autoresponders/list-autoresponders"},{"title":"Get autoresponder","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /autoresponders/{id}","href":"/api-reference/autoresponders/get-autoresponder"},{"title":"Delete autoresponder","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /autoresponders/{id}","href":"/api-reference/autoresponders/delete-autoresponder"},{"title":"List autoresponder emails","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /autoresponders/{id}/emails","href":"/api-reference/autoresponders/list-autoresponder-emails"},{"title":"Disable autoresponder email","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /autoresponders/{id}/emails/{emailId}/disable","href":"/api-reference/autoresponders/disable-autoresponder-email"},{"title":"Enable autoresponder email","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /autoresponders/{id}/emails/{emailId}/enable","href":"/api-reference/autoresponders/enable-autoresponder-email"}]},{"group":"Billing","pages":[{"title":"Check tenant billing limits","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /billing/check-limits","href":"/api-reference/billing/check-tenant-billing-limits"},{"title":"Get billing customer context","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /billing/customer","href":"/api-reference/billing/get-billing-customer-context"},{"title":"List machine-payment receipts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /billing/machine-payment-receipts","href":"/api-reference/billing/list-machine-payment-receipts"},{"title":"List campaign payments","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /billing/payments","href":"/api-reference/billing/list-campaign-payments"},{"title":"List billing plans","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /billing/plans","href":"/api-reference/billing/list-billing-plans"},{"title":"Get billing status","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /billing/status","href":"/api-reference/billing/get-billing-status"},{"title":"Get tenant billing usage","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /billing/usage","href":"/api-reference/billing/get-tenant-billing-usage"},{"title":"Receive Stripe billing webhook","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /billing/webhook","href":"/api-reference/billing/receive-stripe-billing-webhook"},{"title":"Billing action","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /billing/{action}","href":"/api-reference/billing/billing-action"}]},{"group":"Brands","pages":[{"title":"List brands","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /brands","href":"/api-reference/brands/list-brands"},{"title":"Update brand","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /brands","href":"/api-reference/brands/update-brand"},{"title":"Create brand","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /brands","href":"/api-reference/brands/create-brand"},{"title":"Delete brand","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /brands","href":"/api-reference/brands/delete-brand"},{"title":"List brand reusable blocks","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /brands/blocks","href":"/api-reference/brands/list-brand-reusable-blocks"},{"title":"List reusable blocks for brand","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /brands/{id}/blocks","href":"/api-reference/brands/list-reusable-blocks-for-brand"}]},{"group":"Bridge","pages":[{"title":"Bridge apply tag to subscriber","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /bridge/apply-tag","href":"/api-reference/bridge/bridge-apply-tag-to-subscriber"},{"title":"Bridge enroll subscriber into sequence","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /bridge/enroll","href":"/api-reference/bridge/bridge-enroll-subscriber-into-sequence"},{"title":"Bridge remove tag from subscriber","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /bridge/remove-tag","href":"/api-reference/bridge/bridge-remove-tag-from-subscriber"},{"title":"Bridge track goal event","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /bridge/track-goal","href":"/api-reference/bridge/bridge-track-goal-event"},{"title":"Bridge track pageview event","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /bridge/track-pageview","href":"/api-reference/bridge/bridge-track-pageview-event"},{"title":"Bridge unenroll subscriber from sequence","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /bridge/unenroll","href":"/api-reference/bridge/bridge-unenroll-subscriber-from-sequence"},{"title":"Bridge update subscriber field","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /bridge/update-field","href":"/api-reference/bridge/bridge-update-subscriber-field"},{"title":"Bridge proxy","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /bridge/{path}","href":"/api-reference/bridge/bridge-proxy"}]},{"group":"Campaigns","pages":[{"title":"List campaigns","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /campaigns","href":"/api-reference/campaigns/list-campaigns"},{"title":"Create campaign","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /campaigns","href":"/api-reference/campaigns/create-campaign"},{"title":"Run bulk campaign action","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /campaigns/bulk","href":"/api-reference/campaigns/run-bulk-campaign-action"},{"title":"Update campaign draft","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /campaigns/draft","href":"/api-reference/campaigns/update-campaign-draft"},{"title":"Create campaign draft","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /campaigns/draft","href":"/api-reference/campaigns/create-campaign-draft"},{"title":"Get campaign by ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /campaigns/{id}","href":"/api-reference/campaigns/get-campaign-by-id"},{"title":"List campaign bounces","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /campaigns/{id}/bounces","href":"/api-reference/campaigns/list-campaign-bounces"},{"title":"Cancel campaign","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /campaigns/{id}/cancel","href":"/api-reference/campaigns/cancel-campaign"},{"title":"List campaign clicks","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /campaigns/{id}/clicks","href":"/api-reference/campaigns/list-campaign-clicks"},{"title":"List campaign opens","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /campaigns/{id}/opens","href":"/api-reference/campaigns/list-campaign-opens"},{"title":"Pause campaign","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /campaigns/{id}/pause","href":"/api-reference/campaigns/pause-campaign"},{"title":"Get campaign report","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /campaigns/{id}/report","href":"/api-reference/campaigns/get-campaign-report"},{"title":"Resume campaign","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /campaigns/{id}/resume","href":"/api-reference/campaigns/resume-campaign"},{"title":"Schedule campaign send","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /campaigns/{id}/schedule","href":"/api-reference/campaigns/schedule-campaign-send"},{"title":"Mark campaign for immediate send","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /campaigns/{id}/send","href":"/api-reference/campaigns/mark-campaign-for-immediate-send"},{"title":"Send test emails","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /campaigns/{id}/test","href":"/api-reference/campaigns/send-test-emails"},{"title":"List campaign unsubscribes","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /campaigns/{id}/unsubscribes","href":"/api-reference/campaigns/list-campaign-unsubscribes"}]},{"group":"Compliance","pages":[{"title":"List incidents","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /compliance/incidents","href":"/api-reference/compliance/list-incidents"},{"title":"Resolve incident","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /compliance/incidents/{id}/resolve","href":"/api-reference/compliance/resolve-incident"},{"title":"Verify lead","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /compliance/lead/verify","href":"/api-reference/compliance/verify-lead"},{"title":"Evaluate policy","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /compliance/policies/evaluate","href":"/api-reference/compliance/evaluate-policy"},{"title":"Preflight check","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /compliance/sends/preflight","href":"/api-reference/compliance/preflight-check"}]},{"group":"Connected Sites","pages":[{"title":"Get connected site","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /connected-sites/{id}","href":"/api-reference/connected-sites/get-connected-site"},{"title":"Update connected site","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /connected-sites/{id}","href":"/api-reference/connected-sites/update-connected-site"},{"title":"Delete connected site","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /connected-sites/{id}","href":"/api-reference/connected-sites/delete-connected-site"}]},{"group":"Credentials","pages":[{"title":"Complete provider OAuth callback","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /credentials/oauth/callback","href":"/api-reference/credentials/complete-provider-oauth-callback"},{"title":"List credential connection status by provider","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /credentials/status","href":"/api-reference/credentials/list-credential-connection-status-by-provider"},{"title":"Get credential","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /credentials/{id}","href":"/api-reference/credentials/get-credential"},{"title":"Delete credential","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /credentials/{id}","href":"/api-reference/credentials/delete-credential"},{"title":"List service providers","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /services/registry","href":"/api-reference/credentials/list-service-providers"},{"title":"Create service provider","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /services/registry","href":"/api-reference/credentials/create-service-provider"},{"title":"Re-enable an existing Cloudflare connection","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /credentials/cloudflare/connect","href":"/api-reference/credentials/re-enable-an-existing-cloudflare-connection"},{"title":"Connect Cloudflare (one-time key → scoped token mint)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /credentials/cloudflare/connect","href":"/api-reference/credentials/connect-cloudflare-one-time-key-→-scoped-token-mint"},{"title":"Disable the Cloudflare connection (credentials preserved)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /credentials/cloudflare/connect","href":"/api-reference/credentials/disable-the-cloudflare-connection-credentials-preserved"},{"title":"Deploy the sendykit-harness-loader worker to Cloudflare","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /credentials/cloudflare/deploy-worker","href":"/api-reference/credentials/deploy-the-sendykit-harness-loader-worker-to-cloudflare"}]},{"group":"Exa","pages":[{"title":"Exa answer proxy","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /exa/answer","href":"/api-reference/exa/exa-answer-proxy"},{"title":"Exa contents extraction proxy","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /exa/contents","href":"/api-reference/exa/exa-contents-extraction-proxy"},{"title":"Exa find similar proxy","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /exa/find-similar","href":"/api-reference/exa/exa-find-similar-proxy"},{"title":"Check Exa provider health","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /exa/health","href":"/api-reference/exa/check-exa-provider-health"},{"title":"Run Exa research workflow","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /exa/research","href":"/api-reference/exa/run-exa-research-workflow"},{"title":"Exa semantic search proxy","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /exa/search","href":"/api-reference/exa/exa-semantic-search-proxy"},{"title":"Get Exa integration settings","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /exa/settings","href":"/api-reference/exa/get-exa-integration-settings"},{"title":"Update Exa integration settings","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /exa/settings","href":"/api-reference/exa/update-exa-integration-settings"}]},{"group":"Funnels","pages":[{"title":"List funnels","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /funnels","href":"/api-reference/funnels/list-funnels"},{"title":"Create funnel","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /funnels","href":"/api-reference/funnels/create-funnel"},{"title":"Funnel analytics","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /funnels/{id}/analytics","href":"/api-reference/funnels/funnel-analytics"}]},{"group":"Goals","pages":[{"title":"Track goal event and resolve sequence goals","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /goals/track","href":"/api-reference/goals/track-goal-event-and-resolve-sequence-goals"}]},{"group":"Health","pages":[{"title":"Run health doctor scan","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /health/doctor","href":"/api-reference/health/run-health-doctor-scan"},{"title":"Run doctor auto-fixes","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /health/doctor/fix","href":"/api-reference/health/run-doctor-auto-fixes"},{"title":"List doctor run history","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /health/doctor/history","href":"/api-reference/health/list-doctor-run-history"},{"title":"Run specific doctor check","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /health/doctor/{check}","href":"/api-reference/health/run-specific-doctor-check"},{"title":"Share doctor report","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /system/doctor/share","href":"/api-reference/health/share-doctor-report"}]},{"group":"Inbox","pages":[{"title":"Get inbox signal","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /inbox/signals/{id}","href":"/api-reference/inbox/get-inbox-signal"}]},{"group":"Instantly","pages":[{"title":"List Instantly campaigns","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /instantly/campaigns","href":"/api-reference/instantly/list-instantly-campaigns"},{"title":"Get Instantly campaign analytics","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /instantly/campaigns/analytics","href":"/api-reference/instantly/get-instantly-campaign-analytics"},{"title":"Instantly compliance status","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /instantly/compliance","href":"/api-reference/instantly/instantly-compliance-status"},{"title":"Check Instantly provider health","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /instantly/health","href":"/api-reference/instantly/check-instantly-provider-health"},{"title":"Get Instantly integration settings","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /instantly/settings","href":"/api-reference/instantly/get-instantly-integration-settings"},{"title":"Update Instantly integration settings","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /instantly/settings","href":"/api-reference/instantly/update-instantly-integration-settings"},{"title":"Sync or enrich lead into SendyKit","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /instantly/sync-lead","href":"/api-reference/instantly/sync-or-enrich-lead-into-sendykit"},{"title":"Receive Instantly webhook events","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /instantly/webhook","href":"/api-reference/instantly/receive-instantly-webhook-events"}]},{"group":"Lists","pages":[{"title":"List lists","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /lists","href":"/api-reference/lists/list-lists"},{"title":"Create list","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /lists","href":"/api-reference/lists/create-list"},{"title":"List custom fields for brand lists","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /lists/fields","href":"/api-reference/lists/list-custom-fields-for-brand-lists"},{"title":"Get list by ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /lists/{id}","href":"/api-reference/lists/get-list-by-id"},{"title":"Delete list","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /lists/{id}","href":"/api-reference/lists/delete-list"},{"title":"List custom fields for one list","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /lists/{id}/fields","href":"/api-reference/lists/list-custom-fields-for-one-list"}]},{"group":"System","pages":[{"title":"Prometheus metrics","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /metrics","href":"/api-reference/system/prometheus-metrics"},{"title":"Cut over legacy flow to sequence","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /migration/cutover","href":"/api-reference/system/cut-over-legacy-flow-to-sequence"},{"title":"Run migration inventory report","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /migration/inventory","href":"/api-reference/system/run-migration-inventory-report"},{"title":"Mirror legacy data into new structures","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /migration/mirror","href":"/api-reference/system/mirror-legacy-data-into-new-structures"},{"title":"Rollback migration cutover","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /migration/rollback","href":"/api-reference/system/rollback-migration-cutover"},{"title":"Check database connectivity","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /system/db-check","href":"/api-reference/system/check-database-connectivity"},{"title":"List DLQ items","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /system/dlq","href":"/api-reference/system/list-dlq-items"},{"title":"Discard DLQ item","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /system/dlq/discard","href":"/api-reference/system/discard-dlq-item"},{"title":"Resolve DLQ item","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /system/dlq/resolve","href":"/api-reference/system/resolve-dlq-item"},{"title":"Export customer data","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /system/export","href":"/api-reference/system/export-customer-data"},{"title":"List feature flags","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /system/flags","href":"/api-reference/system/list-feature-flags"},{"title":"Set feature flag","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /system/flags","href":"/api-reference/system/set-feature-flag"},{"title":"Get system info","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /system/info","href":"/api-reference/system/get-system-info"},{"title":"Get runtime metrics snapshot","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /system/metrics","href":"/api-reference/system/get-runtime-metrics-snapshot"},{"title":"Get legacy migration inventory","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /system/migration/legacy-inventory","href":"/api-reference/system/get-legacy-migration-inventory"},{"title":"Run migration mirror now","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /system/migration/mirror-now","href":"/api-reference/system/run-migration-mirror-now"},{"title":"Get migration mirror stats","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /system/migration/mirror-stats","href":"/api-reference/system/get-migration-mirror-stats"},{"title":"Get migration mode flags","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /system/migration/mode","href":"/api-reference/system/get-migration-mode-flags"},{"title":"Update migration mode flags","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /system/migration/mode","href":"/api-reference/system/update-migration-mode-flags"},{"title":"Adopt outbound transport settings from brand","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /system/outbound-transport/adopt-from-brand/{id}","href":"/api-reference/system/adopt-outbound-transport-settings-from-brand"},{"title":"Apply outbound transport profile to brands","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /system/outbound-transport/apply","href":"/api-reference/system/apply-outbound-transport-profile-to-brands"},{"title":"Get outbound transport apply job status","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /system/outbound-transport/apply/{jobId}","href":"/api-reference/system/get-outbound-transport-apply-job-status"},{"title":"Resume failed outbound transport apply job","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /system/outbound-transport/apply/{jobId}/resume","href":"/api-reference/system/resume-failed-outbound-transport-apply-job"},{"title":"Rollback outbound transport apply job","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /system/outbound-transport/apply/{jobId}/rollback","href":"/api-reference/system/rollback-outbound-transport-apply-job"},{"title":"Get brand inbound bounce settings","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /system/outbound-transport/bounce/brands/{id}/settings","href":"/api-reference/system/get-brand-inbound-bounce-settings"},{"title":"Update brand inbound bounce settings","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /system/outbound-transport/bounce/brands/{id}/settings","href":"/api-reference/system/update-brand-inbound-bounce-settings"},{"title":"List SMTP bounce DLQ items","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /system/outbound-transport/bounce/dlq","href":"/api-reference/system/list-smtp-bounce-dlq-items"},{"title":"Retry SMTP bounce DLQ item","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /system/outbound-transport/bounce/dlq/{id}/retry","href":"/api-reference/system/retry-smtp-bounce-dlq-item"},{"title":"List SMTP bounce events","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /system/outbound-transport/bounce/events","href":"/api-reference/system/list-smtp-bounce-events"},{"title":"Poll IMAP mailbox for bounce events","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /system/outbound-transport/bounce/events/imap/poll/{id}","href":"/api-reference/system/poll-imap-mailbox-for-bounce-events"},{"title":"Get SMTP bounce event","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /system/outbound-transport/bounce/events/{id}","href":"/api-reference/system/get-smtp-bounce-event"},{"title":"Replay SMTP bounce event","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /system/outbound-transport/bounce/events/{id}/replay","href":"/api-reference/system/replay-smtp-bounce-event"},{"title":"Get global bounce settings","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /system/outbound-transport/bounce/settings","href":"/api-reference/system/get-global-bounce-settings"},{"title":"Update global bounce settings","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /system/outbound-transport/bounce/settings","href":"/api-reference/system/update-global-bounce-settings"},{"title":"List brand outbound transport settings","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /system/outbound-transport/brands","href":"/api-reference/system/list-brand-outbound-transport-settings"},{"title":"Set brand outbound transport mode","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /system/outbound-transport/brands/{id}/mode","href":"/api-reference/system/set-brand-outbound-transport-mode"},{"title":"Get global outbound transport profile","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /system/outbound-transport/global","href":"/api-reference/system/get-global-outbound-transport-profile"},{"title":"Update global outbound transport profile","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /system/outbound-transport/global","href":"/api-reference/system/update-global-outbound-transport-profile"},{"title":"List global outbound transport presets","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /system/outbound-transport/global/presets","href":"/api-reference/system/list-global-outbound-transport-presets"},{"title":"Test outbound SMTP connection","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /system/outbound-transport/global/test-connection","href":"/api-reference/system/test-outbound-smtp-connection"},{"title":"Send outbound SMTP test message","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /system/outbound-transport/global/test-send","href":"/api-reference/system/send-outbound-smtp-test-message"},{"title":"Get API key RBAC capabilities","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /system/rbac/capabilities","href":"/api-reference/system/get-api-key-rbac-capabilities"},{"title":"Grant API key capability","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /system/rbac/capabilities","href":"/api-reference/system/grant-api-key-capability"},{"title":"Revoke API key capability","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /system/rbac/capabilities","href":"/api-reference/system/revoke-api-key-capability"},{"title":"Evaluate rollout and auto-rollback decision","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /system/rollout/evaluate","href":"/api-reference/system/evaluate-rollout-and-auto-rollback-decision"},{"title":"Get SES quota status","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /system/ses-quota","href":"/api-reference/system/get-ses-quota-status"},{"title":"Get setting","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /system/settings/{key}","href":"/api-reference/system/get-setting"},{"title":"Update setting","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /system/settings/{key}","href":"/api-reference/system/update-setting"},{"title":"Get SLO evaluation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /system/slo","href":"/api-reference/system/get-slo-evaluation"},{"title":"SMTP pool status","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /system/smtp-pool","href":"/api-reference/system/smtp-pool-status"},{"title":"Apply pool SMTP to brand","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /system/smtp-pool","href":"/api-reference/system/apply-pool-smtp-to-brand"}]},{"group":"Migration","pages":[{"title":"Migration action","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /migration/{action}","href":"/api-reference/migration/migration-action"}]},{"group":"Migrations","pages":[{"title":"Analyze import data","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /migrations/importers/{provider}/analyze","href":"/api-reference/migrations/analyze-import-data"},{"title":"Execute import","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /migrations/importers/{provider}/run","href":"/api-reference/migrations/execute-import"},{"title":"Get migration job","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /migrations/jobs/{id}","href":"/api-reference/migrations/get-migration-job"},{"title":"Get migration report","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /migrations/jobs/{id}/report","href":"/api-reference/migrations/get-migration-report"}]},{"group":"Queue","pages":[{"title":"Process queue now","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /queue/process","href":"/api-reference/queue/process-queue-now"},{"title":"Get queue status","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /queue/status","href":"/api-reference/queue/get-queue-status"}]},{"group":"Reputation","pages":[{"title":"Lookup sender reputation by domain","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /reputation/lookup","href":"/api-reference/reputation/lookup-sender-reputation-by-domain"},{"title":"List sender reputation scores","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /reputation/senders","href":"/api-reference/reputation/list-sender-reputation-scores"},{"title":"Register sender reputation record","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /reputation/senders","href":"/api-reference/reputation/register-sender-reputation-record"},{"title":"Get sender reputation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /reputation/senders/{id}","href":"/api-reference/reputation/get-sender-reputation"}]},{"group":"Routing","pages":[{"title":"Get routing decision","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /routing/decisions/{id}","href":"/api-reference/routing/get-routing-decision"},{"title":"Routing forecast","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /routing/forecast","href":"/api-reference/routing/routing-forecast"},{"title":"List routing policies","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /routing/policies","href":"/api-reference/routing/list-routing-policies"},{"title":"Create routing policy","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /routing/policies","href":"/api-reference/routing/create-routing-policy"},{"title":"Get routing policy","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /routing/policies/{id}","href":"/api-reference/routing/get-routing-policy"},{"title":"Simulate routing","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /routing/simulate","href":"/api-reference/routing/simulate-routing"}]},{"group":"Rules","pages":[{"title":"List automation rules","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /rules","href":"/api-reference/rules/list-automation-rules"},{"title":"Get automation rule","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /rules/{id}","href":"/api-reference/rules/get-automation-rule"},{"title":"Delete automation rule","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /rules/{id}","href":"/api-reference/rules/delete-automation-rule"},{"title":"Disable automation rule","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rules/{id}/disable","href":"/api-reference/rules/disable-automation-rule"},{"title":"Enable automation rule","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rules/{id}/enable","href":"/api-reference/rules/enable-automation-rule"},{"title":"Get automation rule logs","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /rules/{id}/logs","href":"/api-reference/rules/get-automation-rule-logs"}]},{"group":"Segments","pages":[{"title":"List segments","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /segments","href":"/api-reference/segments/list-segments"},{"title":"Create segment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /segments","href":"/api-reference/segments/create-segment"},{"title":"Get segment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /segments/{id}","href":"/api-reference/segments/get-segment"},{"title":"Update segment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /segments/{id}","href":"/api-reference/segments/update-segment"},{"title":"Delete segment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /segments/{id}","href":"/api-reference/segments/delete-segment"},{"title":"Patch segment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /segments/{id}","href":"/api-reference/segments/patch-segment"},{"title":"Get segment conditions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /segments/{id}/conditions","href":"/api-reference/segments/get-segment-conditions"},{"title":"Refresh segment subscriber evaluation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /segments/{id}/refresh","href":"/api-reference/segments/refresh-segment-subscriber-evaluation"},{"title":"List segment subscribers","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /segments/{id}/subscribers","href":"/api-reference/segments/list-segment-subscribers"}]},{"group":"Sequences","pages":[{"title":"List sequences","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /sequences","href":"/api-reference/sequences/list-sequences"},{"title":"Create sequence","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /sequences","href":"/api-reference/sequences/create-sequence"},{"title":"Get sequence","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /sequences/{id}","href":"/api-reference/sequences/get-sequence"},{"title":"Update sequence","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /sequences/{id}","href":"/api-reference/sequences/update-sequence"},{"title":"Delete sequence","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /sequences/{id}","href":"/api-reference/sequences/delete-sequence"},{"title":"Patch sequence","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /sequences/{id}","href":"/api-reference/sequences/patch-sequence"},{"title":"Activate sequence","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /sequences/{id}/activate","href":"/api-reference/sequences/activate-sequence"},{"title":"Archive sequence","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /sequences/{id}/archive","href":"/api-reference/sequences/archive-sequence"},{"title":"Enroll subscriber into sequence","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /sequences/{id}/enroll","href":"/api-reference/sequences/enroll-subscriber-into-sequence"},{"title":"List sequence enrollments","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /sequences/{id}/enrollments","href":"/api-reference/sequences/list-sequence-enrollments"},{"title":"Enroll subscriber into sequence","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /sequences/{id}/enrollments","href":"/api-reference/sequences/enroll-subscriber-into-sequence-1"},{"title":"Get sequence enrollment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /sequences/{id}/enrollments/{enrollmentId}","href":"/api-reference/sequences/get-sequence-enrollment"},{"title":"Delete sequence enrollment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /sequences/{id}/enrollments/{enrollmentId}","href":"/api-reference/sequences/delete-sequence-enrollment"},{"title":"Pause sequence enrollment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /sequences/{id}/enrollments/{enrollmentId}/pause","href":"/api-reference/sequences/pause-sequence-enrollment"},{"title":"Resume sequence enrollment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /sequences/{id}/enrollments/{enrollmentId}/resume","href":"/api-reference/sequences/resume-sequence-enrollment"},{"title":"List goals met for sequence","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /sequences/{id}/goals","href":"/api-reference/sequences/list-goals-met-for-sequence"},{"title":"Pause sequence","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /sequences/{id}/pause","href":"/api-reference/sequences/pause-sequence"},{"title":"List sequence steps","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /sequences/{id}/steps","href":"/api-reference/sequences/list-sequence-steps"},{"title":"Add sequence step","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /sequences/{id}/steps","href":"/api-reference/sequences/add-sequence-step"},{"title":"Reorder sequence steps","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /sequences/{id}/steps/reorder","href":"/api-reference/sequences/reorder-sequence-steps"},{"title":"Update sequence step","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /sequences/{id}/steps/{stepId}","href":"/api-reference/sequences/update-sequence-step"},{"title":"Delete sequence step","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /sequences/{id}/steps/{stepId}","href":"/api-reference/sequences/delete-sequence-step"},{"title":"Unenroll subscriber by email","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /sequences/{id}/unenroll","href":"/api-reference/sequences/unenroll-subscriber-by-email"},{"title":"Trigger sequence via webhook","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /sequences/trigger/webhook","href":"/api-reference/sequences/trigger-sequence-via-webhook"},{"title":"Trigger sequence on link click","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /sequences/trigger/link-click","href":"/api-reference/sequences/trigger-sequence-on-link-click"},{"title":"Trigger sequence on page visit","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /sequences/trigger/page-visit","href":"/api-reference/sequences/trigger-sequence-on-page-visit"},{"title":"Trigger sequence on form submission","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /sequences/trigger/form-submit","href":"/api-reference/sequences/trigger-sequence-on-form-submission"},{"title":"Trigger sequence on tag applied","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /sequences/trigger/tag","href":"/api-reference/sequences/trigger-sequence-on-tag-applied"}]},{"group":"SMTP Pool","pages":[{"title":"Send email via managed SMTP pool (metered)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /smtp-pool/send","href":"/api-reference/smtp-pool/send-email-via-managed-smtp-pool-metered"},{"title":"Test send via SMTP pool (admin only)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /smtp-pool/test","href":"/api-reference/smtp-pool/test-send-via-smtp-pool-admin-only"}]},{"group":"Subscribers","pages":[{"title":"List subscribers in list","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /subscribers","href":"/api-reference/subscribers/list-subscribers-in-list"},{"title":"Create subscriber","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /subscribers","href":"/api-reference/subscribers/create-subscriber"},{"title":"Bulk subscribe subscribers","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /subscribers/bulk","href":"/api-reference/subscribers/bulk-subscribe-subscribers"},{"title":"Bulk delete subscribers","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /subscribers/bulk-delete","href":"/api-reference/subscribers/bulk-delete-subscribers"},{"title":"Bulk unsubscribe subscribers","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /subscribers/bulk-unsubscribe","href":"/api-reference/subscribers/bulk-unsubscribe-subscribers"},{"title":"Export subscribers","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /subscribers/export","href":"/api-reference/subscribers/export-subscribers"},{"title":"Import subscribers","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /subscribers/import","href":"/api-reference/subscribers/import-subscribers"},{"title":"Lookup subscriber by email","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /subscribers/lookup","href":"/api-reference/subscribers/lookup-subscriber-by-email"},{"title":"Unsubscribe by email and list","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /subscribers/unsubscribe","href":"/api-reference/subscribers/unsubscribe-by-email-and-list"},{"title":"Get subscriber by ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /subscribers/{id}","href":"/api-reference/subscribers/get-subscriber-by-id"},{"title":"Replace subscriber","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /subscribers/{id}","href":"/api-reference/subscribers/replace-subscriber"},{"title":"Delete subscriber","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /subscribers/{id}","href":"/api-reference/subscribers/delete-subscriber"},{"title":"Patch subscriber","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /subscribers/{id}","href":"/api-reference/subscribers/patch-subscriber"},{"title":"Get subscriber activity","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /subscribers/{id}/activity","href":"/api-reference/subscribers/get-subscriber-activity"},{"title":"Resubscribe subscriber by ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /subscribers/{id}/resubscribe","href":"/api-reference/subscribers/resubscribe-subscriber-by-id"},{"title":"Unsubscribe subscriber by ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /subscribers/{id}/unsubscribe","href":"/api-reference/subscribers/unsubscribe-subscriber-by-id"}]},{"group":"Suppressions","pages":[{"title":"Check suppression state","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /suppressions","href":"/api-reference/suppressions/check-suppression-state"},{"title":"Add suppression","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /suppressions","href":"/api-reference/suppressions/add-suppression"}]},{"group":"Readiness","pages":[{"title":"Evaluate readiness","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /system/readiness/evaluate","href":"/api-reference/readiness/evaluate-readiness"},{"title":"Generate inboarding path","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /system/readiness/inboarding","href":"/api-reference/readiness/generate-inboarding-path"},{"title":"Get persisted readiness report","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /system/readiness/report/{reportId}","href":"/api-reference/readiness/get-persisted-readiness-report"}]},{"group":"Settings","pages":[{"title":"List SendyKit settings","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /system/settings","href":"/api-reference/settings/list-sendykit-settings"},{"title":"Update SendyKit settings","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /system/settings","href":"/api-reference/settings/update-sendykit-settings"},{"title":"Get feature registry","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /system/settings/features","href":"/api-reference/settings/get-feature-registry"}]},{"group":"Tags","pages":[{"title":"List tags","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /tags","href":"/api-reference/tags/list-tags"},{"title":"Create tag","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /tags","href":"/api-reference/tags/create-tag"},{"title":"Get tag","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /tags/{id}","href":"/api-reference/tags/get-tag"},{"title":"Delete tag","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /tags/{id}","href":"/api-reference/tags/delete-tag"},{"title":"Add tag to subscriber","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /tags/{id}/add","href":"/api-reference/tags/add-tag-to-subscriber"},{"title":"Remove tag from subscriber","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /tags/{id}/remove","href":"/api-reference/tags/remove-tag-from-subscriber"},{"title":"List subscribers with tag","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /tags/{id}/subscribers","href":"/api-reference/tags/list-subscribers-with-tag"}]},{"group":"Templates","pages":[{"title":"List templates","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /templates","href":"/api-reference/templates/list-templates"},{"title":"Create template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /templates","href":"/api-reference/templates/create-template"},{"title":"Get template by ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /templates/{id}","href":"/api-reference/templates/get-template-by-id"},{"title":"Update template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /templates/{id}","href":"/api-reference/templates/update-template"},{"title":"Delete template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /templates/{id}","href":"/api-reference/templates/delete-template"},{"title":"Patch template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /templates/{id}","href":"/api-reference/templates/patch-template"},{"title":"Duplicate template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /templates/{id}/duplicate","href":"/api-reference/templates/duplicate-template"},{"title":"Preview template render","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /templates/{id}/preview","href":"/api-reference/templates/preview-template-render"}]},{"group":"Tenants","pages":[{"title":"List tenants","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /tenants","href":"/api-reference/tenants/list-tenants"},{"title":"Create tenant","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /tenants","href":"/api-reference/tenants/create-tenant"},{"title":"Get tenant","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /tenants/{tenantId}","href":"/api-reference/tenants/get-tenant"},{"title":"Update tenant","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /tenants/{tenantId}","href":"/api-reference/tenants/update-tenant"},{"title":"Delete tenant","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /tenants/{tenantId}","href":"/api-reference/tenants/delete-tenant"},{"title":"List tenant API keys","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /tenants/{tenantId}/keys","href":"/api-reference/tenants/list-tenant-api-keys"},{"title":"Create tenant API key","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /tenants/{tenantId}/keys","href":"/api-reference/tenants/create-tenant-api-key"},{"title":"Get tenant usage","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /tenants/{tenantId}/usage","href":"/api-reference/tenants/get-tenant-usage"}]},{"group":"Transactional","pages":[{"title":"Get transactional message by ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /tx/messages/{id}","href":"/api-reference/transactional/get-transactional-message-by-id"},{"title":"Get transactional template by ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /tx/templates/{id}","href":"/api-reference/transactional/get-transactional-template-by-id"},{"title":"Update transactional template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /tx/templates/{id}","href":"/api-reference/transactional/update-transactional-template"},{"title":"Delete transactional template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /tx/templates/{id}","href":"/api-reference/transactional/delete-transactional-template"},{"title":"List template versions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /tx/templates/{id}/versions","href":"/api-reference/transactional/list-template-versions"}]},{"group":"Webhooks","pages":[{"title":"List webhook subscriptions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /webhooks","href":"/api-reference/webhooks/list-webhook-subscriptions"},{"title":"Create webhook subscription","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /webhooks","href":"/api-reference/webhooks/create-webhook-subscription"},{"title":"Delete webhook subscription","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /webhooks","href":"/api-reference/webhooks/delete-webhook-subscription"},{"title":"List registered trigger events","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /webhooks/events","href":"/api-reference/webhooks/list-registered-trigger-events"},{"title":"Stripe webhook receiver","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /webhooks/stripe","href":"/api-reference/webhooks/stripe-webhook-receiver"},{"title":"Trigger machine action event","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /webhooks/trigger","href":"/api-reference/webhooks/trigger-machine-action-event"},{"title":"Get webhook","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /webhooks/{id}","href":"/api-reference/webhooks/get-webhook"},{"title":"Update webhook","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /webhooks/{id}","href":"/api-reference/webhooks/update-webhook"},{"title":"Delete webhook","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /webhooks/{id}","href":"/api-reference/webhooks/delete-webhook"}]},{"group":"Workflows","pages":[{"title":"Get workflow by ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /workflows/{id}","href":"/api-reference/workflows/get-workflow-by-id"},{"title":"Update workflow","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /workflows/{id}","href":"/api-reference/workflows/update-workflow"},{"title":"Delete workflow","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /workflows/{id}","href":"/api-reference/workflows/delete-workflow"},{"title":"Pause workflow","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /workflows/{id}/pause","href":"/api-reference/workflows/pause-workflow"},{"title":"Resume workflow","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /workflows/{id}/resume","href":"/api-reference/workflows/resume-workflow"},{"title":"List workflow runs","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /workflows/{id}/runs","href":"/api-reference/workflows/list-workflow-runs"},{"title":"Get workflow run trace","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /workflows/{id}/runs/{run_id}/trace","href":"/api-reference/workflows/get-workflow-run-trace"}]},{"group":"migrations","pages":[{"title":"Run migration pre-flight checks","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /system/migrate/domain/preflight","href":"/api-reference/migrations/run-migration-pre-flight-checks"},{"title":"Get migration status","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /system/migrate/domain/status","href":"/api-reference/migrations/get-migration-status"},{"title":"Full portable export (Sendy + SendyKit)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /migrations/export/full","href":"/api-reference/migrations/full-portable-export-sendy-+-sendykit"}]},{"group":"analytics","pages":[{"title":"Campaign country breakdown from opens","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /analytics/campaign/geo","href":"/api-reference/analytics/campaign-country-breakdown-from-opens"},{"title":"Per-link click breakdown for campaign","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /analytics/campaign/links","href":"/api-reference/analytics/per-link-click-breakdown-for-campaign"},{"title":"Real-time activity feed","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /analytics/activity","href":"/api-reference/analytics/real-time-activity-feed"},{"title":"Anomaly alerts — spike/drop detection","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /analytics/anomalies","href":"/api-reference/analytics/anomaly-alerts-—-spikedrop-detection"},{"title":"Natural language insights for dashboard","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /analytics/insights","href":"/api-reference/analytics/natural-language-insights-for-dashboard"},{"title":"Pre-send campaign quality score","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /analytics/campaign/score","href":"/api-reference/analytics/pre-send-campaign-quality-score"},{"title":"Unified sequence stats (Sendy + SendyKit)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /analytics/sequences/unified","href":"/api-reference/analytics/unified-sequence-stats-sendy-+-sendykit"}]},{"group":"automation","pages":[{"title":"List auto-action rules","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /automation/rules","href":"/api-reference/automation/list-auto-action-rules"},{"title":"Create auto-action rule","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /automation/rules","href":"/api-reference/automation/create-auto-action-rule"},{"title":"Auto-action execution log","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /automation/log","href":"/api-reference/automation/auto-action-execution-log"},{"title":"Preview auto-action rule","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /automation/dry-run","href":"/api-reference/automation/preview-auto-action-rule"},{"title":"Get auto-action rule","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /automation/rules/{id}","href":"/api-reference/automation/get-auto-action-rule"},{"title":"Update auto-action rule","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /automation/rules/{id}","href":"/api-reference/automation/update-auto-action-rule"},{"title":"Delete auto-action rule","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /automation/rules/{id}","href":"/api-reference/automation/delete-auto-action-rule"},{"title":"List auto-action rules","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /automation/rules/","href":"/api-reference/automation/list-auto-action-rules-1"},{"title":"Create auto-action rule","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /automation/rules/","href":"/api-reference/automation/create-auto-action-rule-1"}]},{"group":"webhooks","pages":[{"title":"SSE event stream","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /events/stream","href":"/api-reference/webhooks/sse-event-stream"},{"title":"Get event by ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /events/{id}","href":"/api-reference/webhooks/get-event-by-id"}]},{"group":"settings","pages":[{"title":"Get analytics settings","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /settings/analytics","href":"/api-reference/settings/get-analytics-settings"},{"title":"Update analytics settings","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /settings/analytics","href":"/api-reference/settings/update-analytics-settings"},{"title":"Update analytics settings (alias)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /settings/analytics","href":"/api-reference/settings/update-analytics-settings-alias"}]}]}]},"title":"Errors - SendyKit","buildId":"dpl_849ArpqvBiCczQiT1Y1stNGpbqHT","deploymentId":"dpl_849ArpqvBiCczQiT1Y1stNGpbqHT","dynamics":[],"chunks":[]}