{"docsConfig":{"$schema":"https://mintlify.com/docs.json","theme":"mint","name":"l2msg Documentation","colors":{"primary":"#3758f9","light":"#3758f9","dark":"#3758f9"},"favicon":"/favicon.svg","logo":{"light":"https://mintcdn.com/l2msg/0A6iZ9aHBUgr6D1y/images/brand/logo.svg?fit=max\u0026auto=format\u0026n=0A6iZ9aHBUgr6D1y\u0026q=85\u0026s=edbad1c46ed4e7e484e71d3f74063c6b","dark":"https://mintcdn.com/l2msg/0A6iZ9aHBUgr6D1y/images/brand/logo-white.svg?fit=max\u0026auto=format\u0026n=0A6iZ9aHBUgr6D1y\u0026q=85\u0026s=a017ebb703615074df7fd5c6c6a862a1"},"api":{"openapi":["openapi/openapi-whatsapp.json"]},"appearance":{"default":"light","strict":null},"background":{"decoration":null,"color":{"light":null,"dark":"#18181B"}},"navbar":{"primary":{"type":"button","label":"Site","href":"https://l2msg.com"}},"footer":{"socials":{"website":"https://l2msg.com"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"l2msg","hasAudioNarration":false,"actualSubdomain":"l2msg","customDomains":["docs.l2msg.com"],"gitSource":{"type":"github","owner":"leleocastro","repo":"docs-evolution","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a21e67c4c43fec466d79c09","collectionId":"4378fe95-2896-4b61-91ad-1809379dd7a4","schemaVersion":"v2"},"entitlements":{},"buildId":"6a21e67c4c43fec466d79c09:success","clientVersion":"0.0.4006","searchFilterCounts":[{"language":"default","tag":"API","count":67},{"language":"default","tag":"Group Controller","count":15},{"language":"default","tag":"Chat Controller","count":14},{"language":"default","tag":"Send Message","count":11},{"language":"default","tag":"Instances","count":8},{"language":"default","tag":"Profile Settings","count":8},{"language":"default","tag":"Schedules","count":4},{"language":"default","tag":"English","count":4},{"language":"default","tag":"Getting Started","count":4},{"language":"default","tag":"Português","count":4}]},"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":"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":"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":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"whatsapp/api-reference/instance-controller/create-instance-basic","slug":"/whatsapp/api-reference/instance-controller/create-instance-basic","pageMetadata":{"title":"Create Instance","openapi":"openapi-whatsapp POST /instance/create","description":null,"href":"/whatsapp/api-reference/instance-controller/create-instance-basic","hidden":false},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Create Instance","openapi":"openapi-whatsapp POST /instance/create","description":null,"href":"/whatsapp/api-reference/instance-controller/create-instance-basic","hidden":false}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"createInstance","summary":"Create Instance","tags":["Instance Controller"],"deprecated":false,"security":["524ce81c-b061-4e19-93d4-55edd4ac8626"],"requestBody":"481074dd-09a8-43fe-8169-d076ed1ec622","responses":{"201":"aba1db79-8f3a-46a1-a19d-48ae065a9e03","403":"cef269ca-7336-4ccd-893b-c7fb931d2287"},"method":"post","type":"path","servers":["c25ae5d0-003a-47bd-bdcc-237921b092f6"],"path":"/instance/create","baseUrlOptions":["https://api.l2msg.com/whatsapp"],"title":"Create Instance","description":"","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["instanceName","integration"],"properties":{"instanceName":{"type":"string","description":"instance (Instance name)","isRequired":true,"uniqueKey":"instanceName","typeLabel":"string"},"qrcode":{"type":"boolean","description":"Create QR Code automatically after creation","uniqueKey":"qrcode","typeLabel":"boolean"},"number":{"type":"string","description":"559999999999 (Instance owner number with Country Code)","uniqueKey":"number","typeLabel":"string"},"rejectCall":{"type":"boolean","description":"Reject WhatsApp calls automatically","uniqueKey":"rejectCall","typeLabel":"boolean"},"msgCall":{"type":"string","description":"Message to be sent when a call is rejected automatically","uniqueKey":"msgCall","typeLabel":"string"},"groupsIgnore":{"type":"boolean","description":"Ignore group messages","uniqueKey":"groupsIgnore","typeLabel":"boolean"},"alwaysOnline":{"type":"boolean","description":"Keep WhatsApp always online","uniqueKey":"alwaysOnline","typeLabel":"boolean"},"readMessages":{"type":"boolean","description":"Send read receipts to received messages","uniqueKey":"readMessages","typeLabel":"boolean"},"readStatus":{"type":"boolean","description":"Show sent messages read status","uniqueKey":"readStatus","typeLabel":"boolean"},"syncFullHistory":{"type":"boolean","description":"Syncronize full WhatsApp history","uniqueKey":"syncFullHistory","typeLabel":"boolean"},"webhook":{"type":"object","properties":{"url":{"type":"string","description":"The URL of the webhook.","uniqueKey":"webhook.url","typeLabel":"string"},"byEvents":{"type":"boolean","description":"Enable Webhook by events","uniqueKey":"webhook.byEvents","typeLabel":"boolean"},"base64":{"type":"boolean","description":"Sends files in base64 when available","uniqueKey":"webhook.base64","typeLabel":"boolean"},"headers":{"type":"object","description":"Headers for send the API from webhook","properties":{"autorization":{"type":"string","description":"Your authorization key header","uniqueKey":"webhook.headers.autorization","typeLabel":"string"},"Content-Type":{"type":"string","description":"content-type","uniqueKey":"webhook.headers.Content-Type","typeLabel":"string"}},"uniqueKey":"webhook.headers","typeLabel":"object"},"events":{"type":"array","items":{"type":"string","enum":["APPLICATION_STARTUP","QRCODE_UPDATED","MESSAGES_SET","MESSAGES_UPSERT","MESSAGES_UPDATE","MESSAGES_DELETE","SEND_MESSAGE","CONTACTS_SET","CONTACTS_UPSERT","CONTACTS_UPDATE","PRESENCE_UPDATE","CHATS_SET","CHATS_UPSERT","CHATS_UPDATE","CHATS_DELETE","GROUPS_UPSERT","GROUP_UPDATE","GROUP_PARTICIPANTS_UPDATE","CONNECTION_UPDATE","CALL","NEW_JWT_TOKEN","TYPEBOT_START","TYPEBOT_CHANGE_STATUS"],"uniqueKey":"webhook.events.items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"Events to be sent to the Webhook","uniqueKey":"webhook.events","typeLabel":"enum\u003cstring>[]"}},"description":"Webhook","uniqueKey":"webhook","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"instanceName":"\u003cstring>","qrcode":true,"number":"\u003cstring>","rejectCall":true,"msgCall":"\u003cstring>","groupsIgnore":true,"alwaysOnline":true,"readMessages":true,"readStatus":true,"syncFullHistory":true,"webhook":{"url":"\u003cstring>","byEvents":true,"base64":true,"headers":{"autorization":"\u003cstring>","Content-Type":"\u003cstring>"},"events":[]}}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"aba1db79-8f3a-46a1-a19d-48ae065a9e03":{"description":"Created","content":{"application/json":{"schema":{"type":"object","properties":{"instance":{"type":"object","properties":{"instanceName":{"type":"string","description":"The name of the instance","uniqueKey":"instance.instanceName","typeLabel":"string"},"instanceId":{"type":"string","description":"The unique identifier for the instance","uniqueKey":"instance.instanceId","typeLabel":"string"},"webhook_wa_business":{"type":"string","description":"The webhook URL for WhatsApp Business integration","uniqueKey":"instance.webhook_wa_business","typeLabel":"string"},"access_token_wa_business":{"type":"string","description":"The access token for WhatsApp Business","uniqueKey":"instance.access_token_wa_business","typeLabel":"string"},"status":{"type":"string","description":"The current status of the instance","uniqueKey":"instance.status","typeLabel":"string"}},"uniqueKey":"instance","typeLabel":"object"},"hash":{"type":"object","properties":{"apikey":{"type":"string","description":"The API key for authentication","uniqueKey":"hash.apikey","typeLabel":"string"}},"uniqueKey":"hash","typeLabel":"object"},"settings":{"type":"object","properties":{"reject_call":{"type":"boolean","description":"Indicates whether calls are rejected","uniqueKey":"settings.reject_call","typeLabel":"boolean"},"msg_call":{"type":"string","description":"Message to be sent when a call is rejected","uniqueKey":"settings.msg_call","typeLabel":"string"},"groups_ignore":{"type":"boolean","description":"Indicates whether groups are ignored","uniqueKey":"settings.groups_ignore","typeLabel":"boolean"},"always_online":{"type":"boolean","description":"Indicates whether the instance is always online","uniqueKey":"settings.always_online","typeLabel":"boolean"},"read_messages":{"type":"boolean","description":"Indicates whether messages are marked as read","uniqueKey":"settings.read_messages","typeLabel":"boolean"},"read_status":{"type":"boolean","description":"Indicates whether status updates are marked as read","uniqueKey":"settings.read_status","typeLabel":"boolean"},"sync_full_history":{"type":"boolean","description":"Indicates whether the full message history is synchronized","uniqueKey":"settings.sync_full_history","typeLabel":"boolean"}},"uniqueKey":"settings","typeLabel":"object"}},"example":{"instance":{"instanceName":"teste-docs","instanceId":"af6c5b7c-ee27-4f94-9ea8-192393746ddd","webhook_wa_business":null,"access_token_wa_business":"","status":"created"},"hash":{"apikey":"123456"},"settings":{"reject_call":false,"msg_call":"","groups_ignore":true,"always_online":false,"read_messages":false,"read_status":false,"sync_full_history":false}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"instance":{"instanceName":"teste-docs","instanceId":"af6c5b7c-ee27-4f94-9ea8-192393746ddd","webhook_wa_business":null,"access_token_wa_business":"","status":"created"},"hash":{"apikey":"123456"},"settings":{"reject_call":false,"msg_call":"","groups_ignore":true,"always_online":false,"read_messages":false,"read_status":false,"sync_full_history":false}}}},"exampleType":"generated"}},"exampleType":"generated"},"cef269ca-7336-4ccd-893b-c7fb931d2287":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"integer","description":"The HTTP status of the response","uniqueKey":"status","typeLabel":"integer"},"error":{"type":"string","description":"The error message indicating the type of error","uniqueKey":"error","typeLabel":"string"},"response":{"type":"object","properties":{"message":{"type":"array","items":{"type":"string","uniqueKey":"response.message.items.[INDEX]","typeLabel":"string"},"description":"List of detailed error messages","uniqueKey":"response.message","typeLabel":"string[]"}},"uniqueKey":"response","typeLabel":"object"}},"example":{"status":403,"error":"Forbidden","response":{"message":["This name \"instance-example-name\" is already in use."]}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status":403,"error":"Forbidden","response":{"message":["This name \"instance-example-name\" is already in use."]}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"524ce81c-b061-4e19-93d4-55edd4ac8626":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"apikey","description":"Your authorization key header","scopes":[]}}},"servers":{"c25ae5d0-003a-47bd-bdcc-237921b092f6":{"url":"https://api.l2msg.com/whatsapp"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"apikey","description":"Your authorization key header","scopes":[]},"schema":{"title":"apikey","type":"string","description":"Your authorization key header","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ApiKeyAuth","name":"apikey"}],"title":"ApiKeyAuth"}]},"originalFileLocation":"openapi/openapi-whatsapp.json"},"subdomain":"l2msg","siteName":"l2msg Documentation","title":"Create Instance - l2msg Documentation","navMaps":{"firstHrefInVersion":{"whatsapp":{"href":"/whatsapp/api-reference/instance-controller/create-instance-basic","matchLevel":0}},"firstHrefInLanguage":{}},"lastModified":"2026-02-08T00:00:49.273Z","originalFileLocation":"whatsapp/api-reference/instance-controller/create-instance-basic.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=\"light\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"application-name\" content=\"l2msg Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/l2msg/IXkIg1c9h42woCiJ/_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/l2msg/IXkIg1c9h42woCiJ/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/l2msg/IXkIg1c9h42woCiJ/_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/l2msg/IXkIg1c9h42woCiJ/_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/l2msg/IXkIg1c9h42woCiJ/_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/l2msg/IXkIg1c9h42woCiJ/_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/l2msg/IXkIg1c9h42woCiJ/_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/l2msg/IXkIg1c9h42woCiJ/_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/l2msg/IXkIg1c9h42woCiJ/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create Instance - l2msg Documentation\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"l2msg Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.l2msg.com/whatsapp/api-reference/instance-controller/create-instance-basic\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://l2msg.mintlify.app/_mintlify/api/og/v2?division=Instances\u0026amp;title=Create+Instance\u0026amp;theme=2e2443b62b1478f7bea572d5\u0026amp;signature=6a5c221a5775ffb9b14509daa9735578cfaf2f2d65b4d966a177005ba946d79c\">\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 - l2msg Documentation\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://l2msg.mintlify.app/_mintlify/api/og/v2?division=Instances\u0026amp;title=Create+Instance\u0026amp;theme=2e2443b62b1478f7bea572d5\u0026amp;signature=6a5c221a5775ffb9b14509daa9735578cfaf2f2d65b4d966a177005ba946d79c\">\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/l2msg/IXkIg1c9h42woCiJ/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"l2msg Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#3758f9\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.l2msg.com/whatsapp/api-reference/instance-controller/create-instance-basic\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/whatsapp/api-reference/instance-controller/create-instance-basic.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.l2msg.com/#organization\",\"name\":\"l2msg Documentation\",\"url\":\"https://docs.l2msg.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/l2msg/0A6iZ9aHBUgr6D1y/images/brand/logo.svg?fit=max\u0026auto=format\u0026n=0A6iZ9aHBUgr6D1y\u0026q=85\u0026s=edbad1c46ed4e7e484e71d3f74063c6b\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.l2msg.com#website\",\"name\":\"l2msg Documentation\",\"url\":\"https://docs.l2msg.com\",\"publisher\":{\"@id\":\"https://docs.l2msg.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.l2msg.com/whatsapp/api-reference/instance-controller/create-instance-basic#webpage\",\"url\":\"https://docs.l2msg.com/whatsapp/api-reference/instance-controller/create-instance-basic\",\"name\":\"Create Instance\",\"dateModified\":\"2026-02-08T00:00:49.273Z\",\"isPartOf\":{\"@id\":\"https://docs.l2msg.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.l2msg.com/whatsapp/api-reference/instance-controller/create-instance-basic#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.l2msg.com/whatsapp/api-reference/instance-controller/create-instance-basic#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"l2msg Documentation\",\"item\":\"https://docs.l2msg.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create Instance\",\"item\":\"https://docs.l2msg.com/whatsapp/api-reference/instance-controller/create-instance-basic\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.l2msg.com/whatsapp/api-reference/instance-controller/create-instance-basic#apireference\",\"headline\":\"Create Instance\",\"name\":\"Create Instance\",\"url\":\"https://docs.l2msg.com/whatsapp/api-reference/instance-controller/create-instance-basic\",\"mainEntityOfPage\":{\"@id\":\"https://docs.l2msg.com/whatsapp/api-reference/instance-controller/create-instance-basic#webpage\"},\"dateModified\":\"2026-02-08T00:00:49.273Z\",\"publisher\":{\"@id\":\"https://docs.l2msg.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.l2msg.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"l2msg Documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"l2msg Documentation","nav":{"global":null,"versions":[{"version":"whatsapp","tabs":[{"tab":"English","pages":[{"title":"English","href":"/whatsapp/en/get-started/introduction"}]},{"tab":"Português","pages":[{"title":"Português","href":"/whatsapp/pt/get-started/introduction"}]},{"tab":"API","groups":[{"group":"Início","pages":[{"title":"Get Information","openapi":"openapi-whatsapp GET /","description":"Get information about your l2msg Whatsapp API","href":"/whatsapp/api-reference/get-information"}]},{"group":"Instances","pages":[{"title":"Create Instance","openapi":"openapi-whatsapp POST /instance/create","href":"/whatsapp/api-reference/instance-controller/create-instance-basic"},{"title":"Fetch Instances","openapi":"openapi-whatsapp GET /instance/fetchInstances","description":"Returns the instance with the name informed in the parameter, or all the instances if empty.","href":"/whatsapp/api-reference/instance-controller/fetch-instances"},{"title":"Instance Connect","openapi":"openapi-whatsapp GET /instance/connect/{instance}","href":"/whatsapp/api-reference/instance-controller/instance-connect"},{"title":"Restart Instance","openapi":"openapi-whatsapp PUT /instance/restart/{instance}","href":"/whatsapp/api-reference/instance-controller/restart-instance"},{"title":"Connection State","openapi":"openapi-whatsapp GET /instance/connectionState/{instance}","href":"/whatsapp/api-reference/instance-controller/connection-state"},{"title":"Logout Instance","openapi":"openapi-whatsapp DELETE /instance/logout/{instance}","href":"/whatsapp/api-reference/instance-controller/logout-instance"},{"title":"Delete Instance","openapi":"openapi-whatsapp DELETE /instance/delete/{instance}","href":"/whatsapp/api-reference/instance-controller/delete-instance"},{"title":"Set Presence","openapi":"openapi-whatsapp POST /instance/setPresence/{instance}","href":"/whatsapp/api-reference/instance-controller/set-presence"}]},{"group":"Webhook","pages":[{"title":"Set Webhook","openapi":"openapi-whatsapp POST /webhook/set/{instance}","href":"/whatsapp/api-reference/webhook/set"},{"title":"Find Webhook","openapi":"openapi-whatsapp GET /webhook/find/{instance}","href":"/whatsapp/api-reference/webhook/get"}]},{"group":"Schedules","pages":[{"title":"Create Schedule","openapi":"openapi-whatsapp POST /schedule","href":"/whatsapp/api-reference/schedules/create"},{"title":"Get Schedules","openapi":"openapi-whatsapp GET /schedule","href":"/whatsapp/api-reference/schedules/get"},{"title":"Update Schedule","openapi":"openapi-whatsapp PUT /schedule/{scheduleID}","href":"/whatsapp/api-reference/schedules/update"},{"title":"Delete Schedule","openapi":"openapi-whatsapp DELETE /schedule/{scheduleID}","href":"/whatsapp/api-reference/schedules/delete"}]},{"group":"Settings","pages":[{"title":"Set Settings","openapi":"openapi-whatsapp POST /settings/set/{instance}","href":"/whatsapp/api-reference/settings/set"},{"title":"Find Settings","openapi":"openapi-whatsapp GET /settings/find/{instance}","href":"/whatsapp/api-reference/settings/get"}]},{"group":"Send Message","pages":[{"title":"Send Plain Text","openapi":"openapi-whatsapp POST /message/sendText/{instance}","href":"/whatsapp/api-reference/message-controller/send-text"},{"title":"Send Status","openapi":"openapi-whatsapp POST /message/sendStatus/{instance}","href":"/whatsapp/api-reference/message-controller/send-status"},{"title":"Send Media","openapi":"openapi-whatsapp POST /message/sendMedia/{instance}","href":"/whatsapp/api-reference/message-controller/send-media"},{"title":"Send WhatsApp Audio","openapi":"openapi-whatsapp POST /message/sendWhatsAppAudio/{instance}","href":"/whatsapp/api-reference/message-controller/send-audio"},{"title":"Send Sticker","openapi":"openapi-whatsapp POST /message/sendSticker/{instance}","href":"/whatsapp/api-reference/message-controller/send-sticker"},{"title":"Send Location","openapi":"openapi-whatsapp POST /message/sendLocation/{instance}","href":"/whatsapp/api-reference/message-controller/send-location"},{"title":"Send Contact","openapi":"openapi-whatsapp POST /message/sendContact/{instance}","href":"/whatsapp/api-reference/message-controller/send-contact"},{"title":"Send Reaction","openapi":"openapi-whatsapp POST /message/sendReaction/{instance}","href":"/whatsapp/api-reference/message-controller/send-reaction"},{"title":"Send Poll","openapi":"openapi-whatsapp POST /message/sendPoll/{instance}","href":"/whatsapp/api-reference/message-controller/send-poll"},{"title":"Send List","openapi":"openapi-whatsapp POST /message/sendList/{instance}","href":"/whatsapp/api-reference/message-controller/send-list"},{"title":"Send Buttons","openapi":"openapi-whatsapp POST /message/sendButtons/{instance}","href":"/whatsapp/api-reference/message-controller/send-button"}]},{"group":"Chat Controller","pages":[{"title":"Check is WhatsApp","openapi":"openapi-whatsapp POST /chat/whatsappNumbers/{instance}","href":"/whatsapp/api-reference/chat-controller/check-is-whatsapp"},{"title":"Mark Message As Read","openapi":"openapi-whatsapp POST /chat/markMessageAsRead/{instance}","href":"/whatsapp/api-reference/chat-controller/mark-as-read"},{"title":"Mark Message As Unread","openapi":"openapi-whatsapp POST /chat/markChatUnread/{instance}","href":"/whatsapp/api-reference/chat-controller/mark-as-unread"},{"title":"Archive Chat","openapi":"openapi-whatsapp POST /chat/archiveChat/{instance}","href":"/whatsapp/api-reference/chat-controller/archive-chat"},{"title":"Delete Message for Everyone","openapi":"openapi-whatsapp DELETE /chat/deleteMessageForEveryone/{instance}","href":"/whatsapp/api-reference/chat-controller/delete-message-for-everyone"},{"title":"Update Message","openapi":"openapi-whatsapp POST /chat/updateMessage/{instance}","href":"/whatsapp/api-reference/chat-controller/update-message"},{"title":"Send Presence","openapi":"openapi-whatsapp POST /chat/sendPresence/{instance}","href":"/whatsapp/api-reference/chat-controller/send-presence"},{"title":"Update Block Status","openapi":"openapi-whatsapp POST /message/updateBlockStatus/{instance}","href":"/whatsapp/api-reference/chat-controller/updateBlockStatus"},{"title":"Fetch Profile Picture URL","openapi":"openapi-whatsapp POST /chat/fetchProfilePictureUrl/{instance}","href":"/whatsapp/api-reference/chat-controller/fetch-profilepic-url"},{"title":"Get Base64","openapi":"openapi-whatsapp POST /chat/getBase64FromMediaMessage/{instance}","href":"/whatsapp/api-reference/chat-controller/get-base64"},{"title":"Find Contacts","openapi":"openapi-whatsapp POST /chat/findContacts/{instance}","href":"/whatsapp/api-reference/chat-controller/find-contacts"},{"title":"Find Messages","openapi":"openapi-whatsapp POST /chat/findMessages/{instance}","href":"/whatsapp/api-reference/chat-controller/find-messages"},{"title":"Find Status Message","openapi":"openapi-whatsapp POST /chat/findStatusMessage/{instance}","href":"/whatsapp/api-reference/chat-controller/find-status-message"},{"title":"Find Chats","openapi":"openapi-whatsapp POST /chat/findChats/{instance}","href":"/whatsapp/api-reference/chat-controller/find-chats"}]},{"group":"Profile Settings","pages":[{"title":"Fetch Business Profile","openapi":"openapi-whatsapp POST /chat/fetchBusinessProfile/{instance}","href":"/whatsapp/api-reference/profile-settings/fetch-business-profile"},{"title":"Fetch Profile","openapi":"openapi-whatsapp POST /chat/fetchProfile/{instance}","href":"/whatsapp/api-reference/profile-settings/fetch-profile"},{"title":"Update Profile Name","openapi":"openapi-whatsapp POST /chat/updateProfileName/{instance}","href":"/whatsapp/api-reference/profile-settings/update-profile-name"},{"title":"Update Profile Status","openapi":"openapi-whatsapp POST /chat/updateProfileStatus/{instance}","href":"/whatsapp/api-reference/profile-settings/update-profile-status"},{"title":"Update Profile Picture","openapi":"openapi-whatsapp POST /chat/updateProfilePicture/{instance}","href":"/whatsapp/api-reference/profile-settings/update-profile-picture"},{"title":"Remove Profile Picture","openapi":"openapi-whatsapp DELETE /chat/removeProfilePicture/{instance}","href":"/whatsapp/api-reference/profile-settings/remove-profile-picture"},{"title":"Fetch Privacy Settings","openapi":"openapi-whatsapp GET /chat/fetchPrivacySettings/{instance}","href":"/whatsapp/api-reference/profile-settings/fetch-privacy-settings"},{"title":"Update Privacy Settings","openapi":"openapi-whatsapp POST /chat/updatePrivacySettings/{instance}","href":"/whatsapp/api-reference/profile-settings/update-privacy-settings"}]},{"group":"Group Controller","pages":[{"title":"Create Group","openapi":"openapi-whatsapp POST /group/create/{instance}","href":"/whatsapp/api-reference/group-controller/group-create"},{"title":"Update Group Picture","openapi":"openapi-whatsapp POST /group/updateGroupPicture/{instance}","href":"/whatsapp/api-reference/group-controller/update-group-picture"},{"title":"Update Group Subject","openapi":"openapi-whatsapp POST /group/updateGroupSubject/{instance}","href":"/whatsapp/api-reference/group-controller/update-group-subject"},{"title":"Update Group Description","openapi":"openapi-whatsapp POST /group/updateGroupDescription/{instance}","href":"/whatsapp/api-reference/group-controller/update-group-description"},{"title":"Fetch Invite Code","openapi":"openapi-whatsapp GET /group/inviteCode/{instance}","href":"/whatsapp/api-reference/group-controller/fetch-invite-code"},{"title":"Revoke Invite Code","openapi":"openapi-whatsapp POST /group/revokeInviteCode/{instance}","href":"/whatsapp/api-reference/group-controller/revoke-invite-code"},{"title":"Send Group Invite","openapi":"openapi-whatsapp POST /group/sendInvite/{instance}","href":"/whatsapp/api-reference/group-controller/send-invite-url"},{"title":"Find Group by Invite Code","openapi":"openapi-whatsapp GET /group/inviteInfo/{instance}","href":"/whatsapp/api-reference/group-controller/find-group-by-invite-code"},{"title":"Find Group by JID","openapi":"openapi-whatsapp GET /group/findGroupInfos/{instance}","href":"/whatsapp/api-reference/group-controller/find-group-by-jid"},{"title":"Fetch All Groups","openapi":"openapi-whatsapp GET /group/fetchAllGroups/{instance}","href":"/whatsapp/api-reference/group-controller/fetch-all-groups"},{"title":"Find Group Members","openapi":"openapi-whatsapp GET /group/participants/{instance}","href":"/whatsapp/api-reference/group-controller/find-participants"},{"title":"Update Group Members","openapi":"openapi-whatsapp POST /group/updateParticipant/{instance}","href":"/whatsapp/api-reference/group-controller/update-participant"},{"title":"Update Group Setting","openapi":"openapi-whatsapp POST /group/updateSetting/{instance}","href":"/whatsapp/api-reference/group-controller/update-setting"},{"title":"Toggle Ephemeral","openapi":"openapi-whatsapp POST /group/toggleEphemeral/{instance}","href":"/whatsapp/api-reference/group-controller/toggle-ephemeral"},{"title":"Leave Group","openapi":"openapi-whatsapp DELETE /group/leaveGroup/{instance}","href":"/whatsapp/api-reference/group-controller/leave-group"}]},{"group":"Websocket","pages":[{"title":"Set Websocket","openapi":"openapi-whatsapp POST /websocket/set/{instance}","href":"/whatsapp/api-reference/integrations/websocket/set-websocket"},{"title":"Find Websocket","openapi":"openapi-whatsapp GET /websocket/find/{instance}","href":"/whatsapp/api-reference/integrations/websocket/find-websocket"}]}]}]}]},"title":"Create Instance - l2msg Documentation","buildId":"dpl_2xiSHD9XEvLsPGPcfoMtkLTB3dy9","deploymentId":"dpl_2xiSHD9XEvLsPGPcfoMtkLTB3dy9","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DmVyH30O.js","utils-BHQqGGOd.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-CD-E4BIt.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Bp5Lq9Ds.js","snippetPresets-C4xAVCFP.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CgXVLxUC.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BF8I5oUf.js","shallow-Byd0lWnC.js","getApiPlaygroundDisplay-BGOZG1OK.js","CodeSnippet-CpvQL0CY.js","CodeSnippets-B8wkBKXa.js","Page-CBCH2P7b.js","getPastedJson-Ry3scI3Y.js","icon-D7a9HcdD.js","MethodPill-CJ8pmHhz.js","DuplicateIcon-rh1HJF0t.js","createIcon-DvGznqYs.js","DynamicMarkdown-Cc6AuSHS.js","SectionHeading-B4A0S-ep.js","axios-vUo_bRtp.js","Markdown-Cc16CX65.js","clsx-Cs6nMGht.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-zbf22OZA.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-C_fs-y5n.js"]}