A session is a WhatsApp number managed by D-API. Use type: "unofficial" for unofficial WhatsApp (via QR code) or type: "cloud_api"
for the Official API.You can set the webhookUrl at creation time to receive events in real
time (messages, status, connection). See the webhooks
documentation.
Choose a stable, unique sessionId per number — it is used in
virtually every other endpoint.
Authorizations
Authorization
string
header
required
API Key for authentication. Format: <API_KEY>
Body
application/json
sessionId
string
required
Connection identifier you choose. Use the same value in the other routes.
Minimum string length: 1
connectionMode
enum<string>
default:qr
How to pair the number: qr (QR code) or pair (pairing code).
Available options:
qr,
pair
pairPhone
string
Number to pair, with country code, digits only. Required when connectionMode is pair.
webhookUrl
string
URL that receives the connection's events (messages, statuses, calls).
webhookConfig
object
Which events the webhook receives and at which URL. A missing event or one with enabled: false is not sent.
Show child attributes
ignoreGroups
boolean
default:true
Doesn't send events for group messages.
ignoreStatus
boolean
default:true
Doesn't send status (stories) events.
historySync
boolean
default:false
Syncs the device's chat history on connect.
receiveCalls
boolean
default:false
Receives calls made to the number (call.offer events) to answer or reject through the API.
Response
200
Successful response
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"D-API","colors":{"primary":"#00B7CD","light":"#2DD4E0","dark":"#0E8FA3"},"logo":{"light":"https://mintcdn.com/d-api/dcX-Hd4-QsKLE866/logo/dapi-horizontal.png?fit=max\u0026auto=format\u0026n=dcX-Hd4-QsKLE866\u0026q=85\u0026s=449901bb5b53e11232d03fd1fa54a4c3","dark":"https://mintcdn.com/d-api/dcX-Hd4-QsKLE866/logo/dapi-horizontal.png?fit=max\u0026auto=format\u0026n=dcX-Hd4-QsKLE866\u0026q=85\u0026s=449901bb5b53e11232d03fd1fa54a4c3"},"favicon":"https://mintcdn.com/d-api/dcX-Hd4-QsKLE866/favicon.png?fit=max\u0026auto=format\u0026n=dcX-Hd4-QsKLE866\u0026q=85\u0026s=a2b2d31d3ad7ea89d6d82db7f17b2b07","navbar":{"links":[{"href":"https://wa.me/5551920018823?text=Ol%C3%A1%2C%20preciso%20de%20ajuda%20com%20a%20documenta%C3%A7%C3%A3o%20da%20D-API","label":"Suporte"}],"primary":{"type":"button","label":"Painel","href":"https://app.d-api.cloud"}},"footer":{"links":[{"header":"D-API","items":[{"label":"Painel","href":"https://app.d-api.cloud"},{"label":"Suporte","href":"https://wa.me/5551920018823?text=Ol%C3%A1%2C%20preciso%20de%20ajuda%20com%20a%20documenta%C3%A7%C3%A3o%20da%20D-API"}]}]},"contextual":{"options":["copy","view","chatgpt","claude","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"languages":[{"language":"pt-BR","default":true,"href":"whatsapp/introducao"},{"language":"en","footer":{"links":[{"header":"D-API","items":[{"label":"Dashboard","href":"https://app.d-api.cloud"},{"label":"Support","href":"https://wa.me/5551920018823?text=Hi%2C%20I%20need%20help%20with%20the%20D-API%20documentation"}]}]},"navbar":{"links":[{"href":"https://wa.me/5551920018823?text=Hi%2C%20I%20need%20help%20with%20the%20D-API%20documentation","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.d-api.cloud"}},"href":"en/whatsapp/introducao"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"d-api","hasAudioNarration":false,"actualSubdomain":"d-api","customDomains":["docs.d-api.cloud"],"gitSource":{"type":"github","owner":"joaoartur","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"entitlements":{},"buildId":"6af87e0a4fd4397144dfd711","clientVersion":"0.0.4177","searchFilterCounts":[{"language":"pt-BR","tag":"API Reference","count":140},{"language":"en","tag":"API Reference","count":140},{"language":"pt-BR","tag":"Sessões","count":27},{"language":"en","tag":"Sessions","count":27},{"language":"pt-BR","tag":"Ligações","count":17},{"language":"pt-BR","tag":"WhatsApp","count":17},{"language":"en","tag":"Calls","count":17},{"language":"en","tag":"WhatsApp","count":17},{"language":"pt-BR","tag":"Grupos","count":15},{"language":"pt-BR","tag":"Conversas","count":15},{"language":"en","tag":"Groups","count":15},{"language":"en","tag":"Chats","count":15},{"language":"pt-BR","tag":"Webhooks","count":14},{"language":"en","tag":"Webhooks","count":14},{"language":"pt-BR","tag":"API Oficial (Cloud API)","count":11},{"language":"pt-BR","tag":"Mensagens","count":11},{"language":"en","tag":"Official API (Cloud API)","count":11},{"language":"en","tag":"Messages","count":11},{"language":"pt-BR","tag":"Catálogo","count":9},{"language":"en","tag":"Catalog","count":9}]},"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":"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":"en/api-reference/endpoints/criar-sessao","slug":"/en/api-reference/endpoints/criar-sessao","pageMetadata":{"title":"Create a session","description":"Create or start a WhatsApp session.","openapi":"api-reference/openapi.en.json POST /api/v1/sessions","href":"/en/api-reference/endpoints/criar-sessao"},"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 or start a WhatsApp session.\"\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={a:`a`,code:`code`,p:`p`,strong:`strong`,..._provideComponents(),...props.components},{Tip}=_components;if(!Tip)_missingMdxReference(`Tip`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`A `,_jsx(_components.strong,{children:`session`}),` is a WhatsApp number managed by D-API. Use `,_jsx(_components.code,{children:`type: \"unofficial\"`}),` for unofficial WhatsApp (via QR code) or `,_jsx(_components.code,{children:`type: \"cloud_api\"`}),`\nfor the Official API.`]}),`\n`,_jsxs(_components.p,{children:[`You can set the `,_jsx(_components.code,{children:`webhookUrl`}),` at creation time to receive events in real\ntime (messages, status, connection). See the `,_jsx(_components.a,{href:`/en/whatsapp/webhooks/visao-geral`,children:`webhooks\ndocumentation`}),`.`]}),`\n`,_jsx(Tip,{children:_jsxs(_components.p,{children:[`Choose a stable, unique `,_jsx(_components.code,{children:`sessionId`}),` per number — it is used in\nvirtually every other endpoint.`]})})]})}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 a session","description":"Create or start a WhatsApp session.","openapi":"api-reference/openapi.en.json POST /api/v1/sessions","href":"/en/api-reference/endpoints/criar-sessao"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"parameters":[],"operationId":"postApiV1Sessions","tags":["Sessions"],"summary":"Create or start a WhatsApp session","description":"Create or start a WhatsApp session.","requestBody":"3dcdb15e-19dd-49d2-bb14-bb1f64ccf858","responses":{"200":"1170a2e3-5b27-4cc9-9f04-d6dcb079ff72"},"method":"post","type":"path","servers":["30dcbd30-46ac-41fc-9f05-b51acbf83285"],"security":["29ca4a19-6992-4b98-8548-87d175ab2453"],"path":"/api/v1/sessions","baseUrlOptions":["https://api.d-api.cloud"],"title":"Create or start a WhatsApp session","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["sessionId"],"properties":{"sessionId":{"type":"string","minLength":1,"description":"Connection identifier you choose. Use the same value in the other routes.","isRequired":true,"uniqueKey":"sessionId","typeLabel":"string"},"connectionMode":{"type":"string","enum":["qr","pair"],"default":"qr","description":"How to pair the number: `qr` (QR code) or `pair` (pairing code).","uniqueKey":"connectionMode","typeLabel":"enum\u003cstring>"},"pairPhone":{"type":"string","description":"Number to pair, with country code, digits only. Required when `connectionMode` is `pair`.","uniqueKey":"pairPhone","typeLabel":"string"},"webhookUrl":{"type":"string","description":"URL that receives the connection's events (messages, statuses, calls).","uniqueKey":"webhookUrl","typeLabel":"string"},"webhookConfig":{"type":"object","required":["enabled","type","events"],"description":"Which events the webhook receives and at which URL. A missing event or one with `enabled: false` is not sent.","properties":{"enabled":{"type":"boolean","description":"Turns on event delivery by webhook.","isRequired":true,"uniqueKey":"webhookConfig.enabled","typeLabel":"boolean"},"type":{"type":"string","enum":["single","per_event"],"description":"`single`: every event goes to the same URL. `per_event`: each event has its own `webhookUrl`.","isRequired":true,"uniqueKey":"webhookConfig.type","typeLabel":"enum\u003cstring>"},"events":{"type":"object","description":"One entry per event type.","properties":{"messages.received":{"type":"object","description":"Message received.","required":["enabled","webhookUrl"],"properties":{"enabled":{"type":"boolean","isRequired":true,"uniqueKey":"webhookConfig.events.messages\\.received.enabled","typeLabel":"boolean"},"webhookUrl":{"type":"string","isRequired":true,"uniqueKey":"webhookConfig.events.messages\\.received.webhookUrl","typeLabel":"string"}},"uniqueKey":"webhookConfig.events.messages\\.received","typeLabel":"object"},"messages.sent":{"type":"object","description":"Message sent by the connection (API, panel or phone).","required":["enabled","webhookUrl"],"properties":{"enabled":{"type":"boolean","isRequired":true,"uniqueKey":"webhookConfig.events.messages\\.sent.enabled","typeLabel":"boolean"},"webhookUrl":{"type":"string","isRequired":true,"uniqueKey":"webhookConfig.events.messages\\.sent.webhookUrl","typeLabel":"string"}},"uniqueKey":"webhookConfig.events.messages\\.sent","typeLabel":"object"},"message.delivered":{"type":"object","description":"Message delivered to the recipient.","required":["enabled","webhookUrl"],"properties":{"enabled":{"type":"boolean","isRequired":true,"uniqueKey":"webhookConfig.events.message\\.delivered.enabled","typeLabel":"boolean"},"webhookUrl":{"type":"string","isRequired":true,"uniqueKey":"webhookConfig.events.message\\.delivered.webhookUrl","typeLabel":"string"}},"uniqueKey":"webhookConfig.events.message\\.delivered","typeLabel":"object"},"message.read":{"type":"object","description":"Message read by the recipient.","required":["enabled","webhookUrl"],"properties":{"enabled":{"type":"boolean","isRequired":true,"uniqueKey":"webhookConfig.events.message\\.read.enabled","typeLabel":"boolean"},"webhookUrl":{"type":"string","isRequired":true,"uniqueKey":"webhookConfig.events.message\\.read.webhookUrl","typeLabel":"string"}},"uniqueKey":"webhookConfig.events.message\\.read","typeLabel":"object"},"message.update":{"type":"object","description":"Message edited or status changed.","required":["enabled","webhookUrl"],"properties":{"enabled":{"type":"boolean","isRequired":true,"uniqueKey":"webhookConfig.events.message\\.update.enabled","typeLabel":"boolean"},"webhookUrl":{"type":"string","isRequired":true,"uniqueKey":"webhookConfig.events.message\\.update.webhookUrl","typeLabel":"string"}},"uniqueKey":"webhookConfig.events.message\\.update","typeLabel":"object"},"message.deleted":{"type":"object","description":"Message deleted.","required":["enabled","webhookUrl"],"properties":{"enabled":{"type":"boolean","isRequired":true,"uniqueKey":"webhookConfig.events.message\\.deleted.enabled","typeLabel":"boolean"},"webhookUrl":{"type":"string","isRequired":true,"uniqueKey":"webhookConfig.events.message\\.deleted.webhookUrl","typeLabel":"string"}},"uniqueKey":"webhookConfig.events.message\\.deleted","typeLabel":"object"},"contacts.upsert":{"type":"object","description":"New contact.","required":["enabled","webhookUrl"],"properties":{"enabled":{"type":"boolean","isRequired":true,"uniqueKey":"webhookConfig.events.contacts\\.upsert.enabled","typeLabel":"boolean"},"webhookUrl":{"type":"string","isRequired":true,"uniqueKey":"webhookConfig.events.contacts\\.upsert.webhookUrl","typeLabel":"string"}},"uniqueKey":"webhookConfig.events.contacts\\.upsert","typeLabel":"object"},"contacts.update":{"type":"object","description":"Contact updated (name, picture).","required":["enabled","webhookUrl"],"properties":{"enabled":{"type":"boolean","isRequired":true,"uniqueKey":"webhookConfig.events.contacts\\.update.enabled","typeLabel":"boolean"},"webhookUrl":{"type":"string","isRequired":true,"uniqueKey":"webhookConfig.events.contacts\\.update.webhookUrl","typeLabel":"string"}},"uniqueKey":"webhookConfig.events.contacts\\.update","typeLabel":"object"},"chats.upsert":{"type":"object","description":"New chat.","required":["enabled","webhookUrl"],"properties":{"enabled":{"type":"boolean","isRequired":true,"uniqueKey":"webhookConfig.events.chats\\.upsert.enabled","typeLabel":"boolean"},"webhookUrl":{"type":"string","isRequired":true,"uniqueKey":"webhookConfig.events.chats\\.upsert.webhookUrl","typeLabel":"string"}},"uniqueKey":"webhookConfig.events.chats\\.upsert","typeLabel":"object"},"chats.update":{"type":"object","description":"Chat updated (archived, pinned, muted).","required":["enabled","webhookUrl"],"properties":{"enabled":{"type":"boolean","isRequired":true,"uniqueKey":"webhookConfig.events.chats\\.update.enabled","typeLabel":"boolean"},"webhookUrl":{"type":"string","isRequired":true,"uniqueKey":"webhookConfig.events.chats\\.update.webhookUrl","typeLabel":"string"}},"uniqueKey":"webhookConfig.events.chats\\.update","typeLabel":"object"},"presence":{"type":"object","description":"Typing, recording audio, online.","required":["enabled","webhookUrl"],"properties":{"enabled":{"type":"boolean","isRequired":true,"uniqueKey":"webhookConfig.events.presence.enabled","typeLabel":"boolean"},"webhookUrl":{"type":"string","isRequired":true,"uniqueKey":"webhookConfig.events.presence.webhookUrl","typeLabel":"string"}},"uniqueKey":"webhookConfig.events.presence","typeLabel":"object"},"groups_participants.join":{"type":"object","description":"Participant joined the group.","required":["enabled","webhookUrl"],"properties":{"enabled":{"type":"boolean","isRequired":true,"uniqueKey":"webhookConfig.events.groups_participants\\.join.enabled","typeLabel":"boolean"},"webhookUrl":{"type":"string","isRequired":true,"uniqueKey":"webhookConfig.events.groups_participants\\.join.webhookUrl","typeLabel":"string"}},"uniqueKey":"webhookConfig.events.groups_participants\\.join","typeLabel":"object"},"groups_participants.leave":{"type":"object","description":"Participant left or was removed from the group.","required":["enabled","webhookUrl"],"properties":{"enabled":{"type":"boolean","isRequired":true,"uniqueKey":"webhookConfig.events.groups_participants\\.leave.enabled","typeLabel":"boolean"},"webhookUrl":{"type":"string","isRequired":true,"uniqueKey":"webhookConfig.events.groups_participants\\.leave.webhookUrl","typeLabel":"string"}},"uniqueKey":"webhookConfig.events.groups_participants\\.leave","typeLabel":"object"},"groups_participants.promote":{"type":"object","description":"Participant became admin.","required":["enabled","webhookUrl"],"properties":{"enabled":{"type":"boolean","isRequired":true,"uniqueKey":"webhookConfig.events.groups_participants\\.promote.enabled","typeLabel":"boolean"},"webhookUrl":{"type":"string","isRequired":true,"uniqueKey":"webhookConfig.events.groups_participants\\.promote.webhookUrl","typeLabel":"string"}},"uniqueKey":"webhookConfig.events.groups_participants\\.promote","typeLabel":"object"},"groups_participants.demote":{"type":"object","description":"Participant is no longer admin.","required":["enabled","webhookUrl"],"properties":{"enabled":{"type":"boolean","isRequired":true,"uniqueKey":"webhookConfig.events.groups_participants\\.demote.enabled","typeLabel":"boolean"},"webhookUrl":{"type":"string","isRequired":true,"uniqueKey":"webhookConfig.events.groups_participants\\.demote.webhookUrl","typeLabel":"string"}},"uniqueKey":"webhookConfig.events.groups_participants\\.demote","typeLabel":"object"},"group_participants.join-request":{"type":"object","description":"Request to join the group.","required":["enabled","webhookUrl"],"properties":{"enabled":{"type":"boolean","isRequired":true,"uniqueKey":"webhookConfig.events.group_participants\\.join-request.enabled","typeLabel":"boolean"},"webhookUrl":{"type":"string","isRequired":true,"uniqueKey":"webhookConfig.events.group_participants\\.join-request.webhookUrl","typeLabel":"string"}},"uniqueKey":"webhookConfig.events.group_participants\\.join-request","typeLabel":"object"},"group_participants.join-request.approved":{"type":"object","description":"Join request approved.","required":["enabled","webhookUrl"],"properties":{"enabled":{"type":"boolean","isRequired":true,"uniqueKey":"webhookConfig.events.group_participants\\.join-request\\.approved.enabled","typeLabel":"boolean"},"webhookUrl":{"type":"string","isRequired":true,"uniqueKey":"webhookConfig.events.group_participants\\.join-request\\.approved.webhookUrl","typeLabel":"string"}},"uniqueKey":"webhookConfig.events.group_participants\\.join-request\\.approved","typeLabel":"object"},"group_participants.join-request.revoked":{"type":"object","description":"Join request revoked.","required":["enabled","webhookUrl"],"properties":{"enabled":{"type":"boolean","isRequired":true,"uniqueKey":"webhookConfig.events.group_participants\\.join-request\\.revoked.enabled","typeLabel":"boolean"},"webhookUrl":{"type":"string","isRequired":true,"uniqueKey":"webhookConfig.events.group_participants\\.join-request\\.revoked.webhookUrl","typeLabel":"string"}},"uniqueKey":"webhookConfig.events.group_participants\\.join-request\\.revoked","typeLabel":"object"},"labels.edit":{"type":"object","description":"Label created, edited or deleted.","required":["enabled","webhookUrl"],"properties":{"enabled":{"type":"boolean","isRequired":true,"uniqueKey":"webhookConfig.events.labels\\.edit.enabled","typeLabel":"boolean"},"webhookUrl":{"type":"string","isRequired":true,"uniqueKey":"webhookConfig.events.labels\\.edit.webhookUrl","typeLabel":"string"}},"uniqueKey":"webhookConfig.events.labels\\.edit","typeLabel":"object"},"labels.association.chat":{"type":"object","description":"Label added to or removed from a chat.","required":["enabled","webhookUrl"],"properties":{"enabled":{"type":"boolean","isRequired":true,"uniqueKey":"webhookConfig.events.labels\\.association\\.chat.enabled","typeLabel":"boolean"},"webhookUrl":{"type":"string","isRequired":true,"uniqueKey":"webhookConfig.events.labels\\.association\\.chat.webhookUrl","typeLabel":"string"}},"uniqueKey":"webhookConfig.events.labels\\.association\\.chat","typeLabel":"object"},"labels.association.message":{"type":"object","description":"Label added to or removed from a message.","required":["enabled","webhookUrl"],"properties":{"enabled":{"type":"boolean","isRequired":true,"uniqueKey":"webhookConfig.events.labels\\.association\\.message.enabled","typeLabel":"boolean"},"webhookUrl":{"type":"string","isRequired":true,"uniqueKey":"webhookConfig.events.labels\\.association\\.message.webhookUrl","typeLabel":"string"}},"uniqueKey":"webhookConfig.events.labels\\.association\\.message","typeLabel":"object"},"appstate.label.edit":{"type":"object","description":"Label changed (raw WhatsApp event).","required":["enabled","webhookUrl"],"properties":{"enabled":{"type":"boolean","isRequired":true,"uniqueKey":"webhookConfig.events.appstate\\.label\\.edit.enabled","typeLabel":"boolean"},"webhookUrl":{"type":"string","isRequired":true,"uniqueKey":"webhookConfig.events.appstate\\.label\\.edit.webhookUrl","typeLabel":"string"}},"uniqueKey":"webhookConfig.events.appstate\\.label\\.edit","typeLabel":"object"},"appstate.label.association.chat":{"type":"object","description":"Chat label (raw WhatsApp event).","required":["enabled","webhookUrl"],"properties":{"enabled":{"type":"boolean","isRequired":true,"uniqueKey":"webhookConfig.events.appstate\\.label\\.association\\.chat.enabled","typeLabel":"boolean"},"webhookUrl":{"type":"string","isRequired":true,"uniqueKey":"webhookConfig.events.appstate\\.label\\.association\\.chat.webhookUrl","typeLabel":"string"}},"uniqueKey":"webhookConfig.events.appstate\\.label\\.association\\.chat","typeLabel":"object"},"appstate.label.association.message":{"type":"object","description":"Message label (raw WhatsApp event).","required":["enabled","webhookUrl"],"properties":{"enabled":{"type":"boolean","isRequired":true,"uniqueKey":"webhookConfig.events.appstate\\.label\\.association\\.message.enabled","typeLabel":"boolean"},"webhookUrl":{"type":"string","isRequired":true,"uniqueKey":"webhookConfig.events.appstate\\.label\\.association\\.message.webhookUrl","typeLabel":"string"}},"uniqueKey":"webhookConfig.events.appstate\\.label\\.association\\.message","typeLabel":"object"},"appstate.agent.update":{"type":"object","description":"WhatsApp Business agent changed (raw event).","required":["enabled","webhookUrl"],"properties":{"enabled":{"type":"boolean","isRequired":true,"uniqueKey":"webhookConfig.events.appstate\\.agent\\.update.enabled","typeLabel":"boolean"},"webhookUrl":{"type":"string","isRequired":true,"uniqueKey":"webhookConfig.events.appstate\\.agent\\.update.webhookUrl","typeLabel":"string"}},"uniqueKey":"webhookConfig.events.appstate\\.agent\\.update","typeLabel":"object"},"history_sync":{"type":"object","description":"History sync progress (requires historySync).","required":["enabled","webhookUrl"],"properties":{"enabled":{"type":"boolean","isRequired":true,"uniqueKey":"webhookConfig.events.history_sync.enabled","typeLabel":"boolean"},"webhookUrl":{"type":"string","isRequired":true,"uniqueKey":"webhookConfig.events.history_sync.webhookUrl","typeLabel":"string"}},"uniqueKey":"webhookConfig.events.history_sync","typeLabel":"object"},"history.message.upsert":{"type":"object","description":"Message from the synced history.","required":["enabled","webhookUrl"],"properties":{"enabled":{"type":"boolean","isRequired":true,"uniqueKey":"webhookConfig.events.history\\.message\\.upsert.enabled","typeLabel":"boolean"},"webhookUrl":{"type":"string","isRequired":true,"uniqueKey":"webhookConfig.events.history\\.message\\.upsert.webhookUrl","typeLabel":"string"}},"uniqueKey":"webhookConfig.events.history\\.message\\.upsert","typeLabel":"object"},"history.message.received":{"type":"object","description":"Received message from the history.","required":["enabled","webhookUrl"],"properties":{"enabled":{"type":"boolean","isRequired":true,"uniqueKey":"webhookConfig.events.history\\.message\\.received.enabled","typeLabel":"boolean"},"webhookUrl":{"type":"string","isRequired":true,"uniqueKey":"webhookConfig.events.history\\.message\\.received.webhookUrl","typeLabel":"string"}},"uniqueKey":"webhookConfig.events.history\\.message\\.received","typeLabel":"object"},"history.messages.sent":{"type":"object","description":"Sent message from the history.","required":["enabled","webhookUrl"],"properties":{"enabled":{"type":"boolean","isRequired":true,"uniqueKey":"webhookConfig.events.history\\.messages\\.sent.enabled","typeLabel":"boolean"},"webhookUrl":{"type":"string","isRequired":true,"uniqueKey":"webhookConfig.events.history\\.messages\\.sent.webhookUrl","typeLabel":"string"}},"uniqueKey":"webhookConfig.events.history\\.messages\\.sent","typeLabel":"object"},"connection.qrcode":{"type":"object","description":"New QR code to pair.","required":["enabled","webhookUrl"],"properties":{"enabled":{"type":"boolean","isRequired":true,"uniqueKey":"webhookConfig.events.connection\\.qrcode.enabled","typeLabel":"boolean"},"webhookUrl":{"type":"string","isRequired":true,"uniqueKey":"webhookConfig.events.connection\\.qrcode.webhookUrl","typeLabel":"string"}},"uniqueKey":"webhookConfig.events.connection\\.qrcode","typeLabel":"object"},"connection.paircode":{"type":"object","description":"Pairing code (connectionMode pair).","required":["enabled","webhookUrl"],"properties":{"enabled":{"type":"boolean","isRequired":true,"uniqueKey":"webhookConfig.events.connection\\.paircode.enabled","typeLabel":"boolean"},"webhookUrl":{"type":"string","isRequired":true,"uniqueKey":"webhookConfig.events.connection\\.paircode.webhookUrl","typeLabel":"string"}},"uniqueKey":"webhookConfig.events.connection\\.paircode","typeLabel":"object"},"connection.status":{"type":"object","description":"Connection status changed (connected, disconnected).","required":["enabled","webhookUrl"],"properties":{"enabled":{"type":"boolean","isRequired":true,"uniqueKey":"webhookConfig.events.connection\\.status.enabled","typeLabel":"boolean"},"webhookUrl":{"type":"string","isRequired":true,"uniqueKey":"webhookConfig.events.connection\\.status.webhookUrl","typeLabel":"string"}},"uniqueKey":"webhookConfig.events.connection\\.status","typeLabel":"object"},"logged_out":{"type":"object","description":"The number was logged out from the device.","required":["enabled","webhookUrl"],"properties":{"enabled":{"type":"boolean","isRequired":true,"uniqueKey":"webhookConfig.events.logged_out.enabled","typeLabel":"boolean"},"webhookUrl":{"type":"string","isRequired":true,"uniqueKey":"webhookConfig.events.logged_out.webhookUrl","typeLabel":"string"}},"uniqueKey":"webhookConfig.events.logged_out","typeLabel":"object"},"call.offer":{"type":"object","description":"Incoming call ringing (requires receiveCalls).","required":["enabled","webhookUrl"],"properties":{"enabled":{"type":"boolean","isRequired":true,"uniqueKey":"webhookConfig.events.call\\.offer.enabled","typeLabel":"boolean"},"webhookUrl":{"type":"string","isRequired":true,"uniqueKey":"webhookConfig.events.call\\.offer.webhookUrl","typeLabel":"string"}},"uniqueKey":"webhookConfig.events.call\\.offer","typeLabel":"object"},"call.accepted":{"type":"object","description":"Incoming call answered on another device.","required":["enabled","webhookUrl"],"properties":{"enabled":{"type":"boolean","isRequired":true,"uniqueKey":"webhookConfig.events.call\\.accepted.enabled","typeLabel":"boolean"},"webhookUrl":{"type":"string","isRequired":true,"uniqueKey":"webhookConfig.events.call\\.accepted.webhookUrl","typeLabel":"string"}},"uniqueKey":"webhookConfig.events.call\\.accepted","typeLabel":"object"},"call.rejected":{"type":"object","description":"Incoming call rejected.","required":["enabled","webhookUrl"],"properties":{"enabled":{"type":"boolean","isRequired":true,"uniqueKey":"webhookConfig.events.call\\.rejected.enabled","typeLabel":"boolean"},"webhookUrl":{"type":"string","isRequired":true,"uniqueKey":"webhookConfig.events.call\\.rejected.webhookUrl","typeLabel":"string"}},"uniqueKey":"webhookConfig.events.call\\.rejected","typeLabel":"object"},"call.ringing":{"type":"object","description":"Placed call is ringing at the destination.","required":["enabled","webhookUrl"],"properties":{"enabled":{"type":"boolean","isRequired":true,"uniqueKey":"webhookConfig.events.call\\.ringing.enabled","typeLabel":"boolean"},"webhookUrl":{"type":"string","isRequired":true,"uniqueKey":"webhookConfig.events.call\\.ringing.webhookUrl","typeLabel":"string"}},"uniqueKey":"webhookConfig.events.call\\.ringing","typeLabel":"object"},"call.connected":{"type":"object","description":"Call answered, audio live.","required":["enabled","webhookUrl"],"properties":{"enabled":{"type":"boolean","isRequired":true,"uniqueKey":"webhookConfig.events.call\\.connected.enabled","typeLabel":"boolean"},"webhookUrl":{"type":"string","isRequired":true,"uniqueKey":"webhookConfig.events.call\\.connected.webhookUrl","typeLabel":"string"}},"uniqueKey":"webhookConfig.events.call\\.connected","typeLabel":"object"},"call.ended":{"type":"object","description":"Call ended.","required":["enabled","webhookUrl"],"properties":{"enabled":{"type":"boolean","isRequired":true,"uniqueKey":"webhookConfig.events.call\\.ended.enabled","typeLabel":"boolean"},"webhookUrl":{"type":"string","isRequired":true,"uniqueKey":"webhookConfig.events.call\\.ended.webhookUrl","typeLabel":"string"}},"uniqueKey":"webhookConfig.events.call\\.ended","typeLabel":"object"},"call.not_answered":{"type":"object","description":"Placed call was not answered.","required":["enabled","webhookUrl"],"properties":{"enabled":{"type":"boolean","isRequired":true,"uniqueKey":"webhookConfig.events.call\\.not_answered.enabled","typeLabel":"boolean"},"webhookUrl":{"type":"string","isRequired":true,"uniqueKey":"webhookConfig.events.call\\.not_answered.webhookUrl","typeLabel":"string"}},"uniqueKey":"webhookConfig.events.call\\.not_answered","typeLabel":"object"},"call.audio":{"type":"object","description":"Call audio chunks (high volume; enable only to record).","required":["enabled","webhookUrl"],"properties":{"enabled":{"type":"boolean","isRequired":true,"uniqueKey":"webhookConfig.events.call\\.audio.enabled","typeLabel":"boolean"},"webhookUrl":{"type":"string","isRequired":true,"uniqueKey":"webhookConfig.events.call\\.audio.webhookUrl","typeLabel":"string"}},"uniqueKey":"webhookConfig.events.call\\.audio","typeLabel":"object"}},"isRequired":true,"uniqueKey":"webhookConfig.events","typeLabel":"object"}},"uniqueKey":"webhookConfig","typeLabel":"object"},"ignoreGroups":{"type":"boolean","default":true,"description":"Doesn't send events for group messages.","uniqueKey":"ignoreGroups","typeLabel":"boolean"},"ignoreStatus":{"type":"boolean","default":true,"description":"Doesn't send status (stories) events.","uniqueKey":"ignoreStatus","typeLabel":"boolean"},"historySync":{"type":"boolean","default":false,"description":"Syncs the device's chat history on connect.","uniqueKey":"historySync","typeLabel":"boolean"},"receiveCalls":{"type":"boolean","default":false,"description":"Receives calls made to the number (`call.offer` events) to answer or reject through the API.","uniqueKey":"receiveCalls","typeLabel":"boolean"}},"uniqueKey":"","typeLabel":"object"},"example":{"sessionId":"teste-12345","connectionMode":"qr","webhookUrl":"https://seu.webhook.com","webhookConfig":{"enabled":true,"type":"single","events":{"messages.received":{"enabled":true,"webhookUrl":"https://seu.webhook.com"},"messages.sent":{"enabled":true,"webhookUrl":"https://seu.webhook.com"},"message.delivered":{"enabled":true,"webhookUrl":"https://seu.webhook.com"},"message.read":{"enabled":true,"webhookUrl":"https://seu.webhook.com"},"message.update":{"enabled":true,"webhookUrl":"https://seu.webhook.com"},"message.deleted":{"enabled":true,"webhookUrl":"https://seu.webhook.com"},"contacts.upsert":{"enabled":true,"webhookUrl":"https://seu.webhook.com"},"contacts.update":{"enabled":true,"webhookUrl":"https://seu.webhook.com"},"chats.upsert":{"enabled":true,"webhookUrl":"https://seu.webhook.com"},"chats.update":{"enabled":true,"webhookUrl":"https://seu.webhook.com"},"presence":{"enabled":true,"webhookUrl":"https://seu.webhook.com"},"groups_participants.join":{"enabled":true,"webhookUrl":"https://seu.webhook.com"},"groups_participants.leave":{"enabled":true,"webhookUrl":"https://seu.webhook.com"},"groups_participants.promote":{"enabled":true,"webhookUrl":"https://seu.webhook.com"},"groups_participants.demote":{"enabled":true,"webhookUrl":"https://seu.webhook.com"},"group_participants.join-request":{"enabled":true,"webhookUrl":"https://seu.webhook.com"},"group_participants.join-request.approved":{"enabled":true,"webhookUrl":"https://seu.webhook.com"},"group_participants.join-request.revoked":{"enabled":true,"webhookUrl":"https://seu.webhook.com"},"labels.edit":{"enabled":true,"webhookUrl":"https://seu.webhook.com"},"labels.association.chat":{"enabled":true,"webhookUrl":"https://seu.webhook.com"},"labels.association.message":{"enabled":true,"webhookUrl":"https://seu.webhook.com"},"appstate.label.edit":{"enabled":false,"webhookUrl":"https://seu.webhook.com"},"appstate.label.association.chat":{"enabled":false,"webhookUrl":"https://seu.webhook.com"},"appstate.label.association.message":{"enabled":false,"webhookUrl":"https://seu.webhook.com"},"appstate.agent.update":{"enabled":false,"webhookUrl":"https://seu.webhook.com"},"history_sync":{"enabled":true,"webhookUrl":"https://seu.webhook.com"},"history.message.upsert":{"enabled":false,"webhookUrl":"https://seu.webhook.com"},"history.message.received":{"enabled":false,"webhookUrl":"https://seu.webhook.com"},"history.messages.sent":{"enabled":false,"webhookUrl":"https://seu.webhook.com"},"connection.qrcode":{"enabled":true,"webhookUrl":"https://seu.webhook.com"},"connection.paircode":{"enabled":true,"webhookUrl":"https://seu.webhook.com"},"connection.status":{"enabled":true,"webhookUrl":"https://seu.webhook.com"},"logged_out":{"enabled":true,"webhookUrl":"https://seu.webhook.com"},"call.offer":{"enabled":true,"webhookUrl":"https://seu.webhook.com"},"call.accepted":{"enabled":true,"webhookUrl":"https://seu.webhook.com"},"call.rejected":{"enabled":true,"webhookUrl":"https://seu.webhook.com"},"call.ringing":{"enabled":true,"webhookUrl":"https://seu.webhook.com"},"call.connected":{"enabled":true,"webhookUrl":"https://seu.webhook.com"},"call.ended":{"enabled":true,"webhookUrl":"https://seu.webhook.com"},"call.not_answered":{"enabled":true,"webhookUrl":"https://seu.webhook.com"},"call.audio":{"enabled":false,"webhookUrl":"https://seu.webhook.com"}}},"ignoreGroups":true,"ignoreStatus":true,"historySync":true},"examples":{"Example":{"title":"Example","value":{"sessionId":"teste-12345","connectionMode":"qr","webhookUrl":"https://seu.webhook.com","webhookConfig":{"enabled":true,"type":"single","events":{"messages.received":{"enabled":true,"webhookUrl":"https://seu.webhook.com"},"messages.sent":{"enabled":true,"webhookUrl":"https://seu.webhook.com"},"message.delivered":{"enabled":true,"webhookUrl":"https://seu.webhook.com"},"message.read":{"enabled":true,"webhookUrl":"https://seu.webhook.com"},"message.update":{"enabled":true,"webhookUrl":"https://seu.webhook.com"},"message.deleted":{"enabled":true,"webhookUrl":"https://seu.webhook.com"},"contacts.upsert":{"enabled":true,"webhookUrl":"https://seu.webhook.com"},"contacts.update":{"enabled":true,"webhookUrl":"https://seu.webhook.com"},"chats.upsert":{"enabled":true,"webhookUrl":"https://seu.webhook.com"},"chats.update":{"enabled":true,"webhookUrl":"https://seu.webhook.com"},"presence":{"enabled":true,"webhookUrl":"https://seu.webhook.com"},"groups_participants.join":{"enabled":true,"webhookUrl":"https://seu.webhook.com"},"groups_participants.leave":{"enabled":true,"webhookUrl":"https://seu.webhook.com"},"groups_participants.promote":{"enabled":true,"webhookUrl":"https://seu.webhook.com"},"groups_participants.demote":{"enabled":true,"webhookUrl":"https://seu.webhook.com"},"group_participants.join-request":{"enabled":true,"webhookUrl":"https://seu.webhook.com"},"group_participants.join-request.approved":{"enabled":true,"webhookUrl":"https://seu.webhook.com"},"group_participants.join-request.revoked":{"enabled":true,"webhookUrl":"https://seu.webhook.com"},"labels.edit":{"enabled":true,"webhookUrl":"https://seu.webhook.com"},"labels.association.chat":{"enabled":true,"webhookUrl":"https://seu.webhook.com"},"labels.association.message":{"enabled":true,"webhookUrl":"https://seu.webhook.com"},"appstate.label.edit":{"enabled":false,"webhookUrl":"https://seu.webhook.com"},"appstate.label.association.chat":{"enabled":false,"webhookUrl":"https://seu.webhook.com"},"appstate.label.association.message":{"enabled":false,"webhookUrl":"https://seu.webhook.com"},"appstate.agent.update":{"enabled":false,"webhookUrl":"https://seu.webhook.com"},"history_sync":{"enabled":true,"webhookUrl":"https://seu.webhook.com"},"history.message.upsert":{"enabled":false,"webhookUrl":"https://seu.webhook.com"},"history.message.received":{"enabled":false,"webhookUrl":"https://seu.webhook.com"},"history.messages.sent":{"enabled":false,"webhookUrl":"https://seu.webhook.com"},"connection.qrcode":{"enabled":true,"webhookUrl":"https://seu.webhook.com"},"connection.paircode":{"enabled":true,"webhookUrl":"https://seu.webhook.com"},"connection.status":{"enabled":true,"webhookUrl":"https://seu.webhook.com"},"logged_out":{"enabled":true,"webhookUrl":"https://seu.webhook.com"},"call.offer":{"enabled":true,"webhookUrl":"https://seu.webhook.com"},"call.accepted":{"enabled":true,"webhookUrl":"https://seu.webhook.com"},"call.rejected":{"enabled":true,"webhookUrl":"https://seu.webhook.com"},"call.ringing":{"enabled":true,"webhookUrl":"https://seu.webhook.com"},"call.connected":{"enabled":true,"webhookUrl":"https://seu.webhook.com"},"call.ended":{"enabled":true,"webhookUrl":"https://seu.webhook.com"},"call.not_answered":{"enabled":true,"webhookUrl":"https://seu.webhook.com"},"call.audio":{"enabled":false,"webhookUrl":"https://seu.webhook.com"}}},"ignoreGroups":true,"ignoreStatus":true,"historySync":true}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"1170a2e3-5b27-4cc9-9f04-d6dcb079ff72":{"description":"Successful response","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}}},"security":{"29ca4a19-6992-4b98-8548-87d175ab2453":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"API Key for authentication. Format: \u003cAPI_KEY>","scopes":[],"schemeName":"ApiKeyAuth"}}},"servers":{"30dcbd30-46ac-41fc-9f05-b51acbf83285":{"url":"https://api.d-api.cloud","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"Authorization","description":"API Key for authentication. Format: \u003cAPI_KEY>","scopes":[],"schemeName":"ApiKeyAuth"},"schema":{"title":"Authorization","type":"string","description":"API Key for authentication. Format: \u003cAPI_KEY>","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ApiKeyAuth","name":"Authorization"}],"title":"ApiKeyAuth"}]},"originalFileLocation":"api-reference/openapi.en.json"},"subdomain":"d-api","siteName":"D-API","title":"Create a session - D-API","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"pt-BR":{"href":"/api-reference/endpoints/criar-sessao","matchLevel":1},"en":{"href":"/en/api-reference/endpoints/criar-sessao","matchLevel":0}}},"lastModified":"2026-10-31T01:05:58.041Z","originalFileLocation":"en/api-reference/endpoints/criar-sessao.mdx","locale":"en"},"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 or start a WhatsApp session.\">\u003cmeta data-mint-head name=\"application-name\" content=\"D-API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/d-api/36SbMupri6RA-H0W/_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/d-api/36SbMupri6RA-H0W/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/d-api/36SbMupri6RA-H0W/_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/d-api/36SbMupri6RA-H0W/_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/d-api/36SbMupri6RA-H0W/_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/d-api/36SbMupri6RA-H0W/_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/d-api/36SbMupri6RA-H0W/_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/d-api/36SbMupri6RA-H0W/_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/d-api/36SbMupri6RA-H0W/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create a session - D-API\">\u003cmeta data-mint-head property=\"og:description\" content=\"Create or start a WhatsApp session.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"D-API\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.d-api.cloud/en/api-reference/endpoints/criar-sessao\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://d-api.mintlify.site/_mintlify/api/og/v2?division=Sessions\u0026amp;title=Create+a+session\u0026amp;description=Create+or+start+a+WhatsApp+session.\u0026amp;theme=6bf39124e553ea1529d3e32e\u0026amp;signature=617b5c1c84ac38b58bc0e6c2de819f091521a16f457ba8b5698ca0dcae095407\">\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 a session - D-API\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Create or start a WhatsApp session.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://d-api.mintlify.site/_mintlify/api/og/v2?division=Sessions\u0026amp;title=Create+a+session\u0026amp;description=Create+or+start+a+WhatsApp+session.\u0026amp;theme=6bf39124e553ea1529d3e32e\u0026amp;signature=617b5c1c84ac38b58bc0e6c2de819f091521a16f457ba8b5698ca0dcae095407\">\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/d-api/36SbMupri6RA-H0W/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"D-API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#00B7CD\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.d-api.cloud/en/api-reference/endpoints/criar-sessao\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/en/api-reference/endpoints/criar-sessao.md\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"en\" href=\"https://docs.d-api.cloud/en/api-reference/endpoints/criar-sessao\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"pt-BR\" href=\"https://docs.d-api.cloud/api-reference/endpoints/criar-sessao\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"x-default\" href=\"https://docs.d-api.cloud/api-reference/endpoints/criar-sessao\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.d-api.cloud/#organization\",\"name\":\"D-API\",\"url\":\"https://docs.d-api.cloud\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/d-api/dcX-Hd4-QsKLE866/logo/dapi-horizontal.png?fit=max\u0026auto=format\u0026n=dcX-Hd4-QsKLE866\u0026q=85\u0026s=449901bb5b53e11232d03fd1fa54a4c3\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.d-api.cloud#website\",\"name\":\"D-API\",\"url\":\"https://docs.d-api.cloud\",\"publisher\":{\"@id\":\"https://docs.d-api.cloud/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.d-api.cloud/en/api-reference/endpoints/criar-sessao#webpage\",\"url\":\"https://docs.d-api.cloud/en/api-reference/endpoints/criar-sessao\",\"name\":\"Create a session\",\"description\":\"Create or start a WhatsApp session.\",\"dateModified\":\"2026-10-31T01:05:58.041Z\",\"isPartOf\":{\"@id\":\"https://docs.d-api.cloud#website\"},\"breadcrumb\":{\"@id\":\"https://docs.d-api.cloud/en/api-reference/endpoints/criar-sessao#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.d-api.cloud/en/api-reference/endpoints/criar-sessao#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"D-API\",\"item\":\"https://docs.d-api.cloud\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create a session\",\"item\":\"https://docs.d-api.cloud/en/api-reference/endpoints/criar-sessao\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.d-api.cloud/en/api-reference/endpoints/criar-sessao#apireference\",\"headline\":\"Create a session\",\"name\":\"Create a session\",\"description\":\"Create or start a WhatsApp session.\",\"url\":\"https://docs.d-api.cloud/en/api-reference/endpoints/criar-sessao\",\"mainEntityOfPage\":{\"@id\":\"https://docs.d-api.cloud/en/api-reference/endpoints/criar-sessao#webpage\"},\"dateModified\":\"2026-10-31T01:05:58.041Z\",\"publisher\":{\"@id\":\"https://docs.d-api.cloud/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.d-api.cloud#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"D-API\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"D-API\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/en/api-reference/endpoints/criar-sessao.md","siteName":"D-API","nav":{"global":null,"languages":[{"language":"pt-BR","default":true,"pages":[{"title":"pt-BR","href":"/api-reference/endpoints/criar-sessao"}]},{"language":"en","footer":{"links":[{"header":"D-API","items":[{"label":"Dashboard","href":"https://app.d-api.cloud"},{"label":"Support","href":"https://wa.me/5551920018823?text=Hi%2C%20I%20need%20help%20with%20the%20D-API%20documentation"}]}]},"navbar":{"links":[{"href":"https://wa.me/5551920018823?text=Hi%2C%20I%20need%20help%20with%20the%20D-API%20documentation","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.d-api.cloud"}},"tabs":[{"tab":"WhatsApp","pages":[{"title":"WhatsApp","href":"/en/whatsapp/introducao"}]},{"tab":"Official API","pages":[{"title":"Official API","href":"/en/api-oficial/saas"}]},{"tab":"SMS","pages":[{"title":"SMS","href":"/en/sms/webhooks/visao-geral"}]},{"tab":"IVR","pages":[{"title":"IVR","href":"/en/ura/ligacoes/stream"}]},{"tab":"API Reference","groups":[{"group":"Getting started","pages":[{"title":"Introduction","href":"/en/api-reference/introduction"},{"title":"Quickstart","href":"/en/api-reference/quickstart"},{"title":"Returns basic information about the API","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json get /","href":"/api-reference/home/returns-basic-information-about-the-api"},{"title":"Returns the API health status, including DB, RabbitMQ and Redis","description":null,"deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json get /health","href":"/api-reference/home/returns-the-api-health-status-including-db-rabbitmq-and-redis"}]},{"group":"Sessions","pages":[{"title":"Create a session","openapi":"api-reference/openapi.en.json POST /api/v1/sessions","href":"/en/api-reference/endpoints/criar-sessao"},{"title":"Connect via QR code","description":"Get the QR code to connect the session to WhatsApp.","openapi":"api-reference/openapi.en.json GET /api/v1/sessions/{sessionId}/qr","href":"/en/api-reference/endpoints/conectar-qr"},{"title":"Generate migration code (OTP)","openapi":"api-reference/openapi.en.json POST /api/v1/sessions/{sessionId}/migration-otp","href":"/en/api-reference/endpoints/gerar-otp"},{"title":"List all sessions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json get /api/v1/sessions","href":"/api-reference/sessions/list-all-sessions"},{"title":"Session data","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json get /api/v1/sessions/{sessionId}","href":"/api-reference/sessions/session-data"},{"title":"Delete a session","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json delete /api/v1/sessions/{sessionId}","href":"/api-reference/sessions/delete-a-session"},{"title":"Session logs","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json get /api/v1/sessions/{sessionId}/logs","href":"/api-reference/sessions/session-logs"},{"title":"Update session webhook","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /api/v1/sessions/{sessionId}/webhook","href":"/api-reference/sessions/update-session-webhook"},{"title":"Save RabbitMQ settings","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /api/v1/sessions/{sessionId}/rabbitmq-config","href":"/api-reference/sessions/save-rabbitmq-settings"},{"title":"Save Webhook settings","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /api/v1/sessions/{sessionId}/webhook-config","href":"/api-reference/sessions/save-webhook-settings"},{"title":"Update message filters","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /api/v1/sessions/{sessionId}/ignore-settings","href":"/api-reference/sessions/update-message-filters"},{"title":"Update call settings","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /api/v1/sessions/{sessionId}/call-settings","href":"/api-reference/sessions/update-call-settings"},{"title":"Update automatic mark as read","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /api/v1/sessions/{sessionId}/mark-previous-as-read-settings","href":"/api-reference/sessions/update-automatic-mark-as-read"},{"title":"Update Brazil country code usage","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /api/v1/sessions/{sessionId}/assume-br-country-code-settings","href":"/api-reference/sessions/update-brazil-country-code-usage"},{"title":"Update message storage","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /api/v1/sessions/{sessionId}/disable-message-storage-settings","href":"/api-reference/sessions/update-message-storage"},{"title":"Update call receiving","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /api/v1/sessions/{sessionId}/receive-calls-settings","href":"/api-reference/sessions/update-call-receiving"},{"title":"Update command delivery mode","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /api/v1/sessions/{sessionId}/command-mode","href":"/api-reference/sessions/update-command-delivery-mode"},{"title":"Reconnect a session with pod restart","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json get /api/v1/sessions/{sessionId}/connect","href":"/api-reference/sessions/reconnect-a-session-with-pod-restart"},{"title":"Disconnect a session","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /api/v1/sessions/{sessionId}/disconnect","href":"/api-reference/sessions/disconnect-a-session"},{"title":"Passkey connect available?","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json get /api/v1/sessions/passkey/available","href":"/api-reference/sessions/passkey-connect-available?"},{"title":"Get a session's WebAuthn (passkey) challenge","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json get /api/v1/sessions/{sessionId}/auth/passkey","href":"/api-reference/sessions/get-a-sessions-webauthn-passkey-challenge"},{"title":"Submit a session's WebAuthn (passkey) signature","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /api/v1/sessions/{sessionId}/auth/passkey","href":"/api-reference/sessions/submit-a-sessions-webauthn-passkey-signature"},{"title":"Generate passkey fallback code (popup)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /api/v1/sessions/{sessionId}/auth/passkey/code","href":"/api-reference/sessions/generate-passkey-fallback-code-popup"},{"title":"Get a session's pairing code","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json get /api/v1/sessions/{sessionId}/pair-code","href":"/api-reference/sessions/get-a-sessions-pairing-code"},{"title":"Import migrated WhatsApp Web session","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /api/v1/sessions/{sessionId}/import-web-auth","href":"/api-reference/sessions/import-migrated-whatsapp-web-session"},{"title":"Get passkey challenge by code (popup fallback)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json get /api/v1/session-passkey/{code}","href":"/api-reference/sessions/get-passkey-challenge-by-code-popup-fallback"},{"title":"Submit passkey signature by code (popup fallback)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /api/v1/session-passkey/{code}","href":"/api-reference/sessions/submit-passkey-signature-by-code-popup-fallback"}]},{"group":"Migration","pages":[{"title":"Migrate WhatsApp Web session with single-use code","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /api/v1/session-migration/migrate","href":"/api-reference/migration/migrate-whatsapp-web-session-with-single-use-code"}]},{"group":"Messages","pages":[{"title":"Send text message","openapi":"api-reference/openapi.en.json POST /api/v1/messages/send/text","href":"/en/api-reference/endpoints/enviar-texto"},{"title":"Send image","openapi":"api-reference/openapi.en.json POST /api/v1/messages/send/image","href":"/en/api-reference/endpoints/enviar-imagem"},{"title":"Send video message","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /api/v1/messages/send/video","href":"/api-reference/messages/send-video-message"},{"title":"Send audio message","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /api/v1/messages/send/audio","href":"/api-reference/messages/send-audio-message"},{"title":"Send document message","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /api/v1/messages/send/document","href":"/api-reference/messages/send-document-message"},{"title":"Send sticker","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /api/v1/messages/send/sticker","href":"/api-reference/messages/send-sticker"},{"title":"Send location","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /api/v1/messages/send/location","href":"/api-reference/messages/send-location"},{"title":"Send contact","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /api/v1/messages/send/contact","href":"/api-reference/messages/send-contact"},{"title":"Send poll","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /api/v1/messages/send/poll","href":"/api-reference/messages/send-poll"},{"title":"Send reaction","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /api/v1/messages/send/reaction","href":"/api-reference/messages/send-reaction"},{"title":"Send album","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /api/v1/messages/send/album","href":"/api-reference/messages/send-album"}]},{"group":"Interactive messages","pages":[{"title":"Send list message","openapi":"api-reference/openapi.en.json POST /api/v1/interactive/send/list","href":"/en/api-reference/endpoints/enviar-lista"},{"title":"Send carousel message","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /api/v1/interactive/send/carousel","href":"/api-reference/interactive-messages/send-carousel-message"},{"title":"Send template message","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /api/v1/interactive/send/template","href":"/api-reference/interactive-messages/send-template-message"},{"title":"Send NativeFlow message (mobile only)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /api/v1/interactive/send/nativeflow","href":"/api-reference/interactive-messages/send-nativeflow-message-mobile-only"},{"title":"Send PIX button message","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /api/v1/interactive/send/pix","href":"/api-reference/interactive-messages/send-pix-button-message"}]},{"group":"Chats","pages":[{"title":"Edit message","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json put /api/v1/messages/{messageId}","href":"/api-reference/chat/edit-message"},{"title":"List a session's chats","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json get /api/v1/chats/","href":"/api-reference/chat/list-a-sessions-chats"},{"title":"Advanced chat search","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /api/v1/chats/search","href":"/api-reference/chat/advanced-chat-search"},{"title":"Advanced message search","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /api/v1/chats/messages/search","href":"/api-reference/chat/advanced-message-search"},{"title":"List a chat's messages (simplified)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json get /api/v1/chats/{chatId}/messages","href":"/api-reference/chat/list-a-chats-messages-simplified"},{"title":"Send presence","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /api/v1/chats/presence","href":"/api-reference/chat/send-presence"},{"title":"Mark as read","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /api/v1/chats/read","href":"/api-reference/chat/mark-as-read"},{"title":"Archive chat","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /api/v1/chats/archive","href":"/api-reference/chat/archive-chat"},{"title":"Pin chat","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /api/v1/chats/pin","href":"/api-reference/chat/pin-chat"},{"title":"Mute chat","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /api/v1/chats/mute","href":"/api-reference/chat/mute-chat"},{"title":"Mark chat as unread","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /api/v1/chats/mark-unread","href":"/api-reference/chat/mark-chat-as-unread"},{"title":"List archived chats","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json get /api/v1/chats/archived","href":"/api-reference/chat/list-archived-chats"},{"title":"List pinned chats","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json get /api/v1/chats/pinned","href":"/api-reference/chat/list-pinned-chats"},{"title":"Delete message","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json delete /api/v1/chats/messages/{messageId}","href":"/api-reference/chat/delete-message"},{"title":"Get chat details","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json get /api/v1/chats/{chatId}","href":"/api-reference/chat/get-chat-details"}]},{"group":"Contacts","pages":[{"title":"Get blocklist","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json get /api/v1/contacts/blocklist","href":"/api-reference/contacts/get-blocklist"},{"title":"Update blocklist","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /api/v1/contacts/blocklist","href":"/api-reference/contacts/update-blocklist"},{"title":"Report contact","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /api/v1/contacts/report","href":"/api-reference/contacts/report-contact"},{"title":"List contacts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json get /api/v1/contacts/","href":"/api-reference/contacts/list-contacts"},{"title":"Get contact info","openapi":"api-reference/openapi.en.json GET /api/v1/contacts/{phone}","href":"/en/api-reference/endpoints/obter-contato"},{"title":"Get user avatar","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json get /api/v1/contacts/{phone}/avatar","href":"/api-reference/contacts/get-user-avatar"},{"title":"Check users","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /api/v1/contacts/check","href":"/api-reference/contacts/check-users"},{"title":"Get user info","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /api/v1/contacts/getuser","href":"/api-reference/contacts/get-user-info"}]},{"group":"Groups","pages":[{"title":"Create group","openapi":"api-reference/openapi.en.json POST /api/v1/groups/create","href":"/en/api-reference/endpoints/criar-grupo"},{"title":"List groups","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json get /api/v1/groups/list","href":"/api-reference/groups/list-groups"},{"title":"Get group info","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json get /api/v1/groups/{groupId}/info","href":"/api-reference/groups/get-group-info"},{"title":"Manage group participants","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /api/v1/groups/{groupId}/participants","href":"/api-reference/groups/manage-group-participants"},{"title":"Join group","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /api/v1/groups/{groupId}/join","href":"/api-reference/groups/join-group"},{"title":"Leave group","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /api/v1/groups/{groupId}/leave","href":"/api-reference/groups/leave-group"},{"title":"Link a group to a community","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /api/v1/groups/{groupId}/link","href":"/api-reference/groups/link-a-group-to-a-community"},{"title":"Get group invite","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json get /api/v1/groups/{groupId}/invite","href":"/api-reference/groups/get-group-invite"},{"title":"Set group description","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json put /api/v1/groups/{groupId}/description","href":"/api-reference/groups/set-group-description"},{"title":"Set group name","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json put /api/v1/groups/{groupId}/name","href":"/api-reference/groups/set-group-name"},{"title":"Set group picture","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json put /api/v1/groups/{groupId}/profile-picture","href":"/api-reference/groups/set-group-picture"},{"title":"Set group privacy settings","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json put /api/v1/groups/{groupId}/settings","href":"/api-reference/groups/set-group-privacy-settings"},{"title":"Revoke group invite link","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /api/v1/groups/{groupId}/invite/revoke","href":"/api-reference/groups/revoke-group-invite-link"},{"title":"Approve group join requests","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /api/v1/groups/{groupId}/join-requests/approve","href":"/api-reference/groups/approve-group-join-requests"},{"title":"Reject group join requests","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /api/v1/groups/{groupId}/join-requests/reject","href":"/api-reference/groups/reject-group-join-requests"}]},{"group":"Labels","pages":[{"title":"Sync labels","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /api/v1/labels/sync","href":"/api-reference/labels/sync-labels"},{"title":"Create/edit label","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /api/v1/labels/upsert","href":"/api-reference/labels/createedit-label"},{"title":"Attach label to chat","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /api/v1/labels/attach","href":"/api-reference/labels/attach-label-to-chat"},{"title":"List labels","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json get /api/v1/labels/list","href":"/api-reference/labels/list-labels"},{"title":"List contact labels","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json get /api/v1/labels/contact-labels","href":"/api-reference/labels/list-contact-labels"}]},{"group":"Catalog","pages":[{"title":"List catalog products","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /api/v1/catalog/list","href":"/api-reference/catalog/list-catalog-products"},{"title":"List catalog collections","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /api/v1/catalog/collections/list","href":"/api-reference/catalog/list-catalog-collections"},{"title":"Get product by ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /api/v1/catalog/product/get","href":"/api-reference/catalog/get-product-by-id"},{"title":"Create product","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /api/v1/catalog/product/create","href":"/api-reference/catalog/create-product"},{"title":"Edit product","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /api/v1/catalog/product/edit","href":"/api-reference/catalog/edit-product"},{"title":"Delete product","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /api/v1/catalog/product/delete","href":"/api-reference/catalog/delete-product"},{"title":"Create collection","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /api/v1/catalog/collection/create","href":"/api-reference/catalog/create-collection"},{"title":"Edit collection","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /api/v1/catalog/collection/edit","href":"/api-reference/catalog/edit-collection"},{"title":"Delete collection","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /api/v1/catalog/collection/delete","href":"/api-reference/catalog/delete-collection"}]},{"group":"Channels (Newsletters)","pages":[{"title":"List newsletters","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json get /api/v1/newsletters/list","href":"/api-reference/newsletters/list-newsletters"},{"title":"Create newsletter","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /api/v1/newsletters/create","href":"/api-reference/newsletters/create-newsletter"}]},{"group":"Media","pages":[{"title":"Download media","openapi":"api-reference/openapi.en.json POST /api/v1/media/download","href":"/en/api-reference/endpoints/baixar-midia"}]},{"group":"History","pages":[{"title":"Sync history (bulk) via webhook in D-API format","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /api/v1/history/sync","href":"/api-reference/history/sync-history-bulk-via-webhook-in-d-api-format"},{"title":"Instance history sync (D-API) status","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json get /api/v1/history/sync/{sessionId}/status","href":"/api-reference/history/instance-history-sync-d-api-status"},{"title":"Request FULL HISTORY SYNC","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /api/v1/history/full-sync","href":"/api-reference/history/request-full-history-sync"},{"title":"Request HISTORY SYNC ON DEMAND","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /api/v1/history/on-demand","href":"/api-reference/history/request-history-sync-on-demand"}]},{"group":"Calls","pages":[{"title":"List recorded calls","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json get /api/v1/calls/","href":"/api-reference/calls/list-recorded-calls"},{"title":"Get recorded call by id","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json get /api/v1/calls/{callId}","href":"/api-reference/calls/get-recorded-call-by-id"},{"title":"Create WhatsApp call link","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /api/v1/calls/create-link","href":"/api-reference/calls/create-whatsapp-call-link"},{"title":"Send scheduled call message","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /api/v1/calls/send-event","href":"/api-reference/calls/send-scheduled-call-message"},{"title":"Place voice call","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /api/v1/calls/place","href":"/api-reference/calls/place-voice-call"},{"title":"Place live (stream) voice call","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /api/v1/calls/stream","href":"/api-reference/calls/place-live-stream-voice-call"},{"title":"Accept incoming call","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /api/v1/calls/accept","href":"/api-reference/calls/accept-incoming-call"},{"title":"Reject incoming call","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /api/v1/calls/reject","href":"/api-reference/calls/reject-incoming-call"},{"title":"End active voice call","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /api/v1/calls/end","href":"/api-reference/calls/end-active-voice-call"},{"title":"Mute or unmute call audio","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /api/v1/calls/mute","href":"/api-reference/calls/mute-or-unmute-call-audio"},{"title":"Get call state","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /api/v1/calls/state","href":"/api-reference/calls/get-call-state"}]},{"group":"Async commands","pages":[{"title":"Get async command","openapi":"api-reference/openapi.en.json GET /api/v1/commands/{commandId}","href":"/en/api-reference/endpoints/consultar-comando"},{"title":"Ordered async sending (sequential)","href":"/en/api-reference/endpoints/envio-sequencial"}]},{"group":"Voice agents","pages":[{"title":"Get call details","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json get /api/v1/voice-agent-calls/{callId}","href":"/api-reference/voice-agents/get-call-details"},{"title":"Call transcript (paginated)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json get /api/v1/voice-agent-calls/{callId}/turns","href":"/api-reference/voice-agents/call-transcript-paginated"},{"title":"Trigger an agent call (public trigger URL)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /api/v1/hooks/va/{token}","href":"/api-reference/voice-agents-—-triggers/trigger-an-agent-call-public-trigger-url"}]},{"group":"IVR calls","pages":[{"title":"Dispatch bulk IVR calls (audio or IVR flow)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /api/v1/voice/bulk","href":"/api-reference/ivr-calls/dispatch-bulk-ivr-calls-audio-or-ivr-flow"},{"title":"Dispatch an IVR call (audio or IVR flow)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /api/v1/voice/call","href":"/api-reference/ivr-calls/dispatch-an-ivr-call-audio-or-ivr-flow"},{"title":"Start a live IVR call (Smart Caller ID, 30/6 billing)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /api/v1/voice/live/start","href":"/api-reference/ivr-calls/start-a-live-ivr-call-smart-caller-id-306-billing"}]},{"group":"SMS","pages":[{"title":"Send an SMS","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /api/v1/sms/send","href":"/api-reference/sms/send-an-sms"},{"title":"Send bulk SMS (same message to multiple numbers)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json post /api/v1/sms/bulk","href":"/api-reference/sms/send-bulk-sms-same-message-to-multiple-numbers"}]},{"group":"Account","pages":[{"title":"Get account limits","deprecated":null,"version":null,"openapi":"/api-reference/openapi.en.json get /api/v1/limits/{sessionId}","href":"/api-reference/account/get-account-limits"}]},{"group":"Official API (Cloud API)","pages":[{"group":"Connection","pages":[{"title":"Create connection manually","openapi":"api-reference/openapi.en.json POST /api/v1/connections/cloud-api/manual","href":"/en/api-reference/cloud-api/criar-conexao-manual"},{"title":"Get connection","openapi":"api-reference/openapi.en.json GET /api/v1/connections/cloud-api/{id}","href":"/en/api-reference/cloud-api/obter-conexao"},{"title":"Update connection","openapi":"api-reference/openapi.en.json PATCH /api/v1/connections/cloud-api/{id}","href":"/en/api-reference/cloud-api/atualizar-conexao"},{"title":"Get Meta access token","openapi":"api-reference/openapi.en.json GET /api/v1/connections/cloud-api/{id}/access-token","href":"/en/api-reference/cloud-api/obter-access-token"}]},{"group":"Routing","pages":[{"title":"Get partners and routing","openapi":"api-reference/openapi.en.json GET /api/v1/connections/cloud-api/{id}/routing","href":"/en/api-reference/cloud-api/ver-roteamento"},{"title":"Take, pass or release a conversation","openapi":"api-reference/openapi.en.json POST /api/v1/connections/cloud-api/{id}/thread-control","href":"/en/api-reference/cloud-api/controlar-conversa"}]},{"group":"Templates","pages":[{"title":"List approved templates","openapi":"api-reference/openapi.en.json GET /api/v1/connections/cloud-api/{id}/templates","href":"/en/api-reference/cloud-api/listar-templates"},{"title":"List all templates","openapi":"api-reference/openapi.en.json GET /api/v1/connections/cloud-api/{id}/templates/all","href":"/en/api-reference/cloud-api/listar-templates-todos"},{"title":"Create template","openapi":"api-reference/openapi.en.json POST /api/v1/connections/cloud-api/{id}/templates","href":"/en/api-reference/cloud-api/criar-template"},{"title":"Delete template","openapi":"api-reference/openapi.en.json DELETE /api/v1/connections/cloud-api/{id}/templates/{name}","href":"/en/api-reference/cloud-api/excluir-template"},{"title":"Send template","openapi":"api-reference/openapi.en.json POST /api/v1/messages/send/template","href":"/en/api-reference/cloud-api/enviar-template"}]}]}]}]}]},"basePath":"","title":"Create a session - D-API","deploymentId":"dpl_HhUetB7eHHDAmK9T1Teip38TgFx9","buildId":"dpl_HhUetB7eHHDAmK9T1Teip38TgFx9","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-jJHA3WSo.js","utils-DbZn3Mjn.js","cloneDeep-CnBnaSyy.js","_Uint8Array-CMQtTgBR.js","isObject-FP1Yky1u.js","utils-Bl2DvzOJ.js","addUniqueKeysToSchema-BwOLo9p1.js","snippetPresets-BBiPpKa-.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-C0px4Tml.js","isEqual-zAyttAAO.js","usePlaygroundInputsStore-Dell6dGw.js","shallow-0VKqkSqN.js","getApiPlaygroundDisplay-CP_ctPEB.js","CodeSnippet-5L35ic0s.js","CodeSnippets-DOXbNhJw.js","Page-DRLI_2Ue.js","getPastedJson-VhzT9m2P.js","icon-CD8_AtCO.js","MethodPill-DGgOMftG.js","DuplicateIcon-DZ6A_EtN.js","createIcon-DUl4oM5f.js","DynamicMarkdown-BGHukeRM.js","SectionHeading-ChrEUs8u.js","axios-vUo_bRtp.js","Markdown-Dj-na-_-.js","dist-C5gjFYHe.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","katex-YMM-FMeD.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js","AssistantPageLink-DEBW87tT.js"]}