Create a new WhatsApp instance from an external application. The created instance is saved to your Wachat account and appears automatically in Settings > Instance. WhatsApp Baileys instances return a QR code in the same response.
Create a new WhatsApp instance from an external application using your Wachat API key.The instance is automatically saved to your account and will appear in Settings > Instance inside the dashboard. For WhatsApp Baileys instances, the response also includes a QR code immediately, so you do not need to call the QR endpoint after creating the instance.
instance.instanceName is the display name shown in Wachat. Use instance.apiInstanceName for future API calls such as sending messages, checking state, logout, and delete.
Displaying the QR Code
Use the qrcode.base64 value as an image source in your application.
The Mintlify API playground shows the QR code value as JSON. It does not automatically render qrcode.base64 as an image preview.
<img src="data:image/png;base64,..." alt="WhatsApp QR Code" />
You can also use qrcode.imageUrl to render the QR code through an image endpoint:
<img src="https://crm.wachat.net/api/v1/instance/qr/image?instanceName=t1_mq9r2jov_store-jakarta&apiKey=YOUR_API_KEY" alt="WhatsApp QR Code" />
For an auto-updating QR display that changes to a success message after the user scans it, use qrcode.liveUrl:
The instance display name is returned in X-Instance-Name. Use X-Api-Instance-Name for future API calls.
Authorizations
Authorization
string
header
required
Authenticate your integration payloads by injecting your premium secure Wachat Account API Private Secret Key inside standard Authorization Bearer header vectors.
Query Parameters
response
enum<string>
default:json
Set to image to return the QR code directly as image/png instead of JSON.
Available options:
json,
image
Body
application/json
instanceName
string
required
Friendly instance name. Wachat will add a unique prefix before saving the final instance name.
Example:
"jakarta_store"
number
string
Optional WhatsApp phone number with country code.
Example:
"628123456789"
integration
enum<string>
default:WHATSAPP-BAILEYS
Instance integration type.
Available options:
WHATSAPP-BAILEYS,
WHATSAPP-BUSINESS
Example:
"WHATSAPP-BAILEYS"
rejectCalls
boolean
Reject incoming WhatsApp calls automatically.
Example:
false
ignoreGroups
boolean
Ignore group messages for this instance.
Example:
false
alwaysOnline
boolean
Keep the instance online when possible.
Example:
true
readMessages
boolean
Mark incoming messages as read.
Example:
false
readStatus
boolean
Read status updates.
Example:
false
metaToken
string
Required only for WHATSAPP-BUSINESS integrations.
metaBusinessId
string
Required only for WHATSAPP-BUSINESS integrations.
metaPhoneNumberId
string
Required only for WHATSAPP-BUSINESS integrations.
Response
Instance created successfully. For WhatsApp Baileys, the QR code is returned immediately.
The response is of type file.
{"docsConfig":{"$schema":"https://mintlify.com/docs.json","theme":"mint","name":"Wachat","colors":{"primary":"#25D366","light":"#4ade80","dark":"#16a34a"},"favicon":"https://mintcdn.com/wachat-336ab83a/9nBhxtXyAAg2y0Gz/logo/favicon.png?fit=max\u0026auto=format\u0026n=9nBhxtXyAAg2y0Gz\u0026q=85\u0026s=afe15ff563e4f1b3b27f860d807640c6","logo":{"light":"https://mintcdn.com/wachat-336ab83a/mcumifWE4a7E0QYj/logo/light.png?fit=max\u0026auto=format\u0026n=mcumifWE4a7E0QYj\u0026q=85\u0026s=a0951689af3dcc8aeec39e45d675ef58","dark":"https://mintcdn.com/wachat-336ab83a/mcumifWE4a7E0QYj/logo/light.png?fit=max\u0026auto=format\u0026n=mcumifWE4a7E0QYj\u0026q=85\u0026s=a0951689af3dcc8aeec39e45d675ef58"},"api":{"openapi":"https://crm.wachat.net/docs/api.json","playground":{"display":"interactive"},"mdx":{"server":"https://crm.wachat.net/api/v1","auth":{"method":"bearer","name":null}}},"navbar":{"links":[{"label":"Pricing","href":"https://www.wachat.net/pricing"},{"label":"Support","href":"mailto:support@wachat.net"}],"primary":{"type":"button","label":"Dashboard","href":"https://crm.wachat.net"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"wachat-336ab83a","hasAudioNarration":false,"actualSubdomain":"wachat-336ab83a","customDomains":["docs.wachat.net"],"gitSource":{"type":"github","owner":"whmcs90","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6ab8da941f8fe965b40df0a2","clientVersion":"0.0.4270","searchFilterCounts":[{"language":"default","tag":"Messages","count":9},{"language":"default","tag":"Instances","count":7},{"language":"default","tag":"Webhooks","count":3},{"language":"default","tag":"Guides","count":3},{"language":"default","tag":"Start here","count":2},{"language":"default","tag":"Account","count":1},{"language":"default","tag":"Numbers","count":1},{"language":"default","tag":"Contacts","count":1},{"language":"default","tag":"Groups","count":1},{"language":"default","tag":"API Reference","count":1}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","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":"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":"site-roles","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":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[]}
{"page":{"pagePath":"api-reference/instance-create","slug":"/api-reference/instance-create","pageMetadata":{"title":"Create Instance","openapi":"POST /instance/create","description":"Create a new WhatsApp instance from an external application. The created instance is saved to your Wachat account and appears automatically in Settings > Instance. WhatsApp Baileys instances return a QR code in the same response.","href":"/api-reference/instance-create"},"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: \"Create a new WhatsApp instance from an external application. The created instance is saved to your Wachat account and appears automatically in Settings > Instance. WhatsApp Baileys instances return a QR code in the same response.\"\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`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,..._provideComponents(),...props.components},{CodeBlock,Heading,Note,Warning}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Note)_missingMdxReference(`Note`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`Create a new WhatsApp instance from an external application using your Wachat API key.`}),`\n`,_jsxs(_components.p,{children:[`The instance is automatically saved to your account and will appear in `,_jsx(_components.strong,{children:`Settings > Instance`}),` inside the dashboard. For WhatsApp Baileys instances, the response also includes a QR code immediately, so you do not need to call the QR endpoint after creating the instance.`]}),`\n`,_jsx(Note,{children:_jsxs(_components.p,{children:[_jsx(_components.code,{children:`instance.instanceName`}),` is the display name shown in Wachat. Use `,_jsx(_components.code,{children:`instance.apiInstanceName`}),` for future API calls such as sending messages, checking state, logout, and delete.`]})}),`\n`,_jsx(Heading,{level:`2`,id:`displaying-the-qr-code`,children:`Displaying the QR Code`}),`\n`,_jsxs(_components.p,{children:[`Use the `,_jsx(_components.code,{children:`qrcode.base64`}),` value as an image source in your application.`]}),`\n`,_jsx(Warning,{children:_jsxs(_components.p,{children:[`The Mintlify API playground shows the QR code value as JSON. It does not automatically render `,_jsx(_components.code,{children:`qrcode.base64`}),` as an image preview.`]})}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`1`,language:`html`,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:`html`,children:_jsxs(_components.code,{language:`html`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#808080`},children:`\u003c`}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:`img`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#9CDCFE`},children:` src`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"data:image/png;base64,...\"`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#9CDCFE`},children:` alt`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"WhatsApp QR Code\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#808080`},children:` />`})]}),`\n`]})})}),`\n`,_jsxs(_components.p,{children:[`You can also use `,_jsx(_components.code,{children:`qrcode.imageUrl`}),` to render the QR code through an image endpoint:`]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`1`,language:`html`,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:`html`,children:_jsxs(_components.code,{language:`html`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#808080`},children:`\u003c`}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:`img`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#9CDCFE`},children:` src`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"https://crm.wachat.net/api/v1/instance/qr/image?instanceName=t1_mq9r2jov_store-jakarta\u0026apiKey=YOUR_API_KEY\"`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#9CDCFE`},children:` alt`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"WhatsApp QR Code\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#808080`},children:` />`})]}),`\n`]})})}),`\n`,_jsxs(_components.p,{children:[`For an auto-updating QR display that changes to a success message after the user scans it, use `,_jsx(_components.code,{children:`qrcode.liveUrl`}),`:`]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`5`,language:`html`,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:`html`,children:_jsxs(_components.code,{language:`html`,numberOfLines:`5`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#808080`},children:`\u003c`}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:`iframe`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#9CDCFE`},children:` src`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"https://crm.wachat.net/api/v1/instance/qr/live?instanceName=t1_mq9r2jov_store-jakarta\u0026apiKey=YOUR_API_KEY\"`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#9CDCFE`},children:` width`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"420\"`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#9CDCFE`},children:` height`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`=`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"460\"`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#808080`},children:`>\u003c/`}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:`iframe`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#808080`},children:`>`})]}),`\n`]})})}),`\n`,_jsxs(_components.p,{children:[`If the QR code expires, request a fresh QR code using `,_jsx(_components.code,{children:`GET /instance/qr`}),`.`]}),`\n`,_jsx(Heading,{level:`2`,id:`return-qr-image-directly`,children:`Return QR Image Directly`}),`\n`,_jsxs(_components.p,{children:[`If you want the create request to return the QR code as an image instead of JSON, add `,_jsx(_components.code,{children:`response=image`}),` to the URL:`]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`9`,language:`shellscript`,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:`shellscript`,children:_jsxs(_components.code,{language:`shellscript`,numberOfLines:`9`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#953800`,\"--shiki-dark\":`#DCDCAA`},children:`curl`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -X`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` POST`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"https://crm.wachat.net/api/v1/instance/create?response=image\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Authorization: Bearer YOUR_API_KEY\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -H`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"Content-Type: application/json\"`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` -d`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` '{`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"instanceName\": \"store-jakarta\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"number\": \"628123456789\",`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` \"integration\": \"WHATSAPP-BAILEYS\"`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` }'`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D7BA7D`},children:` \\\\`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:` --output`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:` qr.png`})]}),`\n`]})})}),`\n`,_jsxs(_components.p,{children:[`The instance display name is returned in `,_jsx(_components.code,{children:`X-Instance-Name`}),`. Use `,_jsx(_components.code,{children:`X-Api-Instance-Name`}),` for future API calls.`]})]})}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":"Create Instance","openapi":"POST /instance/create","description":"Create a new WhatsApp instance from an external application. The created instance is saved to your Wachat account and appears automatically in Settings > Instance. WhatsApp Baileys instances return a QR code in the same response.","href":"/api-reference/instance-create"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Displaying the QR Code","slug":"displaying-the-qr-code","depth":2,"children":[]},{"title":"Return QR Image Directly","slug":"return-qr-image-directly","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Create WhatsApp Instance","description":"Create a new WhatsApp instance from an external application. The created instance is saved to your Wachat account and appears automatically in Settings > Instance. WhatsApp Baileys instances return a QR code in the same response.","tags":["Session Lifecycle Infrastructure"],"parameters":["3494e47c-33d8-4d1c-8469-8af8c7929479"],"requestBody":"7ca3c5c8-af1d-498e-a2f8-7036f14c274c","responses":{"201":"2fe6bc98-78e1-4933-b12c-45df59aa6b40","400":"cfffeeee-e9a1-4665-b2c6-27a7c2d59e7e","401":"7a766129-57a5-4fa7-997e-08cba61bb952","403":"7ff741c1-a054-480e-b8c1-8c22ff242c62","502":"5b80e332-b99b-4f9f-b629-9aada9946329"},"method":"post","type":"path","servers":["536c3b0c-abef-4d8d-8483-52ee9fa5eda9"],"security":["8dd0d32d-495e-4c03-bbd7-8622d71ed8f9"],"path":"/instance/create","baseUrlOptions":["https://crm.wachat.net/api/v1"],"title":"Create WhatsApp Instance","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"3494e47c-33d8-4d1c-8469-8af8c7929479":{"in":"query","name":"response","required":false,"schema":{"type":"string","enum":["json","image"],"default":"json","isRequired":false,"description":"Set to image to return the QR code directly as image/png instead of JSON.","uniqueKey":"","typeLabel":"enum\u003cstring>"},"description":"Set to image to return the QR code directly as image/png instead of JSON.","example":"image"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["instanceName"],"properties":{"instanceName":{"type":"string","description":"Friendly instance name. Wachat will add a unique prefix before saving the final instance name.","example":"jakarta_store","isRequired":true,"uniqueKey":"instanceName","typeLabel":"string"},"number":{"type":"string","description":"Optional WhatsApp phone number with country code.","example":"628123456789","uniqueKey":"number","typeLabel":"string"},"integration":{"type":"string","description":"Instance integration type.","enum":["WHATSAPP-BAILEYS","WHATSAPP-BUSINESS"],"default":"WHATSAPP-BAILEYS","example":"WHATSAPP-BAILEYS","uniqueKey":"integration","typeLabel":"enum\u003cstring>"},"rejectCalls":{"type":"boolean","description":"Reject incoming WhatsApp calls automatically.","example":false,"uniqueKey":"rejectCalls","typeLabel":"boolean"},"ignoreGroups":{"type":"boolean","description":"Ignore group messages for this instance.","example":false,"uniqueKey":"ignoreGroups","typeLabel":"boolean"},"alwaysOnline":{"type":"boolean","description":"Keep the instance online when possible.","example":true,"uniqueKey":"alwaysOnline","typeLabel":"boolean"},"readMessages":{"type":"boolean","description":"Mark incoming messages as read.","example":false,"uniqueKey":"readMessages","typeLabel":"boolean"},"readStatus":{"type":"boolean","description":"Read status updates.","example":false,"uniqueKey":"readStatus","typeLabel":"boolean"},"metaToken":{"type":"string","description":"Required only for WHATSAPP-BUSINESS integrations.","uniqueKey":"metaToken","typeLabel":"string"},"metaBusinessId":{"type":"string","description":"Required only for WHATSAPP-BUSINESS integrations.","uniqueKey":"metaBusinessId","typeLabel":"string"},"metaPhoneNumberId":{"type":"string","description":"Required only for WHATSAPP-BUSINESS integrations.","uniqueKey":"metaPhoneNumberId","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"baileys":{"title":"baileys","summary":"Create a WhatsApp Baileys instance","value":{"instanceName":"jakarta_store","number":"628123456789","integration":"WHATSAPP-BAILEYS"}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"2fe6bc98-78e1-4933-b12c-45df59aa6b40":{"description":"Instance created successfully. For WhatsApp Baileys, the QR code is returned immediately.","content":{"image/png":{"schema":{"type":"string","format":"binary","uniqueKey":"","typeLabel":"file"},"examples":{"Example":{"title":"Example","value":"\u003cstring>"}},"exampleType":"generated"},"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","example":true,"uniqueKey":"success","typeLabel":"boolean"},"instance":{"type":"object","properties":{"id":{"type":"integer","example":26,"uniqueKey":"instance.id","typeLabel":"integer"},"instanceName":{"type":"string","description":"Display name shown in Wachat.","example":"jakarta_store","uniqueKey":"instance.instanceName","typeLabel":"string"},"displayName":{"type":"string","example":"jakarta_store","uniqueKey":"instance.displayName","typeLabel":"string"},"apiInstanceName":{"type":"string","description":"Unique instance name used for future Wachat API requests.","example":"t1_mq9r2jov_jakarta_store","uniqueKey":"instance.apiInstanceName","typeLabel":"string"},"internalName":{"type":"string","description":"Same value as apiInstanceName.","example":"t1_mq9r2jov_jakarta_store","uniqueKey":"instance.internalName","typeLabel":"string"},"number":{"type":"string","example":"628123456789","uniqueKey":"instance.number","typeLabel":"string"},"integration":{"type":"string","example":"WHATSAPP-BAILEYS","uniqueKey":"instance.integration","typeLabel":"string"}},"uniqueKey":"instance","typeLabel":"object"},"qrcode":{"oneOf":[{"type":"object","description":"QR code data returned for WhatsApp Baileys instances.","properties":{"pairingCode":{"oneOf":[{"type":"string","example":"PKRFWHWE","uniqueKey":"qrcode.oneOf.0.pairingCode.oneOf.0","typeLabel":"string"},{"type":"null","example":"PKRFWHWE","uniqueKey":"qrcode.oneOf.0.pairingCode.oneOf.1","typeLabel":"null"}],"uniqueKey":"qrcode.oneOf.0.pairingCode","typeLabel":"string | null"},"code":{"oneOf":[{"type":"string","uniqueKey":"qrcode.oneOf.0.code.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"qrcode.oneOf.0.code.oneOf.1","typeLabel":"null"}],"uniqueKey":"qrcode.oneOf.0.code","typeLabel":"string | null"},"base64":{"oneOf":[{"type":"string","description":"Base64 image data URI. Use this value as an image src to display the QR code.","example":"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA...","uniqueKey":"qrcode.oneOf.0.base64.oneOf.0","typeLabel":"string"},{"type":"null","description":"Base64 image data URI. Use this value as an image src to display the QR code.","example":"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA...","uniqueKey":"qrcode.oneOf.0.base64.oneOf.1","typeLabel":"null"}],"uniqueKey":"qrcode.oneOf.0.base64","typeLabel":"string | null"},"imageUrl":{"oneOf":[{"type":"string","description":"URL that returns the QR code directly as an image. Add apiKey as a query parameter when using it inside an img tag.","example":"https://crm.wachat.net/api/v1/instance/qr/image?instanceName=t1_mq9r2jov_jakarta_store","uniqueKey":"qrcode.oneOf.0.imageUrl.oneOf.0","typeLabel":"string"},{"type":"null","description":"URL that returns the QR code directly as an image. Add apiKey as a query parameter when using it inside an img tag.","example":"https://crm.wachat.net/api/v1/instance/qr/image?instanceName=t1_mq9r2jov_jakarta_store","uniqueKey":"qrcode.oneOf.0.imageUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"qrcode.oneOf.0.imageUrl","typeLabel":"string | null"},"liveUrl":{"oneOf":[{"type":"string","description":"URL that returns a live HTML QR page. Add apiKey as a query parameter when using it inside an iframe.","example":"https://crm.wachat.net/api/v1/instance/qr/live?instanceName=t1_mq9r2jov_jakarta_store","uniqueKey":"qrcode.oneOf.0.liveUrl.oneOf.0","typeLabel":"string"},{"type":"null","description":"URL that returns a live HTML QR page. Add apiKey as a query parameter when using it inside an iframe.","example":"https://crm.wachat.net/api/v1/instance/qr/live?instanceName=t1_mq9r2jov_jakarta_store","uniqueKey":"qrcode.oneOf.0.liveUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"qrcode.oneOf.0.liveUrl","typeLabel":"string | null"},"count":{"oneOf":[{"type":"integer","example":1,"uniqueKey":"qrcode.oneOf.0.count.oneOf.0","typeLabel":"integer"},{"type":"null","example":1,"uniqueKey":"qrcode.oneOf.0.count.oneOf.1","typeLabel":"null"}],"uniqueKey":"qrcode.oneOf.0.count","typeLabel":"integer | null"}},"uniqueKey":"qrcode.oneOf.0","typeLabel":"object"},{"type":"null","description":"QR code data returned for WhatsApp Baileys instances.","properties":{"pairingCode":{"oneOf":[{"type":"string","example":"PKRFWHWE"},{"type":"null","example":"PKRFWHWE"}]},"code":{"oneOf":[{"type":"string"},{"type":"null"}]},"base64":{"oneOf":[{"type":"string","description":"Base64 image data URI. Use this value as an image src to display the QR code.","example":"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA..."},{"type":"null","description":"Base64 image data URI. Use this value as an image src to display the QR code.","example":"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA..."}]},"imageUrl":{"oneOf":[{"type":"string","description":"URL that returns the QR code directly as an image. Add apiKey as a query parameter when using it inside an img tag.","example":"https://crm.wachat.net/api/v1/instance/qr/image?instanceName=t1_mq9r2jov_jakarta_store"},{"type":"null","description":"URL that returns the QR code directly as an image. Add apiKey as a query parameter when using it inside an img tag.","example":"https://crm.wachat.net/api/v1/instance/qr/image?instanceName=t1_mq9r2jov_jakarta_store"}]},"liveUrl":{"oneOf":[{"type":"string","description":"URL that returns a live HTML QR page. Add apiKey as a query parameter when using it inside an iframe.","example":"https://crm.wachat.net/api/v1/instance/qr/live?instanceName=t1_mq9r2jov_jakarta_store"},{"type":"null","description":"URL that returns a live HTML QR page. Add apiKey as a query parameter when using it inside an iframe.","example":"https://crm.wachat.net/api/v1/instance/qr/live?instanceName=t1_mq9r2jov_jakarta_store"}]},"count":{"oneOf":[{"type":"integer","example":1},{"type":"null","example":1}]}},"uniqueKey":"qrcode.oneOf.1","typeLabel":"null"}],"uniqueKey":"qrcode","typeLabel":"object | null"},"qrError":{"oneOf":[{"type":"string","description":"Present when the instance was created but the QR code could not be fetched.","example":null,"uniqueKey":"qrError.oneOf.0","typeLabel":"string"},{"type":"null","description":"Present when the instance was created but the QR code could not be fetched.","example":null,"uniqueKey":"qrError.oneOf.1","typeLabel":"null"}],"uniqueKey":"qrError","typeLabel":"string | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":true,"instance":{"id":26,"instanceName":"jakarta_store","displayName":"jakarta_store","apiInstanceName":"t1_mq9r2jov_jakarta_store","internalName":"t1_mq9r2jov_jakarta_store","number":"628123456789","integration":"WHATSAPP-BAILEYS"},"qrcode":{"pairingCode":"PKRFWHWE","code":"\u003cstring>","base64":"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA...","imageUrl":"https://crm.wachat.net/api/v1/instance/qr/image?instanceName=t1_mq9r2jov_jakarta_store","liveUrl":"https://crm.wachat.net/api/v1/instance/qr/live?instanceName=t1_mq9r2jov_jakarta_store","count":1},"qrError":null}}},"exampleType":"generated"}},"exampleType":"generated"},"cfffeeee-e9a1-4665-b2c6-27a7c2d59e7e":{"description":"Invalid request payload.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"7a766129-57a5-4fa7-997e-08cba61bb952":{"description":"Missing or invalid API key.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"7ff741c1-a054-480e-b8c1-8c22ff242c62":{"description":"Subscription, limit, or channel restriction prevented instance creation.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"5b80e332-b99b-4f9f-b629-9aada9946329":{"description":"The Wachat API could not create the instance or return a valid instance ID.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}}},"security":{"8dd0d32d-495e-4c03-bbd7-8622d71ed8f9":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Authenticate your integration payloads by injecting your premium secure Wachat Account API Private Secret Key inside standard Authorization Bearer header vectors.","scopes":[]}}},"servers":{"536c3b0c-abef-4d8d-8483-52ee9fa5eda9":{"url":"https://crm.wachat.net/api/v1","description":"Live Production Gateway"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"Authenticate your integration payloads by injecting your premium secure Wachat Account API Private Secret Key inside standard Authorization Bearer header vectors.","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Authenticate your integration payloads by injecting your premium secure Wachat Account API Private Secret Key inside standard Authorization Bearer header vectors.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"openapi.yaml"},"subdomain":"wachat-336ab83a","siteName":"Wachat","title":"Create Instance - Wachat","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-09-27T08:44:49.100Z","originalFileLocation":"api-reference/instance-create.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=\"Create a new WhatsApp instance from an external application. The created instance is saved to your Wachat account and appears automatically in Settings \u0026gt; Instance. WhatsApp Baileys instances return a QR code in the same response.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Wachat\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/wachat-336ab83a/QI1uNIUdNU-5Jwgy/_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/wachat-336ab83a/QI1uNIUdNU-5Jwgy/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/wachat-336ab83a/QI1uNIUdNU-5Jwgy/_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/wachat-336ab83a/QI1uNIUdNU-5Jwgy/_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/wachat-336ab83a/QI1uNIUdNU-5Jwgy/_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/wachat-336ab83a/QI1uNIUdNU-5Jwgy/_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/wachat-336ab83a/QI1uNIUdNU-5Jwgy/_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/wachat-336ab83a/QI1uNIUdNU-5Jwgy/_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/wachat-336ab83a/QI1uNIUdNU-5Jwgy/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create Instance - Wachat\">\u003cmeta data-mint-head property=\"og:description\" content=\"Create a new WhatsApp instance from an external application. The created instance is saved to your Wachat account and appears automatically in Settings \u0026gt; Instance. WhatsApp Baileys instances return a QR code in the same response.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Wachat\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.wachat.net/api-reference/instance-create\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://wachat-336ab83a.mintlify.site/_mintlify/api/og/v2?division=Instances\u0026amp;title=Create+Instance\u0026amp;description=Create+a+new+WhatsApp+instance+from+an+external+application.+The+created+instance+is+saved+to+your+Wachat+account+and+appears+automatically+in+Settings+%3E+Instan\u0026amp;theme=67933629576128fde9291cfd\u0026amp;signature=ed3d735d2ee2872ba03f94157fa85df84e513328aac1bde1d3f1b556fb18a128\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Create Instance - Wachat\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Create a new WhatsApp instance from an external application. The created instance is saved to your Wachat account and appears automatically in Settings \u0026gt; Instance. WhatsApp Baileys instances return a QR code in the same response.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://wachat-336ab83a.mintlify.site/_mintlify/api/og/v2?division=Instances\u0026amp;title=Create+Instance\u0026amp;description=Create+a+new+WhatsApp+instance+from+an+external+application.+The+created+instance+is+saved+to+your+Wachat+account+and+appears+automatically+in+Settings+%3E+Instan\u0026amp;theme=67933629576128fde9291cfd\u0026amp;signature=ed3d735d2ee2872ba03f94157fa85df84e513328aac1bde1d3f1b556fb18a128\">\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/wachat-336ab83a/QI1uNIUdNU-5Jwgy/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Wachat\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#25D366\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.wachat.net/api-reference/instance-create\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/instance-create.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.wachat.net/#organization\",\"name\":\"Wachat\",\"url\":\"https://docs.wachat.net\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/wachat-336ab83a/mcumifWE4a7E0QYj/logo/light.png?fit=max\u0026auto=format\u0026n=mcumifWE4a7E0QYj\u0026q=85\u0026s=a0951689af3dcc8aeec39e45d675ef58\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.wachat.net#website\",\"name\":\"Wachat\",\"url\":\"https://docs.wachat.net\",\"publisher\":{\"@id\":\"https://docs.wachat.net/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.wachat.net/api-reference/instance-create#webpage\",\"url\":\"https://docs.wachat.net/api-reference/instance-create\",\"name\":\"Create Instance\",\"description\":\"Create a new WhatsApp instance from an external application. The created instance is saved to your Wachat account and appears automatically in Settings > Instance. WhatsApp Baileys instances return a QR code in the same response.\",\"dateModified\":\"2026-09-27T08:44:49.100Z\",\"isPartOf\":{\"@id\":\"https://docs.wachat.net#website\"},\"breadcrumb\":{\"@id\":\"https://docs.wachat.net/api-reference/instance-create#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.wachat.net/api-reference/instance-create#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Wachat\",\"item\":\"https://docs.wachat.net\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create Instance\",\"item\":\"https://docs.wachat.net/api-reference/instance-create\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.wachat.net/api-reference/instance-create#apireference\",\"headline\":\"Create Instance\",\"name\":\"Create Instance\",\"description\":\"Create a new WhatsApp instance from an external application. The created instance is saved to your Wachat account and appears automatically in Settings > Instance. WhatsApp Baileys instances return a QR code in the same response.\",\"url\":\"https://docs.wachat.net/api-reference/instance-create\",\"mainEntityOfPage\":{\"@id\":\"https://docs.wachat.net/api-reference/instance-create#webpage\"},\"dateModified\":\"2026-09-27T08:44:49.100Z\",\"publisher\":{\"@id\":\"https://docs.wachat.net/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.wachat.net#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Wachat\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Wachat\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/instance-create.md","siteName":"Wachat","nav":{"global":null,"groups":[{"group":"Start here","pages":[{"title":"Build on Wachat","mode":"wide","href":"/index"},{"title":"Introduction","href":"/introduction"}]},{"group":"Guides","pages":[{"title":"Authentication","href":"/guides/authentication"},{"title":"Quickstart","href":"/guides/quickstart"},{"title":"Webhooks","href":"/guides/webhooks"}]},{"group":"API Reference","pages":[{"title":"Introduction","href":"/api-reference/introduction"}]},{"group":"Account","pages":[{"title":"Get Account Limits","openapi":"GET /account/limits","href":"/api-reference/account-limits"}]},{"group":"Messages","pages":[{"title":"Send Text Message","openapi":"POST /send/text","href":"/api-reference/send-text"},{"title":"Send Media Message","openapi":"POST /send/media","href":"/api-reference/send-media"},{"title":"Send Reply Buttons","openapi":"openapi.yaml POST /send/button","href":"/api-reference/send-button"},{"title":"Send Carousel","openapi":"POST /send/carousel","href":"/api-reference/send-carousel"},{"title":"Send CTA Buttons","openapi":"POST /send/cta","href":"/api-reference/send-cta"},{"title":"Send List Menu","openapi":"POST /send/list","href":"/api-reference/send-list"},{"title":"Send Group Message","openapi":"POST /send-group","href":"/api-reference/send-group"},{"title":"Send Location","openapi":"POST /send-location","href":"/api-reference/send-location"},{"title":"Send Poll","openapi":"POST /send-poll","description":"Engage users and aggregate instantly actionable response feedback data loops by deploying structured real-time interactive choice survey components.","href":"/api-reference/send-poll"}]},{"group":"Instances","pages":[{"title":"Create Instance","openapi":"POST /instance/create","href":"/api-reference/instance-create"},{"title":"Get QR Image","openapi":"GET /instance/qr/image","description":"Return the QR code directly as an image/png response. This is useful for browser previews, documentation pages, and img tags. You can authenticate using the Authorization bearer header or the apiKey query parameter.","href":"/api-reference/instance-qr-image"},{"title":"Get Instance State","openapi":"GET /instance/state","href":"/api-reference/instance-state"},{"title":"Get Profile Picture","openapi":"GET /instance/profile-picture","href":"/api-reference/instance-profile-picture"},{"title":"List Instances","openapi":"GET /instance/list","href":"/api-reference/instance-list"},{"title":"Logout Instance","openapi":"DELETE /instance/logout","href":"/api-reference/instance-logout"},{"title":"Delete Instance","openapi":"DELETE /instance/delete","href":"/api-reference/instance-delete"}]},{"group":"Groups","pages":[{"title":"Get All Groups","openapi":"GET /groups","href":"/api-reference/groups"}]},{"group":"Contacts","pages":[{"title":"List Contacts","openapi":"GET /contacts","href":"/api-reference/contacts"}]},{"group":"Numbers","pages":[{"title":"Check Number","openapi":"GET /check-number","href":"/api-reference/check-number"}]},{"group":"Webhooks","pages":[{"title":"List Webhooks","openapi":"GET /webhooks","href":"/api-reference/webhooks"},{"title":"Create Webhook","openapi":"POST /webhooks","href":"/api-reference/webhooks-create"},{"title":"Delete Webhook","openapi":"DELETE /webhooks","href":"/api-reference/webhooks-delete"}]}]},"basePath":"","title":"Create Instance - Wachat","deploymentId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","buildId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CiUHMMOm.js","snippetPresets-BgfXU7Bw.js","utils-DWvOwgy_.js","style-to-object-BY3JEAdk.js","utils-BN7RXSMJ.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-CFw8bq89.js","conditional-requirements-CFM0id0Q.js","cloneDeep-CAwdfOU2.js","_Uint8Array-BJr8e-ZL.js","isObject-FP1Yky1u.js","ApiExamples-XX0UgMZK.js","usePlaygroundInputsStore-DXDFSa1V.js","shallow-CdX5aREi.js","isEqual-CoOaxexF.js","CodeSnippets-Cg2wpzWm.js","CodeSnippet-D_HwgQO_.js","getApiPlaygroundDisplay-CmCoerhe.js","Page-CVJ-f_k1.js","DynamicMarkdown-CQM9Bhbv.js","SectionHeading-DpbrP8nQ.js","icon-BPCgijHy.js","MethodPill-GQ8DuY0c.js","getPastedJson-Cb5mT31m.js","Check2Icon-a7bUI6e8.js","axios-CsQoIw0U.js","Markdown-CX2QY19L.js","AssistantPageLink-CY3bFglh.js","dist-Dl6_zDnT.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}