{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Hypersender","description":"Send WhatsApp and SMS messages from your own numbers with the Hypersender API. Guides, REST API reference, webhook events, and Laravel SDK docs.","colors":{"primary":"#10b981","light":"#059669","dark":"#10b981"},"logo":{"light":"https://mintcdn.com/hypersender/RX4Bj-Mb6ti70ZQe/logo/light.svg?fit=max\u0026auto=format\u0026n=RX4Bj-Mb6ti70ZQe\u0026q=85\u0026s=e38aff8c21e09ed683da236a8ffe8e13","dark":"https://mintcdn.com/hypersender/RX4Bj-Mb6ti70ZQe/logo/dark.svg?fit=max\u0026auto=format\u0026n=RX4Bj-Mb6ti70ZQe\u0026q=85\u0026s=31d31abc2839f94267a1548817b83538","href":"https://docs.hypersender.com"},"favicon":"https://mintcdn.com/hypersender/dAZ_QYs7yJAVpPpO/favicon.svg?fit=max\u0026auto=format\u0026n=dAZ_QYs7yJAVpPpO\u0026q=85\u0026s=74d0e86aaf7cdfe05cbdf2c13a044dec","background":{"image":{"light":"https://mintcdn.com/hypersender/QHanPLHbv0ntvGTU/images/background.png?fit=max\u0026auto=format\u0026n=QHanPLHbv0ntvGTU\u0026q=85\u0026s=bfcb110c086b77caa501a84cab4586a4","dark":"https://mintcdn.com/hypersender/QHanPLHbv0ntvGTU/images/background-dark.png?fit=max\u0026auto=format\u0026n=QHanPLHbv0ntvGTU\u0026q=85\u0026s=3137c58a2031e6febc74d0c1ec3632ac"}},"navbar":{"links":[{"href":"mailto:[email protected]","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.hypersender.com"}},"footer":{"socials":{"x":"https://x.com/hypersender","github":"https://github.com/hypersender","linkedin":"https://linkedin.com/company/hypersender"}},"search":{"prompt":"Search WhatsApp \u0026 SMS API docs"},"seo":{"metatags":{"canonical":"https://docs.hypersender.com","og:site_name":"Hypersender Docs","og:locale":"en_US","twitter:card":"summary_large_image","twitter:site":"@hypersender","robots":"index, follow","googlebot":"index, follow","author":"Hypersender","theme-color":"#10b981"},"organization":{"id":"https://hypersender.com/#organization","name":"Hypersender","url":"https://hypersender.com","sameAs":["https://x.com/hypersender","https://github.com/hypersender","https://linkedin.com/company/hypersender"]},"indexing":"navigable"},"styling":{"eyebrows":"breadcrumbs","latex":false},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"metadata":{"timestamp":true},"navigation":{"global":{"anchors":[{"anchor":"WhatsApp Support","icon":"whatsapp","href":"https://wa.me/201065684630"},{"anchor":"Discord Support","icon":"discord","href":"https://discord.gg/ysSmK32ykC"},{"anchor":"Blog","icon":"newspaper","href":"https://hypersender.com/blog"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"hypersender","hasAudioNarration":false,"actualSubdomain":"hypersender","customDomains":["docs.hypersender.com"],"gitSource":{"type":"github","owner":"hypersender","repo":"docs-v2","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6aef799cae7fce64eaea8c9e","clientVersion":"0.0.4087","searchFilterCounts":[{"language":"default","tag":"Whatsapp API","count":72},{"language":"default","tag":"SMS API","count":58},{"language":"default","tag":"WhatsApp API","count":47},{"language":"default","tag":"Send Messages","count":36},{"language":"default","tag":"Packages and SDKs","count":30},{"language":"default","tag":"Laravel","count":28},{"language":"default","tag":"SMS Webhooks","count":26},{"language":"default","tag":"Enterprise WhatsApp API","count":22},{"language":"default","tag":"Guides","count":21},{"language":"default","tag":"Overview","count":18}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":".prose{--tw-prose-code: #10b981}.dark .prose{--tw-prose-code: #34d399}.prose :not(pre)>code,.mdx-prose :not(pre)>code,article :not(pre)>code{color:#10b981!important}.dark .prose :not(pre)>code,.dark .mdx-prose :not(pre)>code,.dark article :not(pre)>code{color:#34d399!important}"}],"page":{"pagePath":"v2/api-reference/enterprise/instance-management/check-instance-health","slug":"/v2/api-reference/enterprise/instance-management/check-instance-health","pageMetadata":{"title":"Check Instance Health","description":"Check the current health status of a WhatsApp instance by its UUID to monitor connectivity and readiness.","openapi":"v2/api-reference/enterprise/enterprise-collection.json GET /{instance}/health","href":"/v2/api-reference/enterprise/instance-management/check-instance-health"},"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: \"Check the current health status of a WhatsApp instance by its UUID to monitor connectivity and readiness.\"\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`,strong:`strong`,ul:`ul`,..._provideComponents(),...props.components},{Heading,Tip}=_components;if(!Heading)_missingMdxReference(`Heading`,true);if(!Tip)_missingMdxReference(`Tip`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`Check the current health status and connection state of your WhatsApp instance using its UUID.`}),`\n`,_jsx(Heading,{level:`2`,id:`rate-limit`,children:`Rate Limit`}),`\n`,_jsxs(_components.p,{children:[`This endpoint is limited to `,_jsx(_components.strong,{children:`10 requests per minute`}),` to prevent abuse and ensure system stability.`]}),`\n`,_jsx(Heading,{level:`2`,id:`response-fields`,children:`Response Fields`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`instance_id`}),` - The UUID of your WhatsApp instance`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`connected_at`}),` - Timestamp when the instance was connected`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`status`}),` - Current status of the instance`]}),`\n`]}),`\n`,_jsx(Heading,{level:`2`,id:`instance-status-values`,children:`Instance Status Values`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`STOPPED`}),`: Instance is stopped`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`STARTING`}),`: Instance is starting up`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`WORKING`}),`: Instance is running and ready to use`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`SCAN_QR_CODE`}),`: Waiting for QR code to be scanned`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`FAILED`}),`: Instance failed to start`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`PENDING`}),`: Awaiting server assignment`]}),`\n`]}),`\n`,_jsx(Heading,{level:`2`,id:`use-cases`,children:`Use Cases`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`Monitor instance health in your dashboard`}),`\n`,_jsx(_components.li,{children:`Verify instance is ready before sending messages`}),`\n`,_jsx(_components.li,{children:`Troubleshoot connection issues`}),`\n`,_jsx(_components.li,{children:`Automated health checks in monitoring systems`}),`\n`]}),`\n`,_jsx(Tip,{children:_jsxs(_components.p,{children:[`Check the instance health before attempting to send messages to ensure the instance is in `,_jsx(_components.code,{children:`WORKING`}),` status.`]})})]})}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":"Check Instance Health","description":"Check the current health status of a WhatsApp instance by its UUID to monitor connectivity and readiness.","openapi":"v2/api-reference/enterprise/enterprise-collection.json GET /{instance}/health","href":"/v2/api-reference/enterprise/instance-management/check-instance-health"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Rate Limit","slug":"rate-limit","depth":2,"children":[]},{"title":"Response Fields","slug":"response-fields","depth":2,"children":[]},{"title":"Instance Status Values","slug":"instance-status-values","depth":2,"children":[]},{"title":"Use Cases","slug":"use-cases","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Instance Management"],"x-hidden":true,"summary":"Check Instance Health","description":"Check the current health status of a WhatsApp instance by its UUID to monitor connectivity and readiness.","parameters":["df5473b8-76b4-474b-81a7-d5f8251bf190","7ec891bf-01bb-4499-9360-23527d8c1980"],"responses":{"200":"3cfb6ddf-321d-4733-9f6a-d606dcc42395","404":"ee472a24-09a3-48c1-b6f6-50f9dcb19514","429":"1d46b0d5-0d63-41d5-a706-10866128b769"},"security":["bb4dd166-5837-4d5f-8b69-687a4a8d4f23"],"method":"get","type":"path","servers":["25d66bfa-0f6d-48b3-8888-711d213b6252"],"path":"/{instance}/health","baseUrlOptions":["https://app.hypersender.com/api/whatsapp/v2"],"title":"Check Instance Health","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"df5473b8-76b4-474b-81a7-d5f8251bf190":{"name":"Accept","in":"header","description":"application/json","schema":{"type":"string","example":"application/json","description":"application/json","uniqueKey":"","typeLabel":"string"}},"7ec891bf-01bb-4499-9360-23527d8c1980":{"name":"instance","in":"path","description":"Instance UUID copied from hypersender dashboard","required":true,"schema":{"type":"string","example":"{{ instance_id }}","isRequired":true,"description":"Instance UUID copied from hypersender dashboard","uniqueKey":"","typeLabel":"string"}}},"responses":{"3cfb6ddf-321d-4733-9f6a-d606dcc42395":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object","properties":{"instance_id":{"type":"string","example":"fa3d01c4-1234-4c0d-a12f-df319b612f8c","uniqueKey":"instance_id","typeLabel":"string"},"connected_at":{"type":"string","example":"2025-05-26T10:12:45","uniqueKey":"connected_at","typeLabel":"string"},"status":{"type":"string","enum":["STOPPED","STARTING","WORKING","SCAN_QR_CODE","FAILED","PENDING"],"example":"WORKING","description":"Instance status:\n- STOPPED: Instance is stopped\n- STARTING: Instance is starting\n- WORKING: Instance is running and ready\n- SCAN_QR_CODE: Waiting for QR code to be scanned\n- FAILED: Instance failed to start\n- PENDING: Awaiting server assignment","uniqueKey":"status","typeLabel":"enum\u003cstring>"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"instance_id":"fa3d01c4-1234-4c0d-a12f-df319b612f8c","connected_at":"2025-05-26T10:12:45","status":"WORKING"}}},"exampleType":"generated"}},"exampleType":"generated"},"ee472a24-09a3-48c1-b6f6-50f9dcb19514":{"description":"Instance not found","content":{"application/json":{"schema":{"type":"object","title":"NotFoundError","example":{"message":"Resource not found."},"properties":{"message":{"type":"string","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"NotFoundError · object"},"examples":{"Example":{"title":"Example","value":{"message":"Resource not found."}}},"exampleType":"generated"}},"exampleType":"generated"},"1d46b0d5-0d63-41d5-a706-10866128b769":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","example":"Too many requests. Please try again later.","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"Too many requests. Please try again later."}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"bb4dd166-5837-4d5f-8b69-687a4a8d4f23":{"Authorization":{"type":"http","scheme":"bearer","description":"Bearer token authentication. Example: `Bearer 234|3uB2pBST2H6If8twXIeUaeNu23VJ8XassYoOVJuva48388e1`","scopes":[]}}},"servers":{"25d66bfa-0f6d-48b3-8888-711d213b6252":{"url":"https://app.hypersender.com/api/whatsapp/v2","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"Bearer token authentication. Example: `Bearer 234|3uB2pBST2H6If8twXIeUaeNu23VJ8XassYoOVJuva48388e1`","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer token authentication. Example: `Bearer 234|3uB2pBST2H6If8twXIeUaeNu23VJ8XassYoOVJuva48388e1`","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"Authorization","name":"Authorization"}],"title":"Authorization"}]},"originalFileLocation":"v2/api-reference/enterprise/enterprise-collection.json"},"subdomain":"hypersender","siteName":"Hypersender","title":"Check Instance Health - Hypersender","navMaps":{"firstHrefInVersion":{"v2":{"href":"/v2/api-reference/enterprise/instance-management/check-instance-health","matchLevel":0},"v1":{"href":"/v1/api-reference/enterprise/instance-management/check-instance-health","matchLevel":1,"canonicalOverride":true}},"firstHrefInLanguage":{}},"lastModified":"2026-11-07T19:19:07.986Z","gitLastModified":"2026-11-07T19:18:45.000Z","originalFileLocation":"v2/api-reference/enterprise/instance-management/check-instance-health.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=\"Check the current health status of a WhatsApp instance by its UUID to monitor connectivity and readiness.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Hypersender\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003cmeta data-mint-head name=\"robots\" content=\"index, follow\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/hypersender/YssXEy8fq447EilS/_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/hypersender/YssXEy8fq447EilS/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/hypersender/YssXEy8fq447EilS/_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/hypersender/YssXEy8fq447EilS/_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/hypersender/YssXEy8fq447EilS/_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/hypersender/YssXEy8fq447EilS/_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/hypersender/YssXEy8fq447EilS/_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/hypersender/YssXEy8fq447EilS/_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/hypersender/YssXEy8fq447EilS/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Check Instance Health - Hypersender\">\u003cmeta data-mint-head property=\"og:description\" content=\"Check the current health status of a WhatsApp instance by its UUID to monitor connectivity and readiness.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Hypersender Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.hypersender.com/v2/api-reference/enterprise/instance-management/check-instance-health\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://hypersender.mintlify.site/_mintlify/api/og/v2?division=Enterprise+WhatsApp+API\u0026amp;title=Check+Instance+Health\u0026amp;description=Check+the+current+health+status+of+a+WhatsApp+instance+by+its+UUID+to+monitor+connectivity+and+readiness.\u0026amp;theme=d6765127fbd2a000fa399d12\u0026amp;signature=6e6a48be7b4cfb2d40ecb412e626733bf5b265163933695a1feb5ed1ce31e5eb\">\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=\"Check Instance Health - Hypersender\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Check the current health status of a WhatsApp instance by its UUID to monitor connectivity and readiness.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://hypersender.mintlify.site/_mintlify/api/og/v2?division=Enterprise+WhatsApp+API\u0026amp;title=Check+Instance+Health\u0026amp;description=Check+the+current+health+status+of+a+WhatsApp+instance+by+its+UUID+to+monitor+connectivity+and+readiness.\u0026amp;theme=d6765127fbd2a000fa399d12\u0026amp;signature=6e6a48be7b4cfb2d40ecb412e626733bf5b265163933695a1feb5ed1ce31e5eb\">\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/hypersender/YssXEy8fq447EilS/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Hypersender\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#10b981\">\u003cmeta data-mint-head name=\"og:locale\" content=\"en_US\">\u003cmeta data-mint-head name=\"googlebot\" content=\"index, follow\">\u003cmeta data-mint-head name=\"author\" content=\"Hypersender\">\u003cmeta data-mint-head name=\"theme-color\" content=\"#10b981\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.hypersender.com/v2/api-reference/enterprise/instance-management/check-instance-health\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/v2/api-reference/enterprise/instance-management/check-instance-health.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://hypersender.com/#organization\",\"name\":\"Hypersender\",\"url\":\"https://hypersender.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/hypersender/RX4Bj-Mb6ti70ZQe/logo/light.svg?fit=max\u0026auto=format\u0026n=RX4Bj-Mb6ti70ZQe\u0026q=85\u0026s=e38aff8c21e09ed683da236a8ffe8e13\"},\"sameAs\":[\"https://x.com/hypersender\",\"https://github.com/hypersender\",\"https://linkedin.com/company/hypersender\"]},{\"@type\":\"WebSite\",\"@id\":\"https://docs.hypersender.com#website\",\"name\":\"Hypersender\",\"url\":\"https://docs.hypersender.com\",\"publisher\":{\"@id\":\"https://hypersender.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.hypersender.com/v2/api-reference/enterprise/instance-management/check-instance-health#webpage\",\"url\":\"https://docs.hypersender.com/v2/api-reference/enterprise/instance-management/check-instance-health\",\"name\":\"Check Instance Health\",\"description\":\"Check the current health status of a WhatsApp instance by its UUID to monitor connectivity and readiness.\",\"dateModified\":\"2026-11-07T19:18:45.000Z\",\"isPartOf\":{\"@id\":\"https://docs.hypersender.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.hypersender.com/v2/api-reference/enterprise/instance-management/check-instance-health#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.hypersender.com/v2/api-reference/enterprise/instance-management/check-instance-health#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Enterprise WhatsApp API\",\"item\":\"https://docs.hypersender.com/v2/api-reference/enterprise/instance-management/create-instance\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Check Instance Health\",\"item\":\"https://docs.hypersender.com/v2/api-reference/enterprise/instance-management/check-instance-health\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.hypersender.com/v2/api-reference/enterprise/instance-management/check-instance-health#apireference\",\"headline\":\"Check Instance Health\",\"name\":\"Check Instance Health\",\"description\":\"Check the current health status of a WhatsApp instance by its UUID to monitor connectivity and readiness.\",\"url\":\"https://docs.hypersender.com/v2/api-reference/enterprise/instance-management/check-instance-health\",\"mainEntityOfPage\":{\"@id\":\"https://docs.hypersender.com/v2/api-reference/enterprise/instance-management/check-instance-health#webpage\"},\"dateModified\":\"2026-11-07T19:18:45.000Z\",\"publisher\":{\"@id\":\"https://hypersender.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.hypersender.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Hypersender\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Hypersender","nav":{"global":{"anchors":[{"anchor":"WhatsApp Support","icon":"whatsapp","href":"https://wa.me/201065684630"},{"anchor":"Discord Support","icon":"discord","href":"https://discord.gg/ysSmK32ykC"},{"anchor":"Blog","icon":"newspaper","href":"https://hypersender.com/blog"}]},"versions":[{"version":"v2","tabs":[{"tab":"Guides","icon":"book","pages":[{"title":"Guides","href":"/v2/hypersender/hypersender-api-for-whatsapp-and-sms-messaging"}]},{"tab":"Whatsapp API","icon":"whatsapp","pages":[{"title":"Whatsapp API","href":"/v2/api-reference/whatsapp/whatsapp-api-introduction"}]},{"tab":"OTP API","icon":"lock","pages":[{"title":"OTP API","href":"/v2/api-reference/otp/otp-api-introduction"}]},{"tab":"SMS API","icon":"message","pages":[{"title":"SMS API","href":"/v2/api-reference/sms/sms-api-introduction"}]},{"tab":"Enterprise WhatsApp API","icon":"fire","groups":[{"group":"Overview","boost":3,"pages":[{"title":"Enterprise WhatsApp API Introduction","href":"/v2/api-reference/enterprise/enterprise-whatsapp-api-introduction"}]},{"group":"Enterprise WhatsApp API","pages":[{"title":"Create Instance","openapi":"v2/api-reference/enterprise/enterprise-collection.json POST /create-instance","href":"/v2/api-reference/enterprise/instance-management/create-instance"},{"title":"Request New QR Code","openapi":"v2/api-reference/enterprise/enterprise-collection.json POST /{instance}/request-new-qr-code","href":"/v2/api-reference/enterprise/instance-management/request-new-qr-code"},{"title":"Restart Instance","description":"Restart a WhatsApp instance to resolve connection issues or refresh its state.","openapi":"v2/api-reference/enterprise/enterprise-collection.json POST /{instance}/restart","href":"/v2/api-reference/enterprise/instance-management/restart-instance"},{"title":"Check Instance Health","openapi":"v2/api-reference/enterprise/enterprise-collection.json GET /{instance}/health","href":"/v2/api-reference/enterprise/instance-management/check-instance-health"},{"title":"List Instances","description":"Retrieve all WhatsApp instances associated with your account with powerful filtering options.","openapi":"v2/api-reference/enterprise/enterprise-collection.json GET /instances","href":"/v2/api-reference/enterprise/instance-management/list-instances"},{"group":"Instance Management","pages":[]}]}]},{"tab":"Packages and SDKs","icon":"box-open","pages":[{"title":"Packages and SDKs","href":"/v2/packages-and-sdks/packages-and-sdks-overview"}]}]},{"version":"v1","pages":[{"title":"v1","href":"/v1/api-reference/enterprise/instance-management/check-instance-health"}]}]},"basePath":"","title":"Check Instance Health - Hypersender","buildId":"dpl_FWZhTb2vab28gFGFH4ojka6qEznQ","deploymentId":"dpl_FWZhTb2vab28gFGFH4ojka6qEznQ","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CBsVopKK.js","utils-DZAk68jJ.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-D32AYZrP.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-D_A5_cny.js","snippetPresets-xNRfS9th.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BIB25-tq.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CydJ4w4j.js","shallow-CYPBeQSG.js","getApiPlaygroundDisplay-A5xJVBOu.js","CodeSnippet-BVRTgi3m.js","CodeSnippets-DjD6BSlt.js","Page-Dr40SSJq.js","getPastedJson-D4V4JyrR.js","icon-uhcnG22T.js","MethodPill-CM-ZQdGH.js","DuplicateIcon-B_WnOiNf.js","createIcon-CJsb8utt.js","DynamicMarkdown-D-2HDKEp.js","SectionHeading-KP5xmMgQ.js","axios-vUo_bRtp.js","Markdown-D_k0dg6k.js","clsx-DK3K4Z1S.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-DE3EVdvd.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-fN9H9n9g.js"]}