l2msg API whatsapp is a robust platform dedicated to empowering small businesses, entrepreneurs, freelancers, and individuals,
going beyond a simple messaging solution via WhatsApp™.Our mission is to provide a comprehensive API that enables these groups to strengthen their businesses, whether locally or online, by integrating with multiple platforms and services.Visit our website.
Installation
Learn how to use:
API Documentation
View the API documentation with code examples
{"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":""},"entitlements":{},"buildId":"6ae924246d1bf6cfff60bda1:success","clientVersion":"0.0.4128","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":"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":"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":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"whatsapp/en/get-started/introduction","slug":"/whatsapp/en/get-started/introduction","pageMetadata":{"sidebarTitle":"Introduction","title":"Introduction","icon":"hand-wave","description":null,"href":"/whatsapp/en/get-started/introduction","hidden":false},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,p:`p`,strong:`strong`,..._provideComponents(),...props.components},{Card,CardGroup,Heading}=_components;if(!Card)_missingMdxReference(`Card`,true);if(!CardGroup)_missingMdxReference(`CardGroup`,true);if(!Heading)_missingMdxReference(`Heading`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`l2msg API whatsapp`}),` is a robust platform dedicated to empowering small businesses, entrepreneurs, freelancers, and individuals,\ngoing beyond a simple messaging solution via `,_jsx(_components.strong,{children:`WhatsApp™`}),`.`]}),`\n`,_jsxs(_components.p,{children:[`Our mission is to provide a comprehensive API that enables these groups to strengthen their businesses, whether locally or online, by integrating with `,_jsx(_components.strong,{children:`multiple platforms and services`}),`.`]}),`\n`,_jsxs(_components.p,{children:[`Visit our `,_jsx(_components.a,{href:`https://l2msg.com`,children:`website`}),`.`]}),`\n`,_jsx(Heading,{level:`2`,id:`installation`,children:`Installation`}),`\n`,_jsx(_components.p,{children:`Learn how to use:`}),`\n`,_jsx(CardGroup,{cols:2,children:_jsx(Card,{title:`API Documentation`,icon:`book`,href:`/whatsapp/api-reference`,children:_jsx(_components.p,{children:`View the API documentation with code examples`})})})]})}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":{"sidebarTitle":"Introduction","title":"Introduction","icon":"hand-wave","description":null,"href":"/whatsapp/en/get-started/introduction","hidden":false}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Installation","slug":"installation","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"subdomain":"l2msg","siteName":"l2msg Documentation","title":"Introduction - l2msg Documentation","navMaps":{"firstHrefInVersion":{"whatsapp":{"href":"/whatsapp/en/get-started/introduction","matchLevel":0}},"firstHrefInLanguage":{}},"lastModified":"2026-02-08T00:00:49.524Z","originalFileLocation":"whatsapp/en/get-started/introduction.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=\"Introduction - 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/en/get-started/introduction\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://l2msg.mintlify.site/_mintlify/api/og/v2?division=Getting+Started\u0026amp;title=Introduction\u0026amp;theme=2eeffe45ed80af8f6a07bca8\u0026amp;signature=dec3cbd5fc090152717e1f391f5720c8bc266529bac8e1168a361eeb918a059e\">\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=\"Introduction - l2msg Documentation\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://l2msg.mintlify.site/_mintlify/api/og/v2?division=Getting+Started\u0026amp;title=Introduction\u0026amp;theme=2eeffe45ed80af8f6a07bca8\u0026amp;signature=dec3cbd5fc090152717e1f391f5720c8bc266529bac8e1168a361eeb918a059e\">\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/en/get-started/introduction\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/whatsapp/en/get-started/introduction.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/en/get-started/introduction#webpage\",\"url\":\"https://docs.l2msg.com/whatsapp/en/get-started/introduction\",\"name\":\"Introduction\",\"dateModified\":\"2026-02-08T00:00:49.524Z\",\"isPartOf\":{\"@id\":\"https://docs.l2msg.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.l2msg.com/whatsapp/en/get-started/introduction#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.l2msg.com/whatsapp/en/get-started/introduction#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"l2msg Documentation\",\"item\":\"https://docs.l2msg.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Introduction\",\"item\":\"https://docs.l2msg.com/whatsapp/en/get-started/introduction\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.l2msg.com/whatsapp/en/get-started/introduction#article\",\"headline\":\"Introduction\",\"name\":\"Introduction\",\"url\":\"https://docs.l2msg.com/whatsapp/en/get-started/introduction\",\"mainEntityOfPage\":{\"@id\":\"https://docs.l2msg.com/whatsapp/en/get-started/introduction#webpage\"},\"dateModified\":\"2026-02-08T00:00:49.524Z\",\"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\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"l2msg Documentation\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/whatsapp/en/get-started/introduction.md","siteName":"l2msg Documentation","nav":{"global":null,"versions":[{"version":"whatsapp","tabs":[{"tab":"English","groups":[{"group":"Getting Started","pages":[{"sidebarTitle":"Introduction","title":"Introduction","icon":"hand-wave","href":"/whatsapp/en/get-started/introduction"},{"group":"Integrations","icon":"toolbox","pages":[{"group":"Events","icon":"calendar","pages":[{"title":"WebSocket","icon":"plug","description":null,"href":"/whatsapp/en/integrations/websocket"},{"title":"Webhooks","icon":"webhook","href":"/whatsapp/en/integrations/webhooks"}]}]},{"group":"Configuration","icon":"wrench","pages":[{"title":"Available Features","icon":"wrench","href":"/whatsapp/en/configuration/available-resources"}]}]}]},{"tab":"Português","pages":[{"title":"Português","href":"/whatsapp/pt/get-started/introduction"}]},{"tab":"API","pages":[{"title":"API","href":"/whatsapp/api-reference/get-information"}]}]}]},"basePath":"","title":"Introduction - l2msg Documentation","buildId":"dpl_5tKr6cUUeuVJdEZ9JAEY3h4soMJ8","deploymentId":"dpl_5tKr6cUUeuVJdEZ9JAEY3h4soMJ8","dynamics":[],"chunks":[]}