[{

"url": "https://doc.evolution-api.com/v1/api-reference/chat-
controller/check-is-whatsapp",
"crawl": {
"loadedUrl": "https://doc.evolution-api.com/v1/api-
reference/chat-controller/check-is-whatsapp",
"loadedTime": "2025-03-05T23:46:07.449Z",
"httpStatusCode": 200
},
"metadata": {
"canonicalUrl": "https://doc.evolution-api.com/v1/api-
reference/chat-controller/check-is-whatsapp",
"title": "Check is WhatsApp - Evolution API
Documentation",
"description": "Check if numbers are on WhatsApp",
"author": null,
"keywords": null,
"languageCode": "en",
"openGraph": [
{
"property": "og:image:width",
"content": "1200"
},
{
"property": "og:image:height",
"content": "630"
},
{
"property": "twitter:image:width",
"content": "1200"
},
{
"property": "twitter:image:height",
"content": "630"
},
{
"property": "og:image",
"content": "https://doc.evolution-api.com/api/og?
division=Documentation&title=Check+is+WhatsApp&description=Che
ck+if+numbers+are+on+WhatsApp&logoLight=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover.png&logoDark=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover-white.png&primaryColor=%2349BC94
&lightColor=%2349BC94&darkColor=%2349BC94"
},
{
"property": "twitter:image",
"content": "https://doc.evolution-api.com/api/og?
division=Documentation&title=Check+is+WhatsApp&description=Che
ck+if+numbers+are+on+WhatsApp&logoLight=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover.png&logoDark=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover-white.png&primaryColor=%2349BC94
&lightColor=%2349BC94&darkColor=%2349BC94"
}
1
 ],
"jsonLd": null,
"headers": {
"age": "163",
"cache-control": "public, max-age=0, must-revalidate",
"content-encoding": "br",
"content-type": "text/html; charset=utf-8",
"date": "Wed, 05 Mar 2025 23:43:09 GMT",
"etag": "W/\"wsy6kkmzky5jd7\"",
"server": "Vercel",
"strict-transport-security": "max-age=63072000",
"x-frame-options": "DENY",
"x-matched-path": "/_sites/[subdomain]/[[...slug]]",
"x-powered-by": "Next.js",
"x-vercel-cache": "HIT",
"x-vercel-id": "iad1::iad1::8ft75-1741218353150-
c0c82cd5cac1",
"x-firefox-spdy": "h2"
}
},
"screenshotUrl": null,
"text": "Check is WhatsApp - Evolution API Documentation
\nAuthorizations\nYour authorization key header\nPath
Parameters\nID of the instance to connect\nBody\nPhone numbers
(with country code) to be checked\nIndicates whether the
WhatsApp account exists.\nThe JID of the WhatsApp account.
\nThe phone number associated with the WhatsApp account.",
"markdown": "# Check is WhatsApp - Evolution API
Documentation\n\n#### Authorizations\n\nYour authorization key
header\n\n#### Path Parameters\n\nID of the instance to
connect\n\n#### Body\n\nPhone numbers (with country code) to
be checked\n\nIndicates whether the WhatsApp account exists.\n
\nThe JID of the WhatsApp account.\n\nThe phone number
associated with the WhatsApp account.",
"debug": {
"requestHandlerMode": "browser"
}
},
{
"url": "https://doc.evolution-api.com/v1/api-reference/chat-
controller/archive-chat",
"crawl": {
"loadedUrl": "https://doc.evolution-api.com/v1/api-
reference/chat-controller/archive-chat",
"loadedTime": "2025-03-05T23:46:08.263Z",
"httpStatusCode": 200
},
"metadata": {
"canonicalUrl": "https://doc.evolution-api.com/v1/api-
reference/chat-controller/archive-chat",
"title": "Archive Chat - Evolution API Documentation",
"description": "Archive Chat",
"author": null,
"keywords": null,
"languageCode": "en",
"openGraph": [
{
2
 "property": "og:image:width",
"content": "1200"
},
{
"property": "og:image:height",
"content": "630"
},
{
"property": "twitter:image:width",
"content": "1200"
},
{
"property": "twitter:image:height",
"content": "630"
},
{
"property": "og:image",
"content": "https://doc.evolution-api.com/api/og?
division=Documentation&title=Archive+Chat&description=Archive+
Chat&logoLight=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover.png&logoDark=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover-white.png&primaryColor=%2349BC94&lightColor=%2349BC94
&darkColor=%2349BC94"
},
{
"property": "twitter:image",
"content": "https://doc.evolution-api.com/api/og?
division=Documentation&title=Archive+Chat&description=Archive+
Chat&logoLight=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover.png&logoDark=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover-white.png&primaryColor=%2349BC94&lightColor=%2349BC94
&darkColor=%2349BC94"
}
],
"jsonLd": null,
"headers": {
"age": "163",
"cache-control": "public, max-age=0, must-revalidate",
"content-encoding": "br",
"content-type": "text/html; charset=utf-8",
"date": "Wed, 05 Mar 2025 23:43:09 GMT",
"etag": "W/\"20tkf4060r5r0k\"",
"server": "Vercel",
"strict-transport-security": "max-age=63072000",
"x-frame-options": "DENY",
"x-matched-path": "/_sites/[subdomain]/[[...slug]]",
"x-powered-by": "Next.js",
"x-vercel-cache": "HIT",
"x-vercel-id":
"iad1::iad1::d6djb-1741218353076-13c8e60e2ba9",
"x-firefox-spdy": "h2"
}
},
3
 "screenshotUrl": null,
"text": "Archive Chat - Evolution API Documentation\ncurl --
request PUT \\ --url https://{server-
url}/chat/archiveChat/{instance} \\ --header 'Content-Type:
application/json' \\ --header 'apikey: <api-key>' \\ --data
'{ \"lastMessage\": { \"key\": { \"remoteJid\": \"<string>\",
\"fromMe\": true, \"id\": \"<string>\" } }, \"archive\":
true }'",
"markdown": "# Archive Chat - Evolution API Documentation\n
\n```\ncurl --request PUT \\\n --url https://{server-
url}/chat/archiveChat/{instance} \\\n --header 'Content-Type:
application/json' \\\n --header 'apikey: <api-key>' \\\n --
data '{\n \"lastMessage\": {\n \"key\": {\n
\"remoteJid\": \"<string>\",\n \"fromMe\": true,\n
\"id\": \"<string>\"\n }\n },\n \"archive\": true
\n}'\n```",
"debug": {
"requestHandlerMode": "browser"
}
},
{
"url": "https://doc.evolution-api.com/v1/api-reference/chat-
controller/delete-message-for-everyone",
"crawl": {
"loadedUrl": "https://doc.evolution-api.com/v1/api-
reference/chat-controller/delete-message-for-everyone",
"loadedTime": "2025-03-05T23:46:09.035Z",
"httpStatusCode": 200
},
"metadata": {
"canonicalUrl": "https://doc.evolution-api.com/v1/api-
reference/chat-controller/delete-message-for-everyone",
"title": "Delete Message for Everyone - Evolution API
Documentation",
"description": "Delete Message For Everyone",
"author": null,
"keywords": null,
"languageCode": "en",
"openGraph": [
{
"property": "og:image:width",
"content": "1200"
},
{
"property": "og:image:height",
"content": "630"
},
{
"property": "twitter:image:width",
"content": "1200"
},
{
"property": "twitter:image:height",
"content": "630"
},
{
"property": "og:image",
4
 "content": "https://doc.evolution-api.com/api/og?
division=Documentation&title=Delete+Message+for+Everyone&descr
iption=Delete+Message+For+Everyone&logoLight=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover.png&logoDark=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover-white.png&primaryColor=%2349BC94
&lightColor=%2349BC94&darkColor=%2349BC94"
},
{
"property": "twitter:image",
"content": "https://doc.evolution-api.com/api/og?
division=Documentation&title=Delete+Message+for+Everyone&descr
iption=Delete+Message+For+Everyone&logoLight=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover.png&logoDark=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover-white.png&primaryColor=%2349BC94
&lightColor=%2349BC94&darkColor=%2349BC94"
}
],
"jsonLd": null,
"headers": {
"age": "170",
"cache-control": "public, max-age=0, must-revalidate",
"content-encoding": "br",
"content-type": "text/html; charset=utf-8",
"date": "Wed, 05 Mar 2025 23:43:10 GMT",
"etag": "W/\"k79px3hku26a6w\"",
"server": "Vercel",
"strict-transport-security": "max-age=63072000",
"x-frame-options": "DENY",
"x-matched-path": "/_sites/[subdomain]/[[...slug]]",
"x-powered-by": "Next.js",
"x-vercel-cache": "HIT",
"x-vercel-id": "iad1::iad1::5xz25-1741218360894-
b6a59ae12bb5",
"x-firefox-spdy": "h2"
}
},
"screenshotUrl": null,
"text": "Delete Message for Everyone - Evolution API
Documentation\nAuthorizations\nYour authorization key header
\nPath Parameters\nID of the instance to connect\nBody\nChat
contact or group remote JID\nIf the message was sent by the
instance owner or the contact\nParticipant for group messages
only TODO\nSchema representing a WhatsApp protocol message,
including the key, message content, timestamp, and status.
\nThe key that identifies the message in the chat.\nThe remote
JID (Jabber ID) of the WhatsApp account.\nIndicates whether
the message was sent by the user.\nThe content of the message.
\nDetails of the protocol message.
\nmessage.protocolMessage.key\nThe key that identifies the
referenced message.\nmessage.protocolMessage.key.remoteJid
\nThe remote JID (Jabber ID) of the WhatsApp account in the
referenced message.\nmessage.protocolMessage.key.fromMe
\nIndicates whether the referenced message was sent by the
5
user.\nmessage.protocolMessage.key.id\nThe ID of the
referenced message.\nmessage.protocolMessage.type\nThe type of
protocol message, e.g., 'REVOKE'.\nThe timestamp of the
message, represented as a string.\nThe status of the message,
such as sent, received, or pending.",
"markdown": "# Delete Message for Everyone - Evolution API
Documentation\n\n#### Authorizations\n\nYour authorization key
header\n\n#### Path Parameters\n\nID of the instance to
connect\n\n#### Body\n\nChat contact or group remote JID\n\nIf
the message was sent by the instance owner or the contact\n
\nParticipant for group messages only TODO\n\nSchema
representing a WhatsApp protocol message, including the key,
message content, timestamp, and status.\n\nThe key that
identifies the message in the chat.\n\nThe remote JID (Jabber
ID) of the WhatsApp account.\n\nIndicates whether the message
was sent by the user.\n\nThe content of the message.\n
\nDetails of the protocol message.\n
\nmessage.protocolMessage.key\n\nThe key that identifies the
referenced message.\n\nmessage.protocolMessage.key.remoteJid\n
\nThe remote JID (Jabber ID) of the WhatsApp account in the
referenced message.\n\nmessage.protocolMessage.key.fromMe\n
\nIndicates whether the referenced message was sent by the
user.\n\nmessage.protocolMessage.key.id\n\nThe ID of the
referenced message.\n\nmessage.protocolMessage.type\n\nThe
type of protocol message, e.g., 'REVOKE'.\n\nThe timestamp of
the message, represented as a string.\n\nThe status of the
message, such as sent, received, or pending.",
"debug": {
"requestHandlerMode": "browser"
}
},
{
"url": "https://doc.evolution-api.com/v1/api-reference/chat-
controller/fetch-profilepic-url",
"crawl": {
"loadedUrl": "https://doc.evolution-api.com/v1/api-
reference/chat-controller/fetch-profilepic-url",
"loadedTime": "2025-03-05T23:46:17.134Z",
"httpStatusCode": 200
},
"metadata": {
"canonicalUrl": "https://doc.evolution-api.com/v1/api-
reference/chat-controller/fetch-profilepic-url",
"title": "Fetch Profile Picture URL - Evolution API
Documentation",
"description": "Fetch Profile Picture URL",
"author": null,
"keywords": null,
"languageCode": "en",
"openGraph": [
{
"property": "og:image:width",
"content": "1200"
},
{
"property": "og:image:height",
"content": "630"
6
 },
{
"property": "twitter:image:width",
"content": "1200"
},
{
"property": "twitter:image:height",
"content": "630"
},
{
"property": "og:image",
"content": "https://doc.evolution-api.com/api/og?
division=Documentation&title=Fetch+Profile+Picture+URL&descrip
tion=Fetch+Profile+Picture+URL&logoLight=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover.png&logoDark=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover-white.png&primaryColor=%2349BC94
&lightColor=%2349BC94&darkColor=%2349BC94"
},
{
"property": "twitter:image",
"content": "https://doc.evolution-api.com/api/og?
division=Documentation&title=Fetch+Profile+Picture+URL&descrip
tion=Fetch+Profile+Picture+URL&logoLight=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover.png&logoDark=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover-white.png&primaryColor=%2349BC94
&lightColor=%2349BC94&darkColor=%2349BC94"
}
],
"jsonLd": null,
"headers": {
"age": "157",
"cache-control": "public, max-age=0, must-revalidate",
"content-encoding": "br",
"content-type": "text/html; charset=utf-8",
"date": "Wed, 05 Mar 2025 23:43:35 GMT",
"etag": "W/\"luss914z5v5him\"",
"server": "Vercel",
"strict-transport-security": "max-age=63072000",
"x-frame-options": "DENY",
"x-matched-path": "/_sites/[subdomain]/[[...slug]]",
"x-powered-by": "Next.js",
"x-vercel-cache": "HIT",
"x-vercel-id":
"iad1::iad1::jnwq4-1741218372443-8f9c2c303402",
"x-firefox-spdy": "h2"
}
},
"screenshotUrl": null,
"text": "Fetch Profile Picture URL - Evolution API
Documentation\nAuthorizations\nYour authorization key header
\nPath Parameters\nID of the instance to connect\nBody\nNumber
to fetch profile picture URL\nThe WhatsApp User ID (WUID).
\nURL of the user's profile picture.",
7
 "markdown": "# Fetch Profile Picture URL - Evolution API
Documentation\n\n#### Authorizations\n\nYour authorization key
header\n\n#### Path Parameters\n\nID of the instance to
connect\n\n#### Body\n\nNumber to fetch profile picture URL\n
\nThe WhatsApp User ID (WUID).\n\nURL of the user's profile
picture.",
"debug": {
"requestHandlerMode": "browser"
}
},
{
"url": "https://doc.evolution-api.com/",
"crawl": {
"loadedUrl": "https://doc.evolution-api.com/v1/pt/get-
started/introduction",
"loadedTime": "2025-03-05T23:46:18.644Z",
"referrerUrl": "https://doc.evolution-api.com/",
"depth": 0,
"httpStatusCode": 200
},
"metadata": {
"canonicalUrl": "https://doc.evolution-api.com/v1/pt/get-
started/introduction",
"title": "Introdução - Evolution API Documentation",
"description": null,
"author": null,
"keywords": null,
"languageCode": "en",
"openGraph": [
{
"property": "og:image:width",
"content": "1200"
},
{
"property": "og:image:height",
"content": "630"
},
{
"property": "twitter:image:width",
"content": "1200"
},
{
"property": "twitter:image:height",
"content": "630"
},
{
"property": "og:image",
"content": "https://doc.evolution-api.com/api/og?
division=Documentation&title=Introdu%C3%A7%C3%
A3o&logoLight=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover.png&logoDark=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover-white.png&primaryColor=%2349BC94&lightColor=%2349BC94
&darkColor=%2349BC94"
},
{
8
 "property": "twitter:image",
"content": "https://doc.evolution-api.com/api/og?
division=Documentation&title=Introdu%C3%A7%C3%
A3o&logoLight=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover.png&logoDark=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover-white.png&primaryColor=%2349BC94&lightColor=%2349BC94
&darkColor=%2349BC94"
}
],
"jsonLd": null,
"headers": {
"age": "496",
"cache-control": "public, max-age=0, must-revalidate",
"content-encoding": "br",
"content-type": "text/html; charset=utf-8",
"date": "Wed, 05 Mar 2025 23:37:58 GMT",
"etag": "W/\"ne56lym7tv4khs\"",
"server": "Vercel",
"strict-transport-security": "max-age=63072000",
"x-frame-options": "DENY",
"x-matched-path": "/_sites/[subdomain]/[[...slug]]",
"x-powered-by": "Next.js",
"x-vercel-cache": "HIT",
"x-vercel-id": "iad1::iad1::lsmlh-1741218375002-
c5c95679917b",
"x-firefox-spdy": "h2"
}
},
"screenshotUrl": null,
"text": "Introdução - Evolution API Documentation
\nEvolution API é um projeto dedicado a capacitar pequenas
empresas, empreendedores, freelancers e indivÃduos com
recursos limitados.\nNossa missão é fornecer uma solução
de mensagens de WhatsAppâ„¢ via API, permitindo que esses
grupos reforcem seus negócios locais ou online.\nO melhor de
tudo é que o nosso serviço é totalmente gratuito, concebido
para apoiar aqueles que se esforçam para ter sucesso num
cenário de mercado competitivo.\nAcesse nosso repositório e
faça parte da nossa comunidade para fazer parte do projeto.
\nInÃcio Rápido\nPara executar a versão de teste e testar as
principais funcionalidades da API, copie o comando abaixo,
modifique o valor de AUTHENTICATION_API_KEY para um de sua
preferência, e execute o comando:\nIsso executará um
contêiner Docker expondo a aplicação na porta 8080 e você
poderá começar a testar e solicitar o código QR do WhatsApp
usando o conteúdo da variável de autenticação com o
cabeçalho apikey definido.\nPara garantir que a API está em
execução, acesse http://localhost:8080 em seu navegador.
Esta deve ser a resposta do seu navegador:\nInstalação\nVeja
como instalar a versão completa em:\nOn this page\nInÃcio
Rápido\nInstalação",
"markdown": "# Introdução - Evolution API Documentation\n
\n**Evolution API** é um projeto dedicado a capacitar
pequenas empresas, empreendedores, freelancers e indivÃduos
com recursos limitados.\n\nNossa missão é fornecer uma
9
solução de mensagens de **WhatsApp™** via API, permitindo
que esses grupos reforcem seus negócios locais ou online.\n
\nO melhor de tudo é que o nosso serviço é **totalmente
gratuito**, concebido para apoiar aqueles que se esforçam
para ter sucesso num cenário de mercado competitivo.\n
\nAcesse nosso [repositório]
(https://github.com/EvolutionAPI/evolution-api) e faça parte
da nossa [comunidade](https://evolution-api.com/) para fazer
parte do projeto.\n\n## InÃcio Rápido\n\nPara executar a
versão de teste e testar as principais funcionalidades da
API, copie o comando abaixo, modifique o valor de
`AUTHENTICATION_API_KEY` para um de sua preferência, e
execute o comando:\n\nIsso executará um contêiner Docker
expondo a aplicação na porta 8080 e você poderá começar a
testar e solicitar o código QR do WhatsApp usando o conteúdo
da variável de autenticação com o cabeçalho apikey
definido.\n\nPara garantir que a API está em execução,
acesse [http://localhost:8080](http://localhost:8080/) em seu
navegador. Esta deve ser a resposta do seu navegador:\n\n##
Instalação\n\nVeja como instalar a versão completa em:\n
\nOn this page\n\n* [InÃcio Rápido](#in%C3%ADcio-r%C3%
A1pido)\n* [Instalação](#instala%C3%A7%C3%A3o)",
"debug": {
"requestHandlerMode": "browser"
}
},
{
"url": "https://doc.evolution-api.com/v1/en/get-
started/introduction",
"crawl": {
"loadedUrl": "https://doc.evolution-api.com/v1/en/get-
started/introduction",
"loadedTime": "2025-03-05T23:46:25.361Z",
"referrerUrl": "https://doc.evolution-api.com/v1/api-
reference/chat-controller/check-is-whatsapp",
"depth": null,
"httpStatusCode": 200
},
"metadata": {
"canonicalUrl": "https://doc.evolution-api.com/v1/en/get-
started/introduction",
"title": "Introduction - Evolution API Documentation",
"description": null,
"author": null,
"keywords": null,
"languageCode": "en",
"openGraph": [
{
"property": "og:image:width",
"content": "1200"
},
{
"property": "og:image:height",
"content": "630"
},
{
"property": "twitter:image:width",
10
 "content": "1200"
},
{
"property": "twitter:image:height",
"content": "630"
},
{
"property": "og:image",
"content": "https://doc.evolution-api.com/api/og?
division=Documentation&title=Introduction&logoLight=https%3A%
2F%2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover.png&logoDark=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover-white.png&primaryColor=%2349BC94
&lightColor=%2349BC94&darkColor=%2349BC94"
},
{
"property": "twitter:image",
"content": "https://doc.evolution-api.com/api/og?
division=Documentation&title=Introduction&logoLight=https%3A%
2F%2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover.png&logoDark=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover-white.png&primaryColor=%2349BC94
&lightColor=%2349BC94&darkColor=%2349BC94"
}
],
"jsonLd": null,
"headers": {
"age": "490",
"cache-control": "public, max-age=0, must-revalidate",
"content-encoding": "br",
"content-type": "text/html; charset=utf-8",
"date": "Wed, 05 Mar 2025 23:38:11 GMT",
"etag": "W/\"vwpmooeyo4kct\"",
"server": "Vercel",
"strict-transport-security": "max-age=63072000",
"x-frame-options": "DENY",
"x-matched-path": "/_sites/[subdomain]/[[...slug]]",
"x-powered-by": "Next.js",
"x-vercel-cache": "HIT",
"x-vercel-id": "iad1::iad1::w9nfq-1741218382487-
d5d2a1f79006",
"x-firefox-spdy": "h2"
}
},
"screenshotUrl": null,
"text": "Introduction - Evolution API Documentation
\nEvolution API is a project dedicated to empowering small
businesses, entrepreneurs, freelancers, and individuals with
limited resources.\nOur mission is to provide a WhatsAppâ„¢
messaging solution via API, enabling these groups to
strengthen their local or online businesses.\nBest of all, our
service is completely free, designed to support those striving
to succeed in a competitive market landscape.\nAccess our
repository and join our community to be a part of the project.
\nQuick Start\nTo run the test version and test the main
11
features of the API, copy the command below, change the value
of AUTHENTICATION_API_KEY to one of your choice, and execute
the command:\nThis will run a Docker container exposing the
application on port 8080, and you can start testing and
requesting the WhatsApp QR code using the authentication
variable content with the apikey header set.\nTo ensure the
API is running, access http://localhost:8080 in your browser.
This should be the response from your browser:\nInstallation
\nLearn how to install the full version at:\nOn this page
\nQuick Start\nInstallation",
"markdown": "# Introduction - Evolution API Documentation\n
\n**Evolution API** is a project dedicated to empowering small
businesses, entrepreneurs, freelancers, and individuals with
limited resources.\n\nOur mission is to provide a
**WhatsAppâ„¢** messaging solution via API, enabling these
groups to strengthen their local or online businesses.\n\nBest
of all, our service is **completely free**, designed to
support those striving to succeed in a competitive market
landscape.\n\nAccess our [repository]
(https://github.com/EvolutionAPI/evolution-api) and join our
[community](https://evolution-api.com/) to be a part of the
project.\n\n## Quick Start\n\nTo run the test version and test
the main features of the API, copy the command below, change
the value of `AUTHENTICATION_API_KEY` to one of your choice,
and execute the command:\n\nThis will run a Docker container
exposing the application on port 8080, and you can start
testing and requesting the WhatsApp QR code using the
authentication variable content with the apikey header set.\n
\nTo ensure the API is running, access [http://localhost:8080]
(http://localhost:8080/) in your browser. This should be the
response from your browser:\n\n## Installation\n\nLearn how to
install the full version at:\n\nOn this page\n\n* [Quick
Start](#quick-start)\n* [Installation](#installation)",
"debug": {
"requestHandlerMode": "browser"
}
},
{
"url": "https://doc.evolution-api.com/v1/api-reference/get-
information",
"crawl": {
"loadedUrl": "https://doc.evolution-api.com/v1/api-
reference/get-information",
"loadedTime": "2025-03-05T23:46:32.857Z",
"referrerUrl": "https://doc.evolution-api.com/v1/api-
reference/chat-controller/check-is-whatsapp",
"depth": null,
"httpStatusCode": 200
},
"metadata": {
"canonicalUrl": "https://doc.evolution-api.com/v1/api-
reference/get-information",
"title": "Get Information - Evolution API Documentation",
"description": "Get information about your EvolutionAPI",
"author": null,
"keywords": null,
"languageCode": "en",
12
 "openGraph": [
{
"property": "og:image:width",
"content": "1200"
},
{
"property": "og:image:height",
"content": "630"
},
{
"property": "twitter:image:width",
"content": "1200"
},
{
"property": "twitter:image:height",
"content": "630"
},
{
"property": "og:image",
"content": "https://doc.evolution-api.com/api/og?
division=Documentation&title=Get+Information&description=Get+i
nformation+about+your+EvolutionAPI&logoLight=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover.png&logoDark=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover-white.png&primaryColor=%2349BC94
&lightColor=%2349BC94&darkColor=%2349BC94"
},
{
"property": "twitter:image",
"content": "https://doc.evolution-api.com/api/og?
division=Documentation&title=Get+Information&description=Get+i
nformation+about+your+EvolutionAPI&logoLight=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover.png&logoDark=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover-white.png&primaryColor=%2349BC94
&lightColor=%2349BC94&darkColor=%2349BC94"
}
],
"jsonLd": null,
"headers": {
"age": "498",
"cache-control": "public, max-age=0, must-revalidate",
"content-encoding": "br",
"content-type": "text/html; charset=utf-8",
"date": "Wed, 05 Mar 2025 23:38:11 GMT",
"etag": "W/\"3852rrstjp5j7i\"",
"server": "Vercel",
"strict-transport-security": "max-age=63072000",
"x-frame-options": "DENY",
"x-matched-path": "/_sites/[subdomain]/[[...slug]]",
"x-powered-by": "Next.js",
"x-vercel-cache": "HIT",
"x-vercel-id":
"iad1::iad1::zr8qp-1741218389665-1e4fb7afa392",
"x-firefox-spdy": "h2"
13
 }
},
"screenshotUrl": null,
"text": "Get Information - Evolution API Documentation\nGet
information about your EvolutionAPI\nPath Parameters\nID of
the instance to connect\nThe HTTP status of the response
\nDescriptive message about the current state of the API\nThe
current version of the API\nURL to the API's Swagger
documentation\nURL to the detailed API documentation",
"markdown": "# Get Information - Evolution API Documentation
\n\nGet information about your EvolutionAPI\n\n#### Path
Parameters\n\nID of the instance to connect\n\nThe HTTP status
of the response\n\nDescriptive message about the current state
of the API\n\nThe current version of the API\n\nURL to the
API's Swagger documentation\n\nURL to the detailed API
documentation",
"debug": {
"requestHandlerMode": "browser"
}
},
{
"url": "https://doc.evolution-api.com/v1/api-
reference/instance-controller/create-instance-basic",
"crawl": {
"loadedUrl": "https://doc.evolution-api.com/v1/api-
reference/instance-controller/create-instance-basic",
"loadedTime": "2025-03-05T23:46:34.053Z",
"referrerUrl": "https://doc.evolution-api.com/v1/api-
reference/chat-controller/check-is-whatsapp",
"depth": null,
"httpStatusCode": 200
},
"metadata": {
"canonicalUrl": "https://doc.evolution-api.com/v1/api-
reference/instance-controller/create-instance-basic",
"title": "Create Instance Basic - Evolution API
Documentation",
"description": null,
"author": null,
"keywords": null,
"languageCode": "en",
"openGraph": [
{
"property": "og:image:width",
"content": "1200"
},
{
"property": "og:image:height",
"content": "630"
},
{
"property": "twitter:image:width",
"content": "1200"
},
{
"property": "twitter:image:height",
"content": "630"
14
 },
{
"property": "og:image",
"content": "https://doc.evolution-api.com/api/og?
division=Documentation&title=Create+Instance+Basic&logoLight=h
ttps%3A%2F%2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-
eb1f2775%2Fimages%2Fbrand%2Fcover.png&logoDark=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover-white.png&primaryColor=%2349BC94
&lightColor=%2349BC94&darkColor=%2349BC94"
},
{
"property": "twitter:image",
"content": "https://doc.evolution-api.com/api/og?
division=Documentation&title=Create+Instance+Basic&logoLight=h
ttps%3A%2F%2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-
eb1f2775%2Fimages%2Fbrand%2Fcover.png&logoDark=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover-white.png&primaryColor=%2349BC94
&lightColor=%2349BC94&darkColor=%2349BC94"
}
],
"jsonLd": null,
"headers": {
"age": "222",
"cache-control": "public, max-age=0, must-revalidate",
"content-encoding": "br",
"content-type": "text/html; charset=utf-8",
"date": "Wed, 05 Mar 2025 23:42:46 GMT",
"etag": "W/\"13tvi6u4uhj82z2\"",
"server": "Vercel",
"strict-transport-security": "max-age=63072000",
"x-frame-options": "DENY",
"x-matched-path": "/_sites/[subdomain]/[[...slug]]",
"x-powered-by": "Next.js",
"x-vercel-cache": "HIT",
"x-vercel-id": "iad1::iad1::vgch6-1741218389961-
d6e735d32b20",
"x-firefox-spdy": "h2"
}
},
"screenshotUrl": null,
"text": "Create Instance Basic - Evolution API Documentation
\nAuthorizations\nYour authorization key header\nBody\napikey
(Enter or leave empty to create dynamically)\nCreate QR Code
automatically after creation\n559999999999 (Instance owner
number with Country Code)\nWhatsApp engine\nAvailable options:
\nWHATSAPP-BAILEYS,\nWHATSAPP-BUSINESS \nEvents to be sent to
the Webhook\nAvailable options:\nAPPLICATION_STARTUP,
\nQRCODE_UPDATED,\nMESSAGES_SET,\nMESSAGES_UPSERT,
\nMESSAGES_UPDATE,\nMESSAGES_DELETE,\nSEND_MESSAGE,
\nCONTACTS_SET,\nCONTACTS_UPSERT,\nCONTACTS_UPDATE,
\nPRESENCE_UPDATE,\nCHATS_SET,\nCHATS_UPSERT,\nCHATS_UPDATE,
\nCHATS_DELETE,\nGROUPS_UPSERT,\nGROUP_UPDATE,
\nGROUP_PARTICIPANTS_UPDATE,\nCONNECTION_UPDATE,\nCALL,
\nNEW_JWT_TOKEN,\nTYPEBOT_START,\nTYPEBOT_CHANGE_STATUS
\nReject WhatsApp calls automatically\nMessage to be sent when
15
a call is rejected automatically\nKeep WhatsApp always online
\nSend read receipts to received messages\nShow sent messages
read status\nEvents to be sent to the websocket\nAvailable
options:\nAPPLICATION_STARTUP,\nQRCODE_UPDATED,\nMESSAGES_SET,
\nMESSAGES_UPSERT,\nMESSAGES_UPDATE,\nMESSAGES_DELETE,
\nSEND_MESSAGE,\nCONTACTS_SET,\nCONTACTS_UPSERT,
\nCONTACTS_UPDATE,\nPRESENCE_UPDATE,\nCHATS_SET,
\nCHATS_UPSERT,\nCHATS_UPDATE,\nCHATS_DELETE,\nGROUPS_UPSERT,
\nGROUP_UPDATE,\nGROUP_PARTICIPANTS_UPDATE,
\nCONNECTION_UPDATE,\nCALL,\nNEW_JWT_TOKEN,\nTYPEBOT_START,
\nTYPEBOT_CHANGE_STATUS \nEvents to be sent to the RabbitMQ
\nAvailable options:\nAPPLICATION_STARTUP,\nQRCODE_UPDATED,
\nMESSAGES_SET,\nMESSAGES_UPSERT,\nMESSAGES_UPDATE,
\nMESSAGES_DELETE,\nSEND_MESSAGE,\nCONTACTS_SET,
\nCONTACTS_UPSERT,\nCONTACTS_UPDATE,\nPRESENCE_UPDATE,
\nCHATS_SET,\nCHATS_UPSERT,\nCHATS_UPDATE,\nCHATS_DELETE,
\nGROUPS_UPSERT,\nGROUP_UPDATE,\nGROUP_PARTICIPANTS_UPDATE,
\nCONNECTION_UPDATE,\nCALL,\nNEW_JWT_TOKEN,\nTYPEBOT_START,
\nTYPEBOT_CHANGE_STATUS \nEvents to be sent to the SQS
\nAvailable options:\nAPPLICATION_STARTUP,\nQRCODE_UPDATED,
\nMESSAGES_SET,\nMESSAGES_UPSERT,\nMESSAGES_UPDATE,
\nMESSAGES_DELETE,\nSEND_MESSAGE,\nCONTACTS_SET,
\nCONTACTS_UPSERT,\nCONTACTS_UPDATE,\nPRESENCE_UPDATE,
\nCHATS_SET,\nCHATS_UPSERT,\nCHATS_UPDATE,\nCHATS_DELETE,
\nGROUPS_UPSERT,\nGROUP_UPDATE,\nGROUP_PARTICIPANTS_UPDATE,
\nCONNECTION_UPDATE,\nCALL,\nNEW_JWT_TOKEN,\nTYPEBOT_START,
\nTYPEBOT_CHANGE_STATUS \nURL for the typebot instance
\nKeyword to finish the typebot flow\nDefault delay for the
typebot messages\ntypebot_listening_from_me\nTypebot listen
messages sent by the connected number\nProxy protocol
\nAvailable options:\nhttp,\nhttps \nChatwoot authentication
token\nSend message signature on Chatwoot
\nchatwoot_reopen_conversation\nReopen conversation on
Chatwoot\nchatwoot_conversation_pending\nThe unique identifier
for the instance\ninstance.webhook_wa_business\nThe webhook
URL for WhatsApp Business integration
\ninstance.access_token_wa_business\nThe access token for
WhatsApp Business\nThe current status of the instance\nThe API
key for authentication\nIndicates whether calls are rejected
\nMessage to be sent when a call is rejected\nIndicates
whether groups are ignored\nIndicates whether the instance is
always online\nIndicates whether messages are marked as read
\nIndicates whether status updates are marked as read
\nsettings.sync_full_history\nIndicates whether the full
message history is synchronized",
"markdown": "# Create Instance Basic - Evolution API
Documentation\n\n#### Authorizations\n\nYour authorization key
header\n\n#### Body\n\napikey (Enter or leave empty to create
dynamically)\n\nCreate QR Code automatically after creation\n
\n559999999999 (Instance owner number with Country Code)\n
\nWhatsApp engine\n\nAvailable options:\n\n`WHATSAPP-BAILEYS`,
\n\n`WHATSAPP-BUSINESS`\n\nEvents to be sent to the Webhook\n
\nAvailable options:\n\n`APPLICATION_STARTUP`,\n
\n`QRCODE_UPDATED`,\n\n`MESSAGES_SET`,\n\n`MESSAGES_UPSERT`,\n
\n`MESSAGES_UPDATE`,\n\n`MESSAGES_DELETE`,\n\n`SEND_MESSAGE`,
\n\n`CONTACTS_SET`,\n\n`CONTACTS_UPSERT`,\n
\n`CONTACTS_UPDATE`,\n\n`PRESENCE_UPDATE`,\n\n`CHATS_SET`,\n
16
\n`CHATS_UPSERT`,\n\n`CHATS_UPDATE`,\n\n`CHATS_DELETE`,\n
\n`GROUPS_UPSERT`,\n\n`GROUP_UPDATE`,\n
\n`GROUP_PARTICIPANTS_UPDATE`,\n\n`CONNECTION_UPDATE`,\n
\n`CALL`,\n\n`NEW_JWT_TOKEN`,\n\n`TYPEBOT_START`,\n
\n`TYPEBOT_CHANGE_STATUS`\n\nReject WhatsApp calls
automatically\n\nMessage to be sent when a call is rejected
automatically\n\nKeep WhatsApp always online\n\nSend read
receipts to received messages\n\nShow sent messages read
status\n\nEvents to be sent to the websocket\n\nAvailable
options:\n\n`APPLICATION_STARTUP`,\n\n`QRCODE_UPDATED`,\n
\n`MESSAGES_SET`,\n\n`MESSAGES_UPSERT`,\n\n`MESSAGES_UPDATE`,
\n\n`MESSAGES_DELETE`,\n\n`SEND_MESSAGE`,\n\n`CONTACTS_SET`,\n
\n`CONTACTS_UPSERT`,\n\n`CONTACTS_UPDATE`,\n
\n`PRESENCE_UPDATE`,\n\n`CHATS_SET`,\n\n`CHATS_UPSERT`,\n
\n`CHATS_UPDATE`,\n\n`CHATS_DELETE`,\n\n`GROUPS_UPSERT`,\n
\n`GROUP_UPDATE`,\n\n`GROUP_PARTICIPANTS_UPDATE`,\n
\n`CONNECTION_UPDATE`,\n\n`CALL`,\n\n`NEW_JWT_TOKEN`,\n
\n`TYPEBOT_START`,\n\n`TYPEBOT_CHANGE_STATUS`\n\nEvents to be
sent to the RabbitMQ\n\nAvailable options:\n
\n`APPLICATION_STARTUP`,\n\n`QRCODE_UPDATED`,\n
\n`MESSAGES_SET`,\n\n`MESSAGES_UPSERT`,\n\n`MESSAGES_UPDATE`,
\n\n`MESSAGES_DELETE`,\n\n`SEND_MESSAGE`,\n\n`CONTACTS_SET`,\n
\n`CONTACTS_UPSERT`,\n\n`CONTACTS_UPDATE`,\n
\n`PRESENCE_UPDATE`,\n\n`CHATS_SET`,\n\n`CHATS_UPSERT`,\n
\n`CHATS_UPDATE`,\n\n`CHATS_DELETE`,\n\n`GROUPS_UPSERT`,\n
\n`GROUP_UPDATE`,\n\n`GROUP_PARTICIPANTS_UPDATE`,\n
\n`CONNECTION_UPDATE`,\n\n`CALL`,\n\n`NEW_JWT_TOKEN`,\n
\n`TYPEBOT_START`,\n\n`TYPEBOT_CHANGE_STATUS`\n\nEvents to be
sent to the SQS\n\nAvailable options:\n
\n`APPLICATION_STARTUP`,\n\n`QRCODE_UPDATED`,\n
\n`MESSAGES_SET`,\n\n`MESSAGES_UPSERT`,\n\n`MESSAGES_UPDATE`,
\n\n`MESSAGES_DELETE`,\n\n`SEND_MESSAGE`,\n\n`CONTACTS_SET`,\n
\n`CONTACTS_UPSERT`,\n\n`CONTACTS_UPDATE`,\n
\n`PRESENCE_UPDATE`,\n\n`CHATS_SET`,\n\n`CHATS_UPSERT`,\n
\n`CHATS_UPDATE`,\n\n`CHATS_DELETE`,\n\n`GROUPS_UPSERT`,\n
\n`GROUP_UPDATE`,\n\n`GROUP_PARTICIPANTS_UPDATE`,\n
\n`CONNECTION_UPDATE`,\n\n`CALL`,\n\n`NEW_JWT_TOKEN`,\n
\n`TYPEBOT_START`,\n\n`TYPEBOT_CHANGE_STATUS`\n\nURL for the
typebot instance\n\nKeyword to finish the typebot flow\n
\nDefault delay for the typebot messages\n\ntypebot
\\_listening\\_from\\_me\n\nTypebot listen messages sent by
the connected number\n\nProxy protocol\n\nAvailable options:\n
\n`http`,\n\n`https`\n\nChatwoot authentication token\n\nSend
message signature on Chatwoot\n\nchatwoot\\_reopen
\\_conversation\n\nReopen conversation on Chatwoot\n\nchatwoot
\\_conversation\\_pending\n\nThe unique identifier for the
instance\n\ninstance.webhook\\_wa\\_business\n\nThe webhook
URL for WhatsApp Business integration\n\ninstance.access
\\_token\\_wa\\_business\n\nThe access token for WhatsApp
Business\n\nThe current status of the instance\n\nThe API key
for authentication\n\nIndicates whether calls are rejected\n
\nMessage to be sent when a call is rejected\n\nIndicates
whether groups are ignored\n\nIndicates whether the instance
is always online\n\nIndicates whether messages are marked as
read\n\nIndicates whether status updates are marked as read\n
\nsettings.sync\\_full\\_history\n\nIndicates whether the full
message history is synchronized",
17
 "debug": {
"requestHandlerMode": "browser"
}
},
{
"url": "https://doc.evolution-api.com/v1/api-
reference/instance-controller/fetch-instances",
"crawl": {
"loadedUrl": "https://doc.evolution-api.com/v1/api-
reference/instance-controller/fetch-instances",
"loadedTime": "2025-03-05T23:46:34.849Z",
"referrerUrl": "https://doc.evolution-api.com/v1/api-
reference/chat-controller/check-is-whatsapp",
"depth": null,
"httpStatusCode": 200
},
"metadata": {
"canonicalUrl": "https://doc.evolution-api.com/v1/api-
reference/instance-controller/fetch-instances",
"title": "Fetch Instances - Evolution API Documentation",
"description": "Returns the instance with the name
informed in the parameter, or all the instances if empty.",
"author": null,
"keywords": null,
"languageCode": "en",
"openGraph": [
{
"property": "og:image:width",
"content": "1200"
},
{
"property": "og:image:height",
"content": "630"
},
{
"property": "twitter:image:width",
"content": "1200"
},
{
"property": "twitter:image:height",
"content": "630"
},
{
"property": "og:image",
"content": "https://doc.evolution-api.com/api/og?
division=Documentation&title=Fetch+Instances&description=Retur
ns+the+instance+with+the+name+informed+in+the+parameter%
2C+or+all+the+instances+if+empty.&logoLight=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover.png&logoDark=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover-white.png&primaryColor=%2349BC94
&lightColor=%2349BC94&darkColor=%2349BC94"
},
{
"property": "twitter:image",
"content": "https://doc.evolution-api.com/api/og?
18
division=Documentation&title=Fetch+Instances&description=Retur
ns+the+instance+with+the+name+informed+in+the+parameter%
2C+or+all+the+instances+if+empty.&logoLight=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover.png&logoDark=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover-white.png&primaryColor=%2349BC94
&lightColor=%2349BC94&darkColor=%2349BC94"
}
],
"jsonLd": null,
"headers": {
"age": "225",
"cache-control": "public, max-age=0, must-revalidate",
"content-encoding": "br",
"content-type": "text/html; charset=utf-8",
"date": "Wed, 05 Mar 2025 23:42:46 GMT",
"etag": "W/\"153h73dh76i5qjv\"",
"server": "Vercel",
"strict-transport-security": "max-age=63072000",
"x-frame-options": "DENY",
"x-matched-path": "/_sites/[subdomain]/[[...slug]]",
"x-powered-by": "Next.js",
"x-vercel-cache": "HIT",
"x-vercel-id": "iad1::iad1::vgch6-1741218392455-
a52cf2bdcbd9",
"x-firefox-spdy": "h2"
}
},
"screenshotUrl": null,
"text": "Fetch Instances - Evolution API Documentation
\nAuthorizations\nYour authorization key header\nQuery
Parameters\nName of the instance to be fetched\nThe HTTP
status of the response\nThe error message indicating the type
of error\nList of detailed error messages",
"markdown": "# Fetch Instances - Evolution API Documentation
\n\n#### Authorizations\n\nYour authorization key header\n
\n#### Query Parameters\n\nName of the instance to be fetched
\n\nThe HTTP status of the response\n\nThe error message
indicating the type of error\n\nList of detailed error
messages",
"debug": {
"requestHandlerMode": "browser"
}
},
{
"url": "https://doc.evolution-api.com/v1/api-
reference/instance-controller/instance-connect",
"crawl": {
"loadedUrl": "https://doc.evolution-api.com/v1/api-
reference/instance-controller/instance-connect",
"loadedTime": "2025-03-05T23:46:42.652Z",
"referrerUrl": "https://doc.evolution-api.com/v1/api-
reference/chat-controller/check-is-whatsapp",
"depth": null,
"httpStatusCode": 200
},
19
 "metadata": {
"canonicalUrl": "https://doc.evolution-api.com/v1/api-
reference/instance-controller/instance-connect",
"title": "Instance Connect - Evolution API Documentation",
"description": "Generates and returns the QR code for
WhatsApp connection",
"author": null,
"keywords": null,
"languageCode": "en",
"openGraph": [
{
"property": "og:image:width",
"content": "1200"
},
{
"property": "og:image:height",
"content": "630"
},
{
"property": "twitter:image:width",
"content": "1200"
},
{
"property": "twitter:image:height",
"content": "630"
},
{
"property": "og:image",
"content": "https://doc.evolution-api.com/api/og?
division=Documentation&title=Instance+Connect&description=Gene
rates+and+returns+the+QR+code+for+WhatsApp+connection&logoLigh
t=https%3A%2F%2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-
eb1f2775%2Fimages%2Fbrand%2Fcover.png&logoDark=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover-white.png&primaryColor=%2349BC94
&lightColor=%2349BC94&darkColor=%2349BC94"
},
{
"property": "twitter:image",
"content": "https://doc.evolution-api.com/api/og?
division=Documentation&title=Instance+Connect&description=Gene
rates+and+returns+the+QR+code+for+WhatsApp+connection&logoLigh
t=https%3A%2F%2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-
eb1f2775%2Fimages%2Fbrand%2Fcover.png&logoDark=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover-white.png&primaryColor=%2349BC94
&lightColor=%2349BC94&darkColor=%2349BC94"
}
],
"jsonLd": null,
"headers": {
"age": "231",
"cache-control": "public, max-age=0, must-revalidate",
"content-encoding": "br",
"content-type": "text/html; charset=utf-8",
"date": "Wed, 05 Mar 2025 23:42:46 GMT",
"etag": "W/\"bi6v1s2uph5kx8\"",
20
 "server": "Vercel",
"strict-transport-security": "max-age=63072000",
"x-frame-options": "DENY",
"x-matched-path": "/_sites/[subdomain]/[[...slug]]",
"x-powered-by": "Next.js",
"x-vercel-cache": "HIT",
"x-vercel-id":
"iad1::iad1::flsj6-1741218398773-770d94f57ce8",
"x-firefox-spdy": "h2"
}
},
"screenshotUrl": null,
"text": "Instance Connect - Evolution API Documentation
\nAuthorizations\nYour authorization key header\nPath
Parameters\nID of the instance to connect\nQuery Parameters
\nPhone number (with country code) to be connected\nThe unique
code used for pairing a device or account.\nA specific code
associated with the pairing process. This may include tokens
or other identifiers.\nThe count or number of attempts or
instances related to the pairing process.",
"markdown": "# Instance Connect - Evolution API
Documentation\n\n#### Authorizations\n\nYour authorization key
header\n\n#### Path Parameters\n\nID of the instance to
connect\n\n#### Query Parameters\n\nPhone number (with country
code) to be connected\n\nThe unique code used for pairing a
device or account.\n\nA specific code associated with the
pairing process. This may include tokens or other identifiers.
\n\nThe count or number of attempts or instances related to
the pairing process.",
"debug": {
"requestHandlerMode": "browser"
}
},
{
"url": "https://doc.evolution-api.com/v1/api-
reference/message-controller/send-list",
"crawl": {
"loadedUrl": "https://doc.evolution-api.com/v1/api-
reference/message-controller/send-list",
"loadedTime": "2025-03-05T23:46:44.441Z",
"referrerUrl": "https://doc.evolution-api.com/v1/api-
reference/chat-controller/check-is-whatsapp",
"depth": null,
"httpStatusCode": 200
},
"metadata": {
"canonicalUrl": "https://doc.evolution-api.com/v1/api-
reference/message-controller/send-list",
"title": "Send List - Evolution API Documentation",
"description": "Send List",
"author": null,
"keywords": null,
"languageCode": "en",
"openGraph": [
{
"property": "og:image:width",
"content": "1200"
21
 },
{
"property": "og:image:height",
"content": "630"
},
{
"property": "twitter:image:width",
"content": "1200"
},
{
"property": "twitter:image:height",
"content": "630"
},
{
"property": "og:image",
"content": "https://doc.evolution-api.com/api/og?
division=Documentation&title=Send+List&description=Send+List&l
ogoLight=https%3A%2F%2Fmintlify.s3.us-west-1.amazonaws.com%
2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover.png&logoDark=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover-white.png&primaryColor=%2349BC94&lightColor=%2349BC94
&darkColor=%2349BC94"
},
{
"property": "twitter:image",
"content": "https://doc.evolution-api.com/api/og?
division=Documentation&title=Send+List&description=Send+List&l
ogoLight=https%3A%2F%2Fmintlify.s3.us-west-1.amazonaws.com%
2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover.png&logoDark=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover-white.png&primaryColor=%2349BC94&lightColor=%2349BC94
&darkColor=%2349BC94"
}
],
"jsonLd": null,
"headers": {
"age": "210",
"cache-control": "public, max-age=0, must-revalidate",
"content-encoding": "br",
"content-type": "text/html; charset=utf-8",
"date": "Wed, 05 Mar 2025 23:43:09 GMT",
"etag": "W/\"pmolgfscm97a2s\"",
"server": "Vercel",
"strict-transport-security": "max-age=63072000",
"x-frame-options": "DENY",
"x-matched-path": "/_sites/[subdomain]/[[...slug]]",
"x-powered-by": "Next.js",
"x-vercel-cache": "HIT",
"x-vercel-id":
"iad1::iad1::wq4mw-1741218399752-6ac9416b88e8",
"x-firefox-spdy": "h2"
}
},
"screenshotUrl": null,
"text": "Send List - Evolution API Documentation
22
\nAuthorizations\nYour authorization key header\nPath
Parameters\nID of the instance to connect\nBody\nNumber to
receive the message (with country code)\nPresence time in
milliseconds before sending message\nPresence type to show
\nAvailable options:\ncomposing,\nrecording
\nlistMessage.sections.title\nlistMessage.sections.rows
\nlistMessage.sections.rows.title
\nlistMessage.sections.rows.description
\nlistMessage.sections.rows.rowId\nThe message content, which
may include various types of messages like text, images, list,
etc.\nDetails of the list message.\nmessage.listMessage.title
\nThe title of the list message.
\nmessage.listMessage.description\nThe description of the list
message.\nmessage.listMessage.buttonText\nThe text of the
button in the list message.\nmessage.listMessage.listType
\nmessage.listMessage.sections\nThe sections in the list
message.\nmessage.listMessage.sections.title\nThe title of the
section.\nmessage.listMessage.sections.rows
\nmessage.listMessage.sections.rows.title
\nmessage.listMessage.sections.rows.description\nThe
description of the row.
\nmessage.listMessage.sections.rows.rowId
\nmessage.listMessage.contextInfo\nAdditional context
information.\nThe key of the message, which identifies the
message in the chat.\nIndicates whether the message was sent
by the user.\nThe timestamp of the message, represented as a
string.\nThe status of the message, such as sent, received, or
pending.",
"markdown": "# Send List - Evolution API Documentation\n
\n#### Authorizations\n\nYour authorization key header\n\n####
Path Parameters\n\nID of the instance to connect\n\n#### Body
\n\nNumber to receive the message (with country code)\n
\nPresence time in milliseconds before sending message\n
\nPresence type to show\n\nAvailable options:\n\n`composing`,
\n\n`recording`\n\nlistMessage.sections.title\n
\nlistMessage.sections.rows\n\nlistMessage.sections.rows.title
\n\nlistMessage.sections.rows.description\n
\nlistMessage.sections.rows.rowId\n\nThe message content,
which may include various types of messages like text, images,
list, etc.\n\nDetails of the list message.\n
\nmessage.listMessage.title\n\nThe title of the list message.
\n\nmessage.listMessage.description\n\nThe description of the
list message.\n\nmessage.listMessage.buttonText\n\nThe text of
the button in the list message.\n
\nmessage.listMessage.listType\n\nmessage.listMessage.sections
\n\nThe sections in the list message.\n
\nmessage.listMessage.sections.title\n\nThe title of the
section.\n\nmessage.listMessage.sections.rows\n
\nmessage.listMessage.sections.rows.title\n
\nmessage.listMessage.sections.rows.description\n\nThe
description of the row.\n
\nmessage.listMessage.sections.rows.rowId\n
\nmessage.listMessage.contextInfo\n\nAdditional context
information.\n\nThe key of the message, which identifies the
message in the chat.\n\nIndicates whether the message was sent
by the user.\n\nThe timestamp of the message, represented as a
string.\n\nThe status of the message, such as sent, received,
23
or pending.",
"debug": {
"requestHandlerMode": "browser"
}
},
{
"url": "https://doc.evolution-api.com/v1/api-
reference/instance-controller/restart-instance",
"crawl": {
"loadedUrl": "https://doc.evolution-api.com/v1/api-
reference/instance-controller/restart-instance",
"loadedTime": "2025-03-05T23:46:44.465Z",
"referrerUrl": "https://doc.evolution-api.com/v1/api-
reference/chat-controller/check-is-whatsapp",
"depth": null,
"httpStatusCode": 200
},
"metadata": {
"canonicalUrl": "https://doc.evolution-api.com/v1/api-
reference/instance-controller/restart-instance",
"title": "Restart Instance - Evolution API Documentation",
"description": "Restarts the instance",
"author": null,
"keywords": null,
"languageCode": "en",
"openGraph": [
{
"property": "og:image:width",
"content": "1200"
},
{
"property": "og:image:height",
"content": "630"
},
{
"property": "twitter:image:width",
"content": "1200"
},
{
"property": "twitter:image:height",
"content": "630"
},
{
"property": "og:image",
"content": "https://doc.evolution-api.com/api/og?
division=Documentation&title=Restart+Instance&description=Rest
arts+the+instance&logoLight=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover.png&logoDark=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover-white.png&primaryColor=%2349BC94&lightColor=%2349BC94
&darkColor=%2349BC94"
},
{
"property": "twitter:image",
"content": "https://doc.evolution-api.com/api/og?
division=Documentation&title=Restart+Instance&description=Rest
24
arts+the+instance&logoLight=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover.png&logoDark=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover-white.png&primaryColor=%2349BC94&lightColor=%2349BC94
&darkColor=%2349BC94"
}
],
"jsonLd": null,
"headers": {
"age": "234",
"cache-control": "public, max-age=0, must-revalidate",
"content-encoding": "br",
"content-type": "text/html; charset=utf-8",
"date": "Wed, 05 Mar 2025 23:42:46 GMT",
"etag": "W/\"c1ld1g0dgq5jhn\"",
"server": "Vercel",
"strict-transport-security": "max-age=63072000",
"x-frame-options": "DENY",
"x-matched-path": "/_sites/[subdomain]/[[...slug]]",
"x-powered-by": "Next.js",
"x-vercel-cache": "HIT",
"x-vercel-id": "iad1::iad1::ndjk5-1741218401362-
f39be2a34e10",
"x-firefox-spdy": "h2"
}
},
"screenshotUrl": null,
"text": "Restart Instance - Evolution API Documentation
\nAuthorizations\nYour authorization key header\nPath
Parameters\nID of the instance to connect\nThe name of the
instance.\nThe state of the instance.",
"markdown": "# Restart Instance - Evolution API
Documentation\n\n#### Authorizations\n\nYour authorization key
header\n\n#### Path Parameters\n\nID of the instance to
connect\n\nThe name of the instance.\n\nThe state of the
instance.",
"debug": {
"requestHandlerMode": "browser"
}
},
{
"url": "https://doc.evolution-api.com/v1/api-reference/chat-
controller/mark-as-read",
"crawl": {
"loadedUrl": "https://doc.evolution-api.com/v1/api-
reference/chat-controller/mark-as-read",
"loadedTime": "2025-03-05T23:46:52.853Z",
"referrerUrl": "https://doc.evolution-api.com/v1/api-
reference/chat-controller/check-is-whatsapp",
"depth": null,
"httpStatusCode": 200
},
"metadata": {
"canonicalUrl": "https://doc.evolution-api.com/v1/api-
reference/chat-controller/mark-as-read",
"title": "Mark Message As Read - Evolution API
25
Documentation",
"description": "Mark message as read",
"author": null,
"keywords": null,
"languageCode": "en",
"openGraph": [
{
"property": "og:image:width",
"content": "1200"
},
{
"property": "og:image:height",
"content": "630"
},
{
"property": "twitter:image:width",
"content": "1200"
},
{
"property": "twitter:image:height",
"content": "630"
},
{
"property": "og:image",
"content": "https://doc.evolution-api.com/api/og?
division=Documentation&title=Mark+Message+As+Read&description=
Mark+message+as+read&logoLight=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover.png&logoDark=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover-white.png&primaryColor=%2349BC94&lightColor=%2349BC94
&darkColor=%2349BC94"
},
{
"property": "twitter:image",
"content": "https://doc.evolution-api.com/api/og?
division=Documentation&title=Mark+Message+As+Read&description=
Mark+message+as+read&logoLight=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover.png&logoDark=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover-white.png&primaryColor=%2349BC94&lightColor=%2349BC94
&darkColor=%2349BC94"
}
],
"jsonLd": null,
"headers": {
"age": "219",
"cache-control": "public, max-age=0, must-revalidate",
"content-encoding": "br",
"content-type": "text/html; charset=utf-8",
"date": "Wed, 05 Mar 2025 23:43:09 GMT",
"etag": "W/\"a6jdius3yu5mr7\"",
"server": "Vercel",
"strict-transport-security": "max-age=63072000",
"x-frame-options": "DENY",
"x-matched-path": "/_sites/[subdomain]/[[...slug]]",
26
 "x-powered-by": "Next.js",
"x-vercel-cache": "HIT",
"x-vercel-id":
"iad1::iad1::55zsr-1741218408801-63899943f988",
"x-firefox-spdy": "h2"
}
},
"screenshotUrl": null,
"text": "Mark Message As Read - Evolution API Documentation
\nAuthorizations\nYour authorization key header\nPath
Parameters\nID of the instance to connect\nBody\nMessages to
be mark as read\nChat contact or group remote JID\nIf the
message was sent by the instance owner or the contact\nA brief
message describing the action performed.\nThe status of the
read action.",
"markdown": "# Mark Message As Read - Evolution API
Documentation\n\n#### Authorizations\n\nYour authorization key
header\n\n#### Path Parameters\n\nID of the instance to
connect\n\n#### Body\n\nMessages to be mark as read\n\nChat
contact or group remote JID\n\nIf the message was sent by the
instance owner or the contact\n\nA brief message describing
the action performed.\n\nThe status of the read action.",
"debug": {
"requestHandlerMode": "browser"
}
},
{
"url": "https://doc.evolution-api.com/v1/api-
reference/instance-controller/connection-state",
"crawl": {
"loadedUrl": "https://doc.evolution-api.com/v1/api-
reference/instance-controller/connection-state",
"loadedTime": "2025-03-05T23:46:53.436Z",
"referrerUrl": "https://doc.evolution-api.com/v1/api-
reference/chat-controller/check-is-whatsapp",
"depth": null,
"httpStatusCode": 200
},
"metadata": {
"canonicalUrl": "https://doc.evolution-api.com/v1/api-
reference/instance-controller/connection-state",
"title": "Connection State - Evolution API Documentation",
"description": "Gets the state of the connection",
"author": null,
"keywords": null,
"languageCode": "en",
"openGraph": [
{
"property": "og:image:width",
"content": "1200"
},
{
"property": "og:image:height",
"content": "630"
},
{
"property": "twitter:image:width",
27
 "content": "1200"
},
{
"property": "twitter:image:height",
"content": "630"
},
{
"property": "og:image",
"content": "https://doc.evolution-api.com/api/og?
division=Documentation&title=Connection+State&description=Gets
+the+state+of+the+connection&logoLight=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover.png&logoDark=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover-white.png&primaryColor=%2349BC94
&lightColor=%2349BC94&darkColor=%2349BC94"
},
{
"property": "twitter:image",
"content": "https://doc.evolution-api.com/api/og?
division=Documentation&title=Connection+State&description=Gets
+the+state+of+the+connection&logoLight=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover.png&logoDark=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover-white.png&primaryColor=%2349BC94
&lightColor=%2349BC94&darkColor=%2349BC94"
}
],
"jsonLd": null,
"headers": {
"age": "242",
"cache-control": "public, max-age=0, must-revalidate",
"content-encoding": "br",
"content-type": "text/html; charset=utf-8",
"date": "Wed, 05 Mar 2025 23:42:46 GMT",
"etag": "W/\"iyl7ndel8a5jm7\"",
"server": "Vercel",
"strict-transport-security": "max-age=63072000",
"x-frame-options": "DENY",
"x-matched-path": "/_sites/[subdomain]/[[...slug]]",
"x-powered-by": "Next.js",
"x-vercel-cache": "HIT",
"x-vercel-id":
"iad1::iad1::flsj6-1741218409655-882c69226e04",
"x-firefox-spdy": "h2"
}
},
"screenshotUrl": null,
"text": "Connection State - Evolution API Documentation
\nAuthorizations\nYour authorization key header\nPath
Parameters\nID of the instance to connect\nThe name of the
instance.\nThe state of the instance.",
"markdown": "# Connection State - Evolution API
Documentation\n\n#### Authorizations\n\nYour authorization key
header\n\n#### Path Parameters\n\nID of the instance to
connect\n\nThe name of the instance.\n\nThe state of the
28
instance.",
"debug": {
"requestHandlerMode": "browser"
}
},
{
"url": "https://doc.evolution-api.com/v1/api-reference/chat-
controller/send-presence",
"crawl": {
"loadedUrl": "https://doc.evolution-api.com/v1/api-
reference/chat-controller/send-presence",
"loadedTime": "2025-03-05T23:46:58.755Z",
"referrerUrl": "https://doc.evolution-api.com/v1/api-
reference/chat-controller/check-is-whatsapp",
"depth": null,
"httpStatusCode": 200
},
"metadata": {
"canonicalUrl": "https://doc.evolution-api.com/v1/api-
reference/chat-controller/send-presence",
"title": "Send Presence - Evolution API Documentation",
"description": "Send Presence (typing...)",
"author": null,
"keywords": null,
"languageCode": "en",
"openGraph": [
{
"property": "og:image:width",
"content": "1200"
},
{
"property": "og:image:height",
"content": "630"
},
{
"property": "twitter:image:width",
"content": "1200"
},
{
"property": "twitter:image:height",
"content": "630"
},
{
"property": "og:image",
"content": "https://doc.evolution-api.com/api/og?
division=Documentation&title=Send+Presence&description=Send+Pr
esence+%28typing...%29&logoLight=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover.png&logoDark=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover-white.png&primaryColor=%2349BC94&lightColor=%2349BC94
&darkColor=%2349BC94"
},
{
"property": "twitter:image",
"content": "https://doc.evolution-api.com/api/og?
division=Documentation&title=Send+Presence&description=Send+Pr
29
esence+%28typing...%29&logoLight=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover.png&logoDark=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover-white.png&primaryColor=%2349BC94&lightColor=%2349BC94
&darkColor=%2349BC94"
}
],
"jsonLd": null,
"headers": {
"age": "225",
"cache-control": "public, max-age=0, must-revalidate",
"content-encoding": "br",
"content-type": "text/html; charset=utf-8",
"date": "Wed, 05 Mar 2025 23:43:10 GMT",
"etag": "W/\"juij2aj6fk5fxr\"",
"server": "Vercel",
"strict-transport-security": "max-age=63072000",
"x-frame-options": "DENY",
"x-matched-path": "/_sites/[subdomain]/[[...slug]]",
"x-powered-by": "Next.js",
"x-vercel-cache": "HIT",
"x-vercel-id":
"iad1::iad1::zsc6n-1741218416667-301f09970236",
"x-firefox-spdy": "h2"
}
},
"screenshotUrl": null,
"text": "Send Presence - Evolution API Documentation
\nAuthorizations\nYour authorization key header\nPath
Parameters\nID of the instance to connect\nBody\nReceiver
phone number with country code\nPresence display time in
milliseconds\nPresence type\nAvailable options:\ncomposing,
\nrecording",
"markdown": "# Send Presence - Evolution API Documentation\n
\n#### Authorizations\n\nYour authorization key header\n\n####
Path Parameters\n\nID of the instance to connect\n\n#### Body
\n\nReceiver phone number with country code\n\nPresence
display time in milliseconds\n\nPresence type\n\nAvailable
options:\n\n`composing`,\n\n`recording`",
"debug": {
"requestHandlerMode": "browser"
}
},
{
"url": "https://doc.evolution-api.com/v1/api-
reference/instance-controller/logout-instance",
"crawl": {
"loadedUrl": "https://doc.evolution-api.com/v1/api-
reference/instance-controller/logout-instance",
"loadedTime": "2025-03-05T23:47:03.055Z",
"referrerUrl": "https://doc.evolution-api.com/v1/api-
reference/chat-controller/check-is-whatsapp",
"depth": null
},
"metadata": {
"canonicalUrl": "https://doc.evolution-api.com/v1/api-
30
reference/instance-controller/logout-instance",
"title": "Logout Instance - Evolution API Documentation",
"description": "Makes logout on instance",
"author": null,
"keywords": null,
"languageCode": "en",
"openGraph": [
{
"property": "og:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Logout+Instance&description=Makes
+logout+on+instance&logoLight=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover.png&logoDark=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover-white.png&primaryColor=%2349BC94&lightColor=%2349BC94
&darkColor=%2349BC94"
},
{
"property": "og:image:width",
"content": "1200"
},
{
"property": "og:image:height",
"content": "630"
},
{
"property": "twitter:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Logout+Instance&description=Makes
+logout+on+instance&logoLight=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover.png&logoDark=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover-white.png&primaryColor=%2349BC94&lightColor=%2349BC94
&darkColor=%2349BC94"
},
{
"property": "twitter:image:width",
"content": "1200"
},
{
"property": "twitter:image:height",
"content": "630"
}
],
"jsonLd": null,
"headers": {
"age": "255",
"cache-control": "public, max-age=0, must-revalidate",
"content-encoding": "br",
"content-type": "text/html; charset=utf-8",
"date": "Wed, 05 Mar 2025 23:42:46 GMT",
"etag": "W/\"sbzzu7nuww5l7n\"",
"server": "Vercel",
"strict-transport-security": "max-age=63072000",
"x-frame-options": "DENY",
31
 "x-matched-path": "/_sites/[subdomain]/[[...slug]]",
"x-powered-by": "Next.js",
"x-vercel-cache": "HIT",
"x-vercel-id":
"iad1::iad1::sx7mg-1741218422925-80232e86ca13",
"transfer-encoding": "chunked"
}
},
"screenshotUrl": null,
"text": "Logout Instance - Evolution API Documentation
\nAuthorizations\nYour authorization key header\nPath
Parameters\nID of the instance to connect\nThe status of the
response.\nIndicates whether an error occurred.\nA message
related to the response.",
"markdown": "# Logout Instance - Evolution API Documentation
\n\n#### Authorizations\n\nYour authorization key header\n
\n#### Path Parameters\n\nID of the instance to connect\n\nThe
status of the response.\n\nIndicates whether an error
occurred.\n\nA message related to the response.",
"debug": {
"requestHandlerMode": "http"
}
},
{
"url": "https://doc.evolution-api.com/v1/api-reference/chat-
controller/find-contacts",
"crawl": {
"loadedUrl": "https://doc.evolution-api.com/v1/api-
reference/chat-controller/find-contacts",
"loadedTime": "2025-03-05T23:47:04.924Z",
"referrerUrl": "https://doc.evolution-api.com/v1/api-
reference/chat-controller/check-is-whatsapp",
"depth": null
},
"metadata": {
"canonicalUrl": "https://doc.evolution-api.com/v1/api-
reference/chat-controller/find-contacts",
"title": "Find Contacts - Evolution API Documentation",
"description": "Find all contacts or just one from ID",
"author": null,
"keywords": null,
"languageCode": "en",
"openGraph": [
{
"property": "og:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Find+Contacts&description=Find+al
l+contacts+or+just+one+from+ID&logoLight=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover.png&logoDark=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover-white.png&primaryColor=%2349BC94
&lightColor=%2349BC94&darkColor=%2349BC94"
},
{
"property": "og:image:width",
"content": "1200"
32
 },
{
"property": "og:image:height",
"content": "630"
},
{
"property": "twitter:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Find+Contacts&description=Find+al
l+contacts+or+just+one+from+ID&logoLight=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover.png&logoDark=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover-white.png&primaryColor=%2349BC94
&lightColor=%2349BC94&darkColor=%2349BC94"
},
{
"property": "twitter:image:width",
"content": "1200"
},
{
"property": "twitter:image:height",
"content": "630"
}
],
"jsonLd": null,
"headers": {
"age": "209",
"cache-control": "public, max-age=0, must-revalidate",
"content-encoding": "br",
"content-type": "text/html; charset=utf-8",
"date": "Wed, 05 Mar 2025 23:43:35 GMT",
"etag": "W/\"14ix7goekrt5c6g\"",
"server": "Vercel",
"strict-transport-security": "max-age=63072000",
"x-frame-options": "DENY",
"x-matched-path": "/_sites/[subdomain]/[[...slug]]",
"x-powered-by": "Next.js",
"x-vercel-cache": "HIT",
"x-vercel-id":
"iad1::iad1::gv5pp-1741218424854-6e3252839b13",
"transfer-encoding": "chunked"
}
},
"screenshotUrl": null,
"text": "Find Contacts - Evolution API Documentation\nFind
all contacts or just one from ID\nAuthorizations\nYour
authorization key header\nPath Parameters\nID of the instance
to connect\nBody",
"markdown": "# Find Contacts - Evolution API Documentation\n
\nFind all contacts or just one from ID\n\n#### Authorizations
\n\nYour authorization key header\n\n#### Path Parameters\n
\nID of the instance to connect\n\n#### Body",
"debug": {
"requestHandlerMode": "http"
}
},
33
{
"url": "https://doc.evolution-api.com/v1/api-
reference/instance-controller/delete-instance",
"crawl": {
"loadedUrl": "https://doc.evolution-api.com/v1/api-
reference/instance-controller/delete-instance",
"loadedTime": "2025-03-05T23:47:05.114Z",
"referrerUrl": "https://doc.evolution-api.com/v1/api-
reference/chat-controller/check-is-whatsapp",
"depth": null
},
"metadata": {
"canonicalUrl": "https://doc.evolution-api.com/v1/api-
reference/instance-controller/delete-instance",
"title": "Delete Instance - Evolution API Documentation",
"description": "Deletes instance",
"author": null,
"keywords": null,
"languageCode": "en",
"openGraph": [
{
"property": "og:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Delete+Instance&description=Delet
es+instance&logoLight=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover.png&logoDark=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover-white.png&primaryColor=%2349BC94&lightColor=%2349BC94
&darkColor=%2349BC94"
},
{
"property": "og:image:width",
"content": "1200"
},
{
"property": "og:image:height",
"content": "630"
},
{
"property": "twitter:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Delete+Instance&description=Delet
es+instance&logoLight=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover.png&logoDark=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover-white.png&primaryColor=%2349BC94&lightColor=%2349BC94
&darkColor=%2349BC94"
},
{
"property": "twitter:image:width",
"content": "1200"
},
{
"property": "twitter:image:height",
"content": "630"
34
 }
],
"jsonLd": null,
"headers": {
"age": "257",
"cache-control": "public, max-age=0, must-revalidate",
"content-encoding": "br",
"content-type": "text/html; charset=utf-8",
"date": "Wed, 05 Mar 2025 23:42:46 GMT",
"etag": "W/\"c7hzqp44r5l4v\"",
"server": "Vercel",
"strict-transport-security": "max-age=63072000",
"x-frame-options": "DENY",
"x-matched-path": "/_sites/[subdomain]/[[...slug]]",
"x-powered-by": "Next.js",
"x-vercel-cache": "HIT",
"x-vercel-id": "iad1::iad1::nb2fl-1741218425032-
a1154e694da2",
"transfer-encoding": "chunked"
}
},
"screenshotUrl": null,
"text": "Delete Instance - Evolution API Documentation
\nAuthorizations\nYour authorization key header\nPath
Parameters\nID of the instance to connect\nThe status of the
response.\nIndicates whether an error occurred.\nA message
related to the response.",
"markdown": "# Delete Instance - Evolution API Documentation
\n\n#### Authorizations\n\nYour authorization key header\n
\n#### Path Parameters\n\nID of the instance to connect\n\nThe
status of the response.\n\nIndicates whether an error
occurred.\n\nA message related to the response.",
"debug": {
"requestHandlerMode": "http"
}
},
{
"url": "https://doc.evolution-api.com/v1/api-reference/chat-
controller/find-messages",
"crawl": {
"loadedUrl": "https://doc.evolution-api.com/v1/api-
reference/chat-controller/find-messages",
"loadedTime": "2025-03-05T23:47:06.823Z",
"referrerUrl": "https://doc.evolution-api.com/v1/api-
reference/chat-controller/check-is-whatsapp",
"depth": null
},
"metadata": {
"canonicalUrl": "https://doc.evolution-api.com/v1/api-
reference/chat-controller/find-messages",
"title": "Find Messages - Evolution API Documentation",
"description": "Find all messages",
"author": null,
"keywords": null,
"languageCode": "en",
"openGraph": [
{
35
 "property": "og:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Find+Messages&description=Find+al
l+messages&logoLight=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover.png&logoDark=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover-white.png&primaryColor=%2349BC94&lightColor=%2349BC94
&darkColor=%2349BC94"
},
{
"property": "og:image:width",
"content": "1200"
},
{
"property": "og:image:height",
"content": "630"
},
{
"property": "twitter:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Find+Messages&description=Find+al
l+messages&logoLight=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover.png&logoDark=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover-white.png&primaryColor=%2349BC94&lightColor=%2349BC94
&darkColor=%2349BC94"
},
{
"property": "twitter:image:width",
"content": "1200"
},
{
"property": "twitter:image:height",
"content": "630"
}
],
"jsonLd": null,
"headers": {
"age": "211",
"cache-control": "public, max-age=0, must-revalidate",
"content-encoding": "br",
"content-type": "text/html; charset=utf-8",
"date": "Wed, 05 Mar 2025 23:43:35 GMT",
"etag": "W/\"hx40eyc9wh5e8a\"",
"server": "Vercel",
"strict-transport-security": "max-age=63072000",
"x-frame-options": "DENY",
"x-matched-path": "/_sites/[subdomain]/[[...slug]]",
"x-powered-by": "Next.js",
"x-vercel-cache": "HIT",
"x-vercel-id":
"iad1::iad1::f7psz-1741218426766-6784d7d7d814",
"transfer-encoding": "chunked"
}
},
36
 "screenshotUrl": null,
"text": "Find Messages - Evolution API Documentation
\nAuthorizations\nYour authorization key header\nPath
Parameters\nID of the instance to connect\nBody\nContact or
group remote JID",
"markdown": "# Find Messages - Evolution API Documentation\n
\n#### Authorizations\n\nYour authorization key header\n\n####
Path Parameters\n\nID of the instance to connect\n\n#### Body
\n\nContact or group remote JID",
"debug": {
"requestHandlerMode": "http"
}
},
{
"url": "https://doc.evolution-api.com/v1/api-reference/chat-
controller/find-status-message",
"crawl": {
"loadedUrl": "https://doc.evolution-api.com/v1/api-
reference/chat-controller/find-status-message",
"loadedTime": "2025-03-05T23:47:07.136Z",
"referrerUrl": "https://doc.evolution-api.com/v1/api-
reference/chat-controller/check-is-whatsapp",
"depth": null
},
"metadata": {
"canonicalUrl": "https://doc.evolution-api.com/v1/api-
reference/chat-controller/find-status-message",
"title": "Find Status Message - Evolution API
Documentation",
"description": "Find status message",
"author": null,
"keywords": null,
"languageCode": "en",
"openGraph": [
{
"property": "og:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Find+Status+Message&description=F
ind+status+message&logoLight=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover.png&logoDark=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover-white.png&primaryColor=%2349BC94&lightColor=%2349BC94
&darkColor=%2349BC94"
},
{
"property": "og:image:width",
"content": "1200"
},
{
"property": "og:image:height",
"content": "630"
},
{
"property": "twitter:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Find+Status+Message&description=F
37
ind+status+message&logoLight=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover.png&logoDark=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover-white.png&primaryColor=%2349BC94&lightColor=%2349BC94
&darkColor=%2349BC94"
},
{
"property": "twitter:image:width",
"content": "1200"
},
{
"property": "twitter:image:height",
"content": "630"
}
],
"jsonLd": null,
"headers": {
"age": "211",
"cache-control": "public, max-age=0, must-revalidate",
"content-encoding": "br",
"content-type": "text/html; charset=utf-8",
"date": "Wed, 05 Mar 2025 23:43:35 GMT",
"etag": "W/\"laee2f54st5icm\"",
"server": "Vercel",
"strict-transport-security": "max-age=63072000",
"x-frame-options": "DENY",
"x-matched-path": "/_sites/[subdomain]/[[...slug]]",
"x-powered-by": "Next.js",
"x-vercel-cache": "HIT",
"x-vercel-id":
"iad1::iad1::69h6m-1741218426980-3bf7b993d314",
"transfer-encoding": "chunked"
}
},
"screenshotUrl": null,
"text": "Find Status Message - Evolution API Documentation
\nAuthorizations\nYour authorization key header\nPath
Parameters\nID of the instance to connect\nBody\nMessage ID
(from WhatsApp)\nContact or group remote JID\nWhether the
message is from the instance owner or not",
"markdown": "# Find Status Message - Evolution API
Documentation\n\n#### Authorizations\n\nYour authorization key
header\n\n#### Path Parameters\n\nID of the instance to
connect\n\n#### Body\n\nMessage ID (from WhatsApp)\n\nContact
or group remote JID\n\nWhether the message is from the
instance owner or not",
"debug": {
"requestHandlerMode": "http"
}
},
{
"url": "https://doc.evolution-api.com/v1/api-
reference/instance-controller/set-presence",
"crawl": {
"loadedUrl": "https://doc.evolution-api.com/v1/api-
reference/instance-controller/set-presence",
38
 "loadedTime": "2025-03-05T23:47:08.858Z",
"referrerUrl": "https://doc.evolution-api.com/v1/api-
reference/chat-controller/check-is-whatsapp",
"depth": null
},
"metadata": {
"canonicalUrl": "https://doc.evolution-api.com/v1/api-
reference/instance-controller/set-presence",
"title": "Set Presence - Evolution API Documentation",
"description": "Deletes instance",
"author": null,
"keywords": null,
"languageCode": "en",
"openGraph": [
{
"property": "og:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Set+Presence&description=Deletes+
instance&logoLight=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover.png&logoDark=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover-white.png&primaryColor=%2349BC94&lightColor=%2349BC94
&darkColor=%2349BC94"
},
{
"property": "og:image:width",
"content": "1200"
},
{
"property": "og:image:height",
"content": "630"
},
{
"property": "twitter:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Set+Presence&description=Deletes+
instance&logoLight=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover.png&logoDark=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover-white.png&primaryColor=%2349BC94&lightColor=%2349BC94
&darkColor=%2349BC94"
},
{
"property": "twitter:image:width",
"content": "1200"
},
{
"property": "twitter:image:height",
"content": "630"
}
],
"jsonLd": null,
"headers": {
"age": "261",
"cache-control": "public, max-age=0, must-revalidate",
39
 "content-encoding": "br",
"content-type": "text/html; charset=utf-8",
"date": "Wed, 05 Mar 2025 23:42:46 GMT",
"etag": "W/\"r4xs9keh55etz\"",
"server": "Vercel",
"strict-transport-security": "max-age=63072000",
"x-frame-options": "DENY",
"x-matched-path": "/_sites/[subdomain]/[[...slug]]",
"x-powered-by": "Next.js",
"x-vercel-cache": "HIT",
"x-vercel-id":
"iad1::iad1::b9j5n-1741218428782-79394d1c97ff",
"transfer-encoding": "chunked"
}
},
"screenshotUrl": null,
"text": "Set Presence - Evolution API Documentation
\nAuthorizations\nYour authorization key header\nPath
Parameters\nID of the instance to connect\nBody\nAvailable
options:\navailable,\nunavailable",
"markdown": "# Set Presence - Evolution API Documentation\n
\n#### Authorizations\n\nYour authorization key header\n\n####
Path Parameters\n\nID of the instance to connect\n\n#### Body
\n\nAvailable options:\n\n`available`,\n\n`unavailable`",
"debug": {
"requestHandlerMode": "http"
}
},
{
"url": "https://doc.evolution-api.com/v1/api-
reference/webhook/set",
"crawl": {
"loadedUrl": "https://doc.evolution-api.com/v1/api-
reference/webhook/set",
"loadedTime": "2025-03-05T23:47:08.995Z",
"referrerUrl": "https://doc.evolution-api.com/v1/api-
reference/chat-controller/check-is-whatsapp",
"depth": null
},
"metadata": {
"canonicalUrl": "https://doc.evolution-api.com/v1/api-
reference/webhook/set",
"title": "Set Webhook - Evolution API Documentation",
"description": "Set Webhook for instance",
"author": null,
"keywords": null,
"languageCode": "en",
"openGraph": [
{
"property": "og:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Set+Webhook&description=Set+Webho
ok+for+instance&logoLight=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover.png&logoDark=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover-white.png&primaryColor=%2349BC94&lightColor=%2349BC94
40
&darkColor=%2349BC94"
},
{
"property": "og:image:width",
"content": "1200"
},
{
"property": "og:image:height",
"content": "630"
},
{
"property": "twitter:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Set+Webhook&description=Set+Webho
ok+for+instance&logoLight=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover.png&logoDark=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover-white.png&primaryColor=%2349BC94&lightColor=%2349BC94
&darkColor=%2349BC94"
},
{
"property": "twitter:image:width",
"content": "1200"
},
{
"property": "twitter:image:height",
"content": "630"
}
],
"jsonLd": null,
"headers": {
"age": "261",
"cache-control": "public, max-age=0, must-revalidate",
"content-encoding": "br",
"content-type": "text/html; charset=utf-8",
"date": "Wed, 05 Mar 2025 23:42:46 GMT",
"etag": "W/\"vu5w5xypj65wad\"",
"server": "Vercel",
"strict-transport-security": "max-age=63072000",
"x-frame-options": "DENY",
"x-matched-path": "/_sites/[subdomain]/[[...slug]]",
"x-powered-by": "Next.js",
"x-vercel-cache": "HIT",
"x-vercel-id":
"iad1::iad1::69h6m-1741218428872-6e3a5e9b3c1c",
"transfer-encoding": "chunked"
}
},
"screenshotUrl": null,
"text": "Set Webhook - Evolution API Documentation\nSet
Webhook for instance\nAuthorizations\nYour authorization key
header\nPath Parameters\nID of the instance to connect\nBody
\nEvents to be sent to the Webhook\nAvailable options:
\nAPPLICATION_STARTUP,\nQRCODE_UPDATED,\nMESSAGES_SET,
\nMESSAGES_UPSERT,\nMESSAGES_UPDATE,\nMESSAGES_DELETE,
\nSEND_MESSAGE,\nCONTACTS_SET,\nCONTACTS_UPSERT,
41
\nCONTACTS_UPDATE,\nPRESENCE_UPDATE,\nCHATS_SET,
\nCHATS_UPSERT,\nCHATS_UPDATE,\nCHATS_DELETE,\nGROUPS_UPSERT,
\nGROUP_UPDATE,\nGROUP_PARTICIPANTS_UPDATE,
\nCONNECTION_UPDATE,\nCALL,\nNEW_JWT_TOKEN,\nTYPEBOT_START,
\nTYPEBOT_CHANGE_STATUS \nEnables Webhook by events\nSends
files in base64 when available\nThe name of the instance.
\nList of events the webhook is subscribed to.\nIndicates
whether the webhook is enabled.",
"markdown": "# Set Webhook - Evolution API Documentation\n
\nSet Webhook for instance\n\n#### Authorizations\n\nYour
authorization key header\n\n#### Path Parameters\n\nID of the
instance to connect\n\n#### Body\n\nEvents to be sent to the
Webhook\n\nAvailable options:\n\n`APPLICATION_STARTUP`,\n
\n`QRCODE_UPDATED`,\n\n`MESSAGES_SET`,\n\n`MESSAGES_UPSERT`,\n
\n`MESSAGES_UPDATE`,\n\n`MESSAGES_DELETE`,\n\n`SEND_MESSAGE`,
\n\n`CONTACTS_SET`,\n\n`CONTACTS_UPSERT`,\n
\n`CONTACTS_UPDATE`,\n\n`PRESENCE_UPDATE`,\n\n`CHATS_SET`,\n
\n`CHATS_UPSERT`,\n\n`CHATS_UPDATE`,\n\n`CHATS_DELETE`,\n
\n`GROUPS_UPSERT`,\n\n`GROUP_UPDATE`,\n
\n`GROUP_PARTICIPANTS_UPDATE`,\n\n`CONNECTION_UPDATE`,\n
\n`CALL`,\n\n`NEW_JWT_TOKEN`,\n\n`TYPEBOT_START`,\n
\n`TYPEBOT_CHANGE_STATUS`\n\nEnables Webhook by events\n
\nSends files in base64 when available\n\nThe name of the
instance.\n\nList of events the webhook is subscribed to.\n
\nIndicates whether the webhook is enabled.",
"debug": {
"requestHandlerMode": "http"
}
},
{
"url": "https://doc.evolution-api.com/v1/api-reference/chat-
controller/update-message",
"crawl": {
"loadedUrl": "https://doc.evolution-api.com/v1/api-
reference/chat-controller/update-message",
"loadedTime": "2025-03-05T23:47:10.949Z",
"referrerUrl": "https://doc.evolution-api.com/v1/api-
reference/chat-controller/check-is-whatsapp",
"depth": null
},
"metadata": {
"canonicalUrl": "https://doc.evolution-api.com/v1/api-
reference/chat-controller/update-message",
"title": "Update Message - Evolution API Documentation",
"description": "Update message",
"author": null,
"keywords": null,
"languageCode": "en",
"openGraph": [
{
"property": "og:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Update+Message&description=Update
+message&logoLight=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover.png&logoDark=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
42
2Fcover-white.png&primaryColor=%2349BC94&lightColor=%2349BC94
&darkColor=%2349BC94"
},
{
"property": "og:image:width",
"content": "1200"
},
{
"property": "og:image:height",
"content": "630"
},
{
"property": "twitter:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Update+Message&description=Update
+message&logoLight=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover.png&logoDark=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover-white.png&primaryColor=%2349BC94&lightColor=%2349BC94
&darkColor=%2349BC94"
},
{
"property": "twitter:image:width",
"content": "1200"
},
{
"property": "twitter:image:height",
"content": "630"
}
],
"jsonLd": null,
"headers": {
"age": "417",
"cache-control": "public, max-age=0, must-revalidate",
"content-encoding": "br",
"content-type": "text/html; charset=utf-8",
"date": "Wed, 05 Mar 2025 23:40:13 GMT",
"etag": "W/\"rvkja3r5ch5i62\"",
"server": "Vercel",
"strict-transport-security": "max-age=63072000",
"x-frame-options": "DENY",
"x-matched-path": "/_sites/[subdomain]/[[...slug]]",
"x-powered-by": "Next.js",
"x-vercel-cache": "HIT",
"x-vercel-id": "iad1::iad1::fsc7r-1741218430873-
b642dbaae403",
"transfer-encoding": "chunked"
}
},
"screenshotUrl": null,
"text": "Update Message - Evolution API Documentation
\nAuthorizations\nYour authorization key header\nPath
Parameters\nID of the instance to connect\nBody\nReceiver
phone number with country code\nChat contact or group remote
JID\nIf the message was sent by the instance owner or not",
"markdown": "# Update Message - Evolution API Documentation
43
\n\n#### Authorizations\n\nYour authorization key header\n
\n#### Path Parameters\n\nID of the instance to connect\n
\n#### Body\n\nReceiver phone number with country code\n\nChat
contact or group remote JID\n\nIf the message was sent by the
instance owner or not",
"debug": {
"requestHandlerMode": "http"
}
},
{
"url": "https://doc.evolution-api.com/v1/api-reference/chat-
controller/find-chats",
"crawl": {
"loadedUrl": "https://doc.evolution-api.com/v1/api-
reference/chat-controller/find-chats",
"loadedTime": "2025-03-05T23:47:12.939Z",
"referrerUrl": "https://doc.evolution-api.com/v1/api-
reference/chat-controller/check-is-whatsapp",
"depth": null
},
"metadata": {
"canonicalUrl": "https://doc.evolution-api.com/v1/api-
reference/chat-controller/find-chats",
"title": "Find Chats - Evolution API Documentation",
"description": "Find all chats",
"author": null,
"keywords": null,
"languageCode": "en",
"openGraph": [
{
"property": "og:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Find+Chats&description=Find+all+c
hats&logoLight=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover.png&logoDark=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover-white.png&primaryColor=%2349BC94&lightColor=%2349BC94
&darkColor=%2349BC94"
},
{
"property": "og:image:width",
"content": "1200"
},
{
"property": "og:image:height",
"content": "630"
},
{
"property": "twitter:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Find+Chats&description=Find+all+c
hats&logoLight=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover.png&logoDark=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover-white.png&primaryColor=%2349BC94&lightColor=%2349BC94
44
&darkColor=%2349BC94"
},
{
"property": "twitter:image:width",
"content": "1200"
},
{
"property": "twitter:image:height",
"content": "630"
}
],
"jsonLd": null,
"headers": {
"age": "217",
"cache-control": "public, max-age=0, must-revalidate",
"content-encoding": "br",
"content-type": "text/html; charset=utf-8",
"date": "Wed, 05 Mar 2025 23:43:35 GMT",
"etag": "W/\"p8nsdl7baq57h1\"",
"server": "Vercel",
"strict-transport-security": "max-age=63072000",
"x-frame-options": "DENY",
"x-matched-path": "/_sites/[subdomain]/[[...slug]]",
"x-powered-by": "Next.js",
"x-vercel-cache": "HIT",
"x-vercel-id": "iad1::iad1::9z666-1741218432881-
e8b87ca50b7f",
"transfer-encoding": "chunked"
}
},
"screenshotUrl": null,
"text": "Find Chats - Evolution API Documentation\nFind all
chats\nAuthorizations\nYour authorization key header\nPath
Parameters\nID of the instance to connect",
"markdown": "# Find Chats - Evolution API Documentation\n
\nFind all chats\n\n#### Authorizations\n\nYour authorization
key header\n\n#### Path Parameters\n\nID of the instance to
connect",
"debug": {
"requestHandlerMode": "http"
}
},
{
"url": "https://doc.evolution-api.com/v1/api-
reference/webhook/get",
"crawl": {
"loadedUrl": "https://doc.evolution-api.com/v1/api-
reference/webhook/get",
"loadedTime": "2025-03-05T23:47:14.845Z",
"referrerUrl": "https://doc.evolution-api.com/v1/api-
reference/chat-controller/check-is-whatsapp",
"depth": null
},
"metadata": {
"canonicalUrl": "https://doc.evolution-api.com/v1/api-
reference/webhook/get",
"title": "Find Webhook - Evolution API Documentation",
45
 "description": "Fetch Webhook configuration",
"author": null,
"keywords": null,
"languageCode": "en",
"openGraph": [
{
"property": "og:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Find+Webhook&description=Fetch+We
bhook+configuration&logoLight=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover.png&logoDark=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover-white.png&primaryColor=%2349BC94&lightColor=%2349BC94
&darkColor=%2349BC94"
},
{
"property": "og:image:width",
"content": "1200"
},
{
"property": "og:image:height",
"content": "630"
},
{
"property": "twitter:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Find+Webhook&description=Fetch+We
bhook+configuration&logoLight=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover.png&logoDark=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover-white.png&primaryColor=%2349BC94&lightColor=%2349BC94
&darkColor=%2349BC94"
},
{
"property": "twitter:image:width",
"content": "1200"
},
{
"property": "twitter:image:height",
"content": "630"
}
],
"jsonLd": null,
"headers": {
"age": "267",
"cache-control": "public, max-age=0, must-revalidate",
"content-encoding": "br",
"content-type": "text/html; charset=utf-8",
"date": "Wed, 05 Mar 2025 23:42:46 GMT",
"etag": "W/\"wupgmw7g2n5gkk\"",
"server": "Vercel",
"strict-transport-security": "max-age=63072000",
"x-frame-options": "DENY",
"x-matched-path": "/_sites/[subdomain]/[[...slug]]",
"x-powered-by": "Next.js",
46
 "x-vercel-cache": "HIT",
"x-vercel-id": "iad1::iad1::gv5pp-1741218434745-
cd5a40578c79",
"transfer-encoding": "chunked"
}
},
"screenshotUrl": null,
"text": "Find Webhook - Evolution API Documentation\nFetch
Webhook configuration\nAuthorizations\nYour authorization key
header\nPath Parameters\nID of the instance to connect
\nIndicates whether the webhook is enabled.\nList of events
the webhook is subscribed to.",
"markdown": "# Find Webhook - Evolution API Documentation\n
\nFetch Webhook configuration\n\n#### Authorizations\n\nYour
authorization key header\n\n#### Path Parameters\n\nID of the
instance to connect\n\nIndicates whether the webhook is
enabled.\n\nList of events the webhook is subscribed to.",
"debug": {
"requestHandlerMode": "http"
}
},
{
"url": "https://doc.evolution-api.com/v1/api-
reference/profile-settings/fetch-business-profile",
"crawl": {
"loadedUrl": "https://doc.evolution-api.com/v1/api-
reference/profile-settings/fetch-business-profile",
"loadedTime": "2025-03-05T23:47:17.621Z",
"referrerUrl": "https://doc.evolution-api.com/v1/api-
reference/chat-controller/check-is-whatsapp",
"depth": null
},
"metadata": {
"canonicalUrl": "https://doc.evolution-api.com/v1/api-
reference/profile-settings/fetch-business-profile",
"title": "Fetch Business Profile - Evolution API
Documentation",
"description": "Fetch business profile from phone number",
"author": null,
"keywords": null,
"languageCode": "en",
"openGraph": [
{
"property": "og:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Fetch+Business+Profile&descriptio
n=Fetch+business+profile+from+phone+number&logoLight=https%3A%
2F%2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover.png&logoDark=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover-white.png&primaryColor=%2349BC94
&lightColor=%2349BC94&darkColor=%2349BC94"
},
{
"property": "og:image:width",
"content": "1200"
},
47
 {
"property": "og:image:height",
"content": "630"
},
{
"property": "twitter:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Fetch+Business+Profile&descriptio
n=Fetch+business+profile+from+phone+number&logoLight=https%3A%
2F%2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover.png&logoDark=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover-white.png&primaryColor=%2349BC94
&lightColor=%2349BC94&darkColor=%2349BC94"
},
{
"property": "twitter:image:width",
"content": "1200"
},
{
"property": "twitter:image:height",
"content": "630"
}
],
"jsonLd": null,
"headers": {
"age": "221",
"cache-control": "public, max-age=0, must-revalidate",
"content-encoding": "br",
"content-type": "text/html; charset=utf-8",
"date": "Wed, 05 Mar 2025 23:43:35 GMT",
"etag": "W/\"31z9kvwnot5a94\"",
"server": "Vercel",
"strict-transport-security": "max-age=63072000",
"x-frame-options": "DENY",
"x-matched-path": "/_sites/[subdomain]/[[...slug]]",
"x-powered-by": "Next.js",
"x-vercel-cache": "HIT",
"x-vercel-id": "iad1::iad1::fsc7r-1741218437014-
f03846e5ea88",
"transfer-encoding": "chunked"
}
},
"screenshotUrl": null,
"text": "Fetch Business Profile - Evolution API
Documentation\nFetch business profile from phone number
\nAuthorizations\nYour authorization key header\nPath
Parameters\nID of the instance to connect\nBody\nPhone number
with country code",
"markdown": "# Fetch Business Profile - Evolution API
Documentation\n\nFetch business profile from phone number\n
\n#### Authorizations\n\nYour authorization key header\n\n####
Path Parameters\n\nID of the instance to connect\n\n#### Body
\n\nPhone number with country code",
"debug": {
"requestHandlerMode": "http"
}
48
},
{
"url": "https://doc.evolution-api.com/v1/api-
reference/settings/set",
"crawl": {
"loadedUrl": "https://doc.evolution-api.com/v1/api-
reference/settings/set",
"loadedTime": "2025-03-05T23:47:19.540Z",
"referrerUrl": "https://doc.evolution-api.com/v1/api-
reference/chat-controller/check-is-whatsapp",
"depth": null
},
"metadata": {
"canonicalUrl": "https://doc.evolution-api.com/v1/api-
reference/settings/set",
"title": "Set Settings - Evolution API Documentation",
"description": "Set settings",
"author": null,
"keywords": null,
"languageCode": "en",
"openGraph": [
{
"property": "og:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Set+Settings&description=Set+sett
ings&logoLight=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover.png&logoDark=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover-white.png&primaryColor=%2349BC94&lightColor=%2349BC94
&darkColor=%2349BC94"
},
{
"property": "og:image:width",
"content": "1200"
},
{
"property": "og:image:height",
"content": "630"
},
{
"property": "twitter:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Set+Settings&description=Set+sett
ings&logoLight=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover.png&logoDark=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover-white.png&primaryColor=%2349BC94&lightColor=%2349BC94
&darkColor=%2349BC94"
},
{
"property": "twitter:image:width",
"content": "1200"
},
{
"property": "twitter:image:height",
49
 "content": "630"
}
],
"jsonLd": null,
"headers": {
"age": "272",
"cache-control": "public, max-age=0, must-revalidate",
"content-encoding": "br",
"content-type": "text/html; charset=utf-8",
"date": "Wed, 05 Mar 2025 23:42:46 GMT",
"etag": "W/\"xdz4fbsj3w658r\"",
"server": "Vercel",
"strict-transport-security": "max-age=63072000",
"x-frame-options": "DENY",
"x-matched-path": "/_sites/[subdomain]/[[...slug]]",
"x-powered-by": "Next.js",
"x-vercel-cache": "HIT",
"x-vercel-id": "iad1::iad1::f7psz-1741218439445-
e96472fa63ab",
"transfer-encoding": "chunked"
}
},
"screenshotUrl": null,
"text": "Set Settings - Evolution API Documentation\nSet
settings\ncurl --request POST \\ --url https://{server-
url}/settings/set/{instance} \\ --header 'Content-Type:
application/json' \\ --header 'apikey: <api-key>' \\ --data
'{ \"reject_call\": true, \"msg_call\": \"<string>\",
\"groups_ignore\": true, \"always_online\": true,
\"read_messages\": true, \"read_status\": true,
\"sync_full_history\": true }'\n{ \"settings\":
{ \"instanceName\": \"teste-docs\", \"settings\":
{ \"reject_call\": true, \"groups_ignore\": true,
\"always_online\": true, \"read_messages\": true,
\"read_status\": true, \"sync_full_history\":
false } } }\nAuthorizations\nYour authorization key header
\nPath Parameters\nID of the instance to connect\nBody\nReject
calls automatically\nAlways show WhatsApp online\nSyncronize
full WhatsApp history with EvolutionAPI\nMessage to be sent
when a call is rejected automatically\nThe name of the
instance.\nsettings.settings.reject_call\nIndicates whether to
reject incoming calls.\nsettings.settings.groups_ignore
\nIndicates whether to ignore group messages.
\nsettings.settings.always_online\nIndicates whether to always
keep the instance online.\nsettings.settings.read_messages
\nIndicates whether to mark messages as read.
\nsettings.settings.read_status\nIndicates whether to read
status updates.\nsettings.settings.sync_full_history
\nIndicates whether to synchronize full message history.
\ncurl --request POST \\ --url https://{server-
url}/settings/set/{instance} \\ --header 'Content-Type:
application/json' \\ --header 'apikey: <api-key>' \\ --data
'{ \"reject_call\": true, \"msg_call\": \"<string>\",
\"groups_ignore\": true, \"always_online\": true,
\"read_messages\": true, \"read_status\": true,
\"sync_full_history\": true }'\n{ \"settings\":
{ \"instanceName\": \"teste-docs\", \"settings\":
50
{ \"reject_call\": true, \"groups_ignore\": true,
\"always_online\": true, \"read_messages\": true,
\"read_status\": true, \"sync_full_history\": false } } }",
"markdown": "# Set Settings - Evolution API Documentation\n
\nSet settings\n\n```\ncurl --request POST \\\n --url
https://{server-url}/settings/set/{instance} \\\n --header
'Content-Type: application/json' \\\n --header 'apikey: <api-
key>' \\\n --data '{\n \"reject_call\": true,\n \"msg_call
\": \"<string>\",\n \"groups_ignore\": true,\n
\"always_online\": true,\n \"read_messages\": true,\n
\"read_status\": true,\n \"sync_full_history\": true\n}'\n```
\n\n```\n{\n \"settings\": {\n \"instanceName\": \"teste-
docs\",\n \"settings\": {\n \"reject_call\": true,\n
\"groups_ignore\": true,\n \"always_online\": true,\n
\"read_messages\": true,\n \"read_status\": true,\n
\"sync_full_history\": false\n }\n }\n}\n```\n\n####
Authorizations\n\nYour authorization key header\n\n#### Path
Parameters\n\nID of the instance to connect\n\n#### Body\n
\nReject calls automatically\n\nAlways show WhatsApp online\n
\nSyncronize full WhatsApp history with EvolutionAPI\n
\nMessage to be sent when a call is rejected automatically\n
\nThe name of the instance.\n\nsettings.settings.reject\\_call
\n\nIndicates whether to reject incoming calls.\n
\nsettings.settings.groups\\_ignore\n\nIndicates whether to
ignore group messages.\n\nsettings.settings.always\\_online\n
\nIndicates whether to always keep the instance online.\n
\nsettings.settings.read\\_messages\n\nIndicates whether to
mark messages as read.\n\nsettings.settings.read\\_status\n
\nIndicates whether to read status updates.\n
\nsettings.settings.sync\\_full\\_history\n\nIndicates whether
to synchronize full message history.\n\n```\ncurl --request
POST \\\n --url https://{server-url}/settings/set/{instance}
\\\n --header 'Content-Type: application/json' \\\n --header
'apikey: <api-key>' \\\n --data '{\n \"reject_call\": true,
\n \"msg_call\": \"<string>\",\n \"groups_ignore\": true,\n
\"always_online\": true,\n \"read_messages\": true,\n
\"read_status\": true,\n \"sync_full_history\": true\n}'\n```
\n\n```\n{\n \"settings\": {\n \"instanceName\": \"teste-
docs\",\n \"settings\": {\n \"reject_call\": true,\n
\"groups_ignore\": true,\n \"always_online\": true,\n
\"read_messages\": true,\n \"read_status\": true,\n
\"sync_full_history\": false\n }\n }\n}\n```",
"debug": {
"requestHandlerMode": "http"
}
},
{
"url": "https://doc.evolution-api.com/v1/api-
reference/profile-settings/fetch-profile",
"crawl": {
"loadedUrl": "https://doc.evolution-api.com/v1/api-
reference/profile-settings/fetch-profile",
"loadedTime": "2025-03-05T23:47:20.640Z",
"referrerUrl": "https://doc.evolution-api.com/v1/api-
reference/chat-controller/check-is-whatsapp",
"depth": null
},
51
 "metadata": {
"canonicalUrl": "https://doc.evolution-api.com/v1/api-
reference/profile-settings/fetch-profile",
"title": "Fetch Profile - Evolution API Documentation",
"description": "Fetch business profile from phone number",
"author": null,
"keywords": null,
"languageCode": "en",
"openGraph": [
{
"property": "og:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Fetch+Profile&description=Fetch+b
usiness+profile+from+phone+number&logoLight=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover.png&logoDark=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover-white.png&primaryColor=%2349BC94
&lightColor=%2349BC94&darkColor=%2349BC94"
},
{
"property": "og:image:width",
"content": "1200"
},
{
"property": "og:image:height",
"content": "630"
},
{
"property": "twitter:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Fetch+Profile&description=Fetch+b
usiness+profile+from+phone+number&logoLight=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover.png&logoDark=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover-white.png&primaryColor=%2349BC94
&lightColor=%2349BC94&darkColor=%2349BC94"
},
{
"property": "twitter:image:width",
"content": "1200"
},
{
"property": "twitter:image:height",
"content": "630"
}
],
"jsonLd": null,
"headers": {
"age": "225",
"cache-control": "public, max-age=0, must-revalidate",
"content-encoding": "br",
"content-type": "text/html; charset=utf-8",
"date": "Wed, 05 Mar 2025 23:43:35 GMT",
"etag": "W/\"awac51iqie5a4l\"",
"server": "Vercel",
52
 "strict-transport-security": "max-age=63072000",
"x-frame-options": "DENY",
"x-matched-path": "/_sites/[subdomain]/[[...slug]]",
"x-powered-by": "Next.js",
"x-vercel-cache": "HIT",
"x-vercel-id":
"iad1::iad1::9z666-1741218440447-7b35b208bcb2",
"transfer-encoding": "chunked"
}
},
"screenshotUrl": null,
"text": "Fetch Profile - Evolution API Documentation
\nAuthorizations\nYour authorization key header\nPath
Parameters\nID of the instance to connect\nBody\nPhone number
with country code",
"markdown": "# Fetch Profile - Evolution API Documentation\n
\n#### Authorizations\n\nYour authorization key header\n\n####
Path Parameters\n\nID of the instance to connect\n\n#### Body
\n\nPhone number with country code",
"debug": {
"requestHandlerMode": "http"
}
},
{
"url": "https://doc.evolution-api.com/v1/api-
reference/message-controller/send-template",
"crawl": {
"loadedUrl": "https://doc.evolution-api.com/v1/api-
reference/message-controller/send-template",
"loadedTime": "2025-03-05T23:47:21.638Z",
"referrerUrl": "https://doc.evolution-api.com/v1/api-
reference/chat-controller/check-is-whatsapp",
"depth": null
},
"metadata": {
"canonicalUrl": "https://doc.evolution-api.com/v1/api-
reference/message-controller/send-template",
"title": "Send Template - Evolution API Documentation",
"description": "Send a template message with the Official
WhatsApp API",
"author": null,
"keywords": null,
"languageCode": "en",
"openGraph": [
{
"property": "og:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Send+Template&description=Send+a+
template+message+with+the+Official+WhatsApp+API&logoLight=http
s%3A%2F%2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-
eb1f2775%2Fimages%2Fbrand%2Fcover.png&logoDark=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover-white.png&primaryColor=%2349BC94
&lightColor=%2349BC94&darkColor=%2349BC94"
},
{
"property": "og:image:width",
53
 "content": "1200"
},
{
"property": "og:image:height",
"content": "630"
},
{
"property": "twitter:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Send+Template&description=Send+a+
template+message+with+the+Official+WhatsApp+API&logoLight=http
s%3A%2F%2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-
eb1f2775%2Fimages%2Fbrand%2Fcover.png&logoDark=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover-white.png&primaryColor=%2349BC94
&lightColor=%2349BC94&darkColor=%2349BC94"
},
{
"property": "twitter:image:width",
"content": "1200"
},
{
"property": "twitter:image:height",
"content": "630"
}
],
"jsonLd": null,
"headers": {
"age": "274",
"cache-control": "public, max-age=0, must-revalidate",
"content-encoding": "br",
"content-type": "text/html; charset=utf-8",
"date": "Wed, 05 Mar 2025 23:42:46 GMT",
"etag": "W/\"fybq61u7g75t3g\"",
"server": "Vercel",
"strict-transport-security": "max-age=63072000",
"x-frame-options": "DENY",
"x-matched-path": "/_sites/[subdomain]/[[...slug]]",
"x-powered-by": "Next.js",
"x-vercel-cache": "HIT",
"x-vercel-id":
"iad1::iad1::f7psz-1741218441507-899d9ed0fcf4",
"transfer-encoding": "chunked"
}
},
"screenshotUrl": null,
"text": "Send Template - Evolution API Documentation\nBody
\nMessage receiver number with country code
\ntemplateMessage.components\nTemplate components
\ntemplateMessage.components.type\nAvailable options:\nheader,
\nbody,\nbutton \ntemplateMessage.components.sub_type
\nAvailable options:\nquick_reply,\nurl,\ncopy_code,\ncatalog
\ntemplateMessage.components.index
\ntemplateMessage.components.parameters
\ntemplateMessage.components.parameters.type\nParameter type
\nAvailable options:\npayload,\ntext,\ncoupon_code,\ncurrency,
\ndate_time,\nimage,\ndocument,\nvideo
54
\ntemplateMessage.components.parameters.text",
"markdown": "# Send Template - Evolution API Documentation\n
\n#### Body\n\nMessage receiver number with country code\n
\ntemplateMessage.components\n\nTemplate components\n
\ntemplateMessage.components.type\n\nAvailable options:\n
\n`header`,\n\n`body`,\n\n`button`\n
\ntemplateMessage.components.sub\\_type\n\nAvailable options:
\n\n`quick_reply`,\n\n`url`,\n\n`copy_code`,\n\n`catalog`\n
\ntemplateMessage.components.index\n
\ntemplateMessage.components.parameters\n
\ntemplateMessage.components.parameters.type\n\nParameter type
\n\nAvailable options:\n\n`payload`,\n\n`text`,\n
\n`coupon_code`,\n\n`currency`,\n\n`date_time`,\n\n`image`,\n
\n`document`,\n\n`video`\n
\ntemplateMessage.components.parameters.text",
"debug": {
"requestHandlerMode": "http"
}
},
{
"url": "https://doc.evolution-api.com/v1/api-
reference/profile-settings/update-profile-name",
"crawl": {
"loadedUrl": "https://doc.evolution-api.com/v1/api-
reference/profile-settings/update-profile-name",
"loadedTime": "2025-03-05T23:47:22.554Z",
"referrerUrl": "https://doc.evolution-api.com/v1/api-
reference/chat-controller/check-is-whatsapp",
"depth": null
},
"metadata": {
"canonicalUrl": "https://doc.evolution-api.com/v1/api-
reference/profile-settings/update-profile-name",
"title": "Update Profile Name - Evolution API
Documentation",
"description": "Update profile name",
"author": null,
"keywords": null,
"languageCode": "en",
"openGraph": [
{
"property": "og:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Update+Profile+Name&description=U
pdate+profile+name&logoLight=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover.png&logoDark=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover-white.png&primaryColor=%2349BC94&lightColor=%2349BC94
&darkColor=%2349BC94"
},
{
"property": "og:image:width",
"content": "1200"
},
{
"property": "og:image:height",
55
 "content": "630"
},
{
"property": "twitter:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Update+Profile+Name&description=U
pdate+profile+name&logoLight=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover.png&logoDark=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover-white.png&primaryColor=%2349BC94&lightColor=%2349BC94
&darkColor=%2349BC94"
},
{
"property": "twitter:image:width",
"content": "1200"
},
{
"property": "twitter:image:height",
"content": "630"
}
],
"jsonLd": null,
"headers": {
"age": "226",
"cache-control": "public, max-age=0, must-revalidate",
"content-encoding": "br",
"content-type": "text/html; charset=utf-8",
"date": "Wed, 05 Mar 2025 23:43:35 GMT",
"etag": "W/\"qdo6wzkuuu5a0z\"",
"server": "Vercel",
"strict-transport-security": "max-age=63072000",
"x-frame-options": "DENY",
"x-matched-path": "/_sites/[subdomain]/[[...slug]]",
"x-powered-by": "Next.js",
"x-vercel-cache": "HIT",
"x-vercel-id": "iad1::iad1::f7psz-1741218442461-
d4b681a39be9",
"transfer-encoding": "chunked"
}
},
"screenshotUrl": null,
"text": "Update Profile Name - Evolution API Documentation
\nUpdate profile name\nAuthorizations\nYour authorization key
header\nPath Parameters\nID of the instance to connect\nBody",
"markdown": "# Update Profile Name - Evolution API
Documentation\n\nUpdate profile name\n\n#### Authorizations\n
\nYour authorization key header\n\n#### Path Parameters\n\nID
of the instance to connect\n\n#### Body",
"debug": {
"requestHandlerMode": "http"
}
},
{
"url": "https://doc.evolution-api.com/v1/api-
reference/profile-settings/update-profile-status",
"crawl": {
56
 "loadedUrl": "https://doc.evolution-api.com/v1/api-
reference/profile-settings/update-profile-status",
"loadedTime": "2025-03-05T23:47:23.490Z",
"referrerUrl": "https://doc.evolution-api.com/v1/api-
reference/chat-controller/check-is-whatsapp",
"depth": null
},
"metadata": {
"canonicalUrl": "https://doc.evolution-api.com/v1/api-
reference/profile-settings/update-profile-status",
"title": "Update Profile Status - Evolution API
Documentation",
"description": "Update profile status",
"author": null,
"keywords": null,
"languageCode": "en",
"openGraph": [
{
"property": "og:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Update+Profile+Status&description
=Update+profile+status&logoLight=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover.png&logoDark=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover-white.png&primaryColor=%2349BC94&lightColor=%2349BC94
&darkColor=%2349BC94"
},
{
"property": "og:image:width",
"content": "1200"
},
{
"property": "og:image:height",
"content": "630"
},
{
"property": "twitter:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Update+Profile+Status&description
=Update+profile+status&logoLight=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover.png&logoDark=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover-white.png&primaryColor=%2349BC94&lightColor=%2349BC94
&darkColor=%2349BC94"
},
{
"property": "twitter:image:width",
"content": "1200"
},
{
"property": "twitter:image:height",
"content": "630"
}
],
"jsonLd": null,
57
 "headers": {
"age": "395",
"cache-control": "public, max-age=0, must-revalidate",
"content-encoding": "br",
"content-type": "text/html; charset=utf-8",
"date": "Wed, 05 Mar 2025 23:40:48 GMT",
"etag": "W/\"z1k1t504i95a3r\"",
"server": "Vercel",
"strict-transport-security": "max-age=63072000",
"x-frame-options": "DENY",
"x-matched-path": "/_sites/[subdomain]/[[...slug]]",
"x-powered-by": "Next.js",
"x-vercel-cache": "HIT",
"x-vercel-id":
"iad1::iad1::4kszg-1741218443396-82f31bc29f06",
"transfer-encoding": "chunked"
}
},
"screenshotUrl": null,
"text": "Update Profile Status - Evolution API Documentation
\nUpdate profile status\nAuthorizations\nYour authorization
key header\nPath Parameters\nID of the instance to connect
\nBody",
"markdown": "# Update Profile Status - Evolution API
Documentation\n\nUpdate profile status\n\n#### Authorizations
\n\nYour authorization key header\n\n#### Path Parameters\n
\nID of the instance to connect\n\n#### Body",
"debug": {
"requestHandlerMode": "http"
}
},
{
"url": "https://doc.evolution-api.com/v1/api-
reference/message-controller/send-status",
"crawl": {
"loadedUrl": "https://doc.evolution-api.com/v1/api-
reference/message-controller/send-status",
"loadedTime": "2025-03-05T23:47:25.593Z",
"referrerUrl": "https://doc.evolution-api.com/v1/api-
reference/chat-controller/check-is-whatsapp",
"depth": null
},
"metadata": {
"canonicalUrl": "https://doc.evolution-api.com/v1/api-
reference/message-controller/send-status",
"title": "Send Status - Evolution API Documentation",
"description": "Post WhatsApp status (stories)",
"author": null,
"keywords": null,
"languageCode": "en",
"openGraph": [
{
"property": "og:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Send+Status&description=Post+What
sApp+status+%28stories%29&logoLight=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
58
2Fimages%2Fbrand%2Fcover.png&logoDark=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover-white.png&primaryColor=%2349BC94
&lightColor=%2349BC94&darkColor=%2349BC94"
},
{
"property": "og:image:width",
"content": "1200"
},
{
"property": "og:image:height",
"content": "630"
},
{
"property": "twitter:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Send+Status&description=Post+What
sApp+status+%28stories%29&logoLight=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover.png&logoDark=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover-white.png&primaryColor=%2349BC94
&lightColor=%2349BC94&darkColor=%2349BC94"
},
{
"property": "twitter:image:width",
"content": "1200"
},
{
"property": "twitter:image:height",
"content": "630"
}
],
"jsonLd": null,
"headers": {
"age": "256",
"cache-control": "public, max-age=0, must-revalidate",
"content-encoding": "br",
"content-type": "text/html; charset=utf-8",
"date": "Wed, 05 Mar 2025 23:43:08 GMT",
"etag": "W/\"13z4ryq1mtv6eoy\"",
"server": "Vercel",
"strict-transport-security": "max-age=63072000",
"x-frame-options": "DENY",
"x-matched-path": "/_sites/[subdomain]/[[...slug]]",
"x-powered-by": "Next.js",
"x-vercel-cache": "HIT",
"x-vercel-id": "iad1::iad1::tr4zm-1741218445464-
bcf05559d65a",
"transfer-encoding": "chunked"
}
},
"screenshotUrl": null,
"text": "Send Status - Evolution API Documentation
\nAuthorizations\nYour authorization key header\nPath
Parameters\nID of the instance to connect\nBody\nstatus type
\nAvailable options:\ntext,\nimage,\naudio \nText content for
59
type text or file URL for type image and audio\nText caption
for type image status\nstatusMessage.backgroundColor\n1 -
Serif, 2 - Norican Regular, 3 - Bryndan Write, 4 - BebasNeue
Regular, 5 - Oswald Heavy\nstatusMessage.allContacts\ntrue to
send to all contacts or false to send to statusJidList
\nstatusMessage.statusJidList\nReceivers numbers with country
code\nThe key of the message, which identifies the message in
the chat.\nIndicates whether the message was sent by the user.
\nThe message content, which may include various types of
messages like text, images, etc.\nmessage.extendedTextMessage
\nDetails of the extended text message.
\nmessage.extendedTextMessage.text\nThe text content of the
message.\nmessage.extendedTextMessage.backgroundArgb\nThe
background color of the text message, represented as ARGB
integer value.\nmessage.extendedTextMessage.font\nThe font
used in the text message.\nThe timestamp of the message,
represented as a string.\nThe status of the message, such as
sent, received, or pending.\nThe participant in the chat to
whom the message was sent.",
"markdown": "# Send Status - Evolution API Documentation\n
\n#### Authorizations\n\nYour authorization key header\n\n####
Path Parameters\n\nID of the instance to connect\n\n#### Body
\n\nstatus type\n\nAvailable options:\n\n`text`,\n\n`image`,\n
\n`audio`\n\nText content for type `text` or file URL for type
`image` and `audio`\n\nText caption for type `image` status\n
\nstatusMessage.backgroundColor\n\n1 - Serif, 2 - Norican
Regular, 3 - Bryndan Write, 4 - BebasNeue Regular, 5 - Oswald
Heavy\n\nstatusMessage.allContacts\n\ntrue to send to all
contacts or false to send to statusJidList\n
\nstatusMessage.statusJidList\n\nReceivers numbers with
country code\n\nThe key of the message, which identifies the
message in the chat.\n\nIndicates whether the message was sent
by the user.\n\nThe message content, which may include various
types of messages like text, images, etc.\n
\nmessage.extendedTextMessage\n\nDetails of the extended text
message.\n\nmessage.extendedTextMessage.text\n\nThe text
content of the message.\n
\nmessage.extendedTextMessage.backgroundArgb\n\nThe background
color of the text message, represented as ARGB integer value.
\n\nmessage.extendedTextMessage.font\n\nThe font used in the
text message.\n\nThe timestamp of the message, represented as
a string.\n\nThe status of the message, such as sent,
received, or pending.\n\nThe participant in the chat to whom
the message was sent.",
"debug": {
"requestHandlerMode": "http"
}
},
{
"url": "https://doc.evolution-api.com/v1/api-
reference/profile-settings/update-profile-picture",
"crawl": {
"loadedUrl": "https://doc.evolution-api.com/v1/api-
reference/profile-settings/update-profile-picture",
"loadedTime": "2025-03-05T23:47:27.469Z",
"referrerUrl": "https://doc.evolution-api.com/v1/api-
reference/chat-controller/check-is-whatsapp",
60
 "depth": null
},
"metadata": {
"canonicalUrl": "https://doc.evolution-api.com/v1/api-
reference/profile-settings/update-profile-picture",
"title": "Update Profile Picture - Evolution API
Documentation",
"description": "Update profile picture",
"author": null,
"keywords": null,
"languageCode": "en",
"openGraph": [
{
"property": "og:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Update+Profile+Picture&descriptio
n=Update+profile+picture&logoLight=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover.png&logoDark=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover-white.png&primaryColor=%2349BC94
&lightColor=%2349BC94&darkColor=%2349BC94"
},
{
"property": "og:image:width",
"content": "1200"
},
{
"property": "og:image:height",
"content": "630"
},
{
"property": "twitter:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Update+Profile+Picture&descriptio
n=Update+profile+picture&logoLight=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover.png&logoDark=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover-white.png&primaryColor=%2349BC94
&lightColor=%2349BC94&darkColor=%2349BC94"
},
{
"property": "twitter:image:width",
"content": "1200"
},
{
"property": "twitter:image:height",
"content": "630"
}
],
"jsonLd": null,
"headers": {
"age": "231",
"cache-control": "public, max-age=0, must-revalidate",
"content-encoding": "br",
"content-type": "text/html; charset=utf-8",
61
 "date": "Wed, 05 Mar 2025 23:43:35 GMT",
"etag": "W/\"zjcz6bmveo5a4h\"",
"server": "Vercel",
"strict-transport-security": "max-age=63072000",
"x-frame-options": "DENY",
"x-matched-path": "/_sites/[subdomain]/[[...slug]]",
"x-powered-by": "Next.js",
"x-vercel-cache": "HIT",
"x-vercel-id": "iad1::iad1::g6qvl-1741218447404-
daaa9488e8a2",
"transfer-encoding": "chunked"
}
},
"screenshotUrl": null,
"text": "Update Profile Picture - Evolution API
Documentation\nUpdate profile picture\nAuthorizations\nYour
authorization key header\nPath Parameters\nID of the instance
to connect\nBody",
"markdown": "# Update Profile Picture - Evolution API
Documentation\n\nUpdate profile picture\n\n#### Authorizations
\n\nYour authorization key header\n\n#### Path Parameters\n
\nID of the instance to connect\n\n#### Body",
"debug": {
"requestHandlerMode": "http"
}
},
{
"url": "https://doc.evolution-api.com/v1/api-
reference/message-controller/send-text",
"crawl": {
"loadedUrl": "https://doc.evolution-api.com/v1/api-
reference/message-controller/send-text",
"loadedTime": "2025-03-05T23:47:26.258Z",
"referrerUrl": "https://doc.evolution-api.com/v1/api-
reference/chat-controller/check-is-whatsapp",
"depth": null,
"httpStatusCode": 200
},
"metadata": {
"canonicalUrl": "https://doc.evolution-api.com/v1/api-
reference/message-controller/send-text",
"title": "Send Plain Text - Evolution API Documentation",
"description": "Send plain text message",
"author": null,
"keywords": null,
"languageCode": "en",
"openGraph": [
{
"property": "og:image:width",
"content": "1200"
},
{
"property": "og:image:height",
"content": "630"
},
{
"property": "twitter:image:width",
62
 "content": "1200"
},
{
"property": "twitter:image:height",
"content": "630"
},
{
"property": "og:image",
"content": "https://doc.evolution-api.com/api/og?
division=Documentation&title=Send+Plain+Text&description=Send+
plain+text+message&logoLight=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover.png&logoDark=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover-white.png&primaryColor=%2349BC94&lightColor=%2349BC94
&darkColor=%2349BC94"
},
{
"property": "twitter:image",
"content": "https://doc.evolution-api.com/api/og?
division=Documentation&title=Send+Plain+Text&description=Send+
plain+text+message&logoLight=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover.png&logoDark=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover-white.png&primaryColor=%2349BC94&lightColor=%2349BC94
&darkColor=%2349BC94"
}
],
"jsonLd": null,
"headers": {
"age": "255",
"cache-control": "public, max-age=0, must-revalidate",
"content-encoding": "br",
"content-type": "text/html; charset=utf-8",
"date": "Wed, 05 Mar 2025 23:43:08 GMT",
"etag": "W/\"8qys6kjuao6qr4\"",
"server": "Vercel",
"strict-transport-security": "max-age=63072000",
"x-frame-options": "DENY",
"x-matched-path": "/_sites/[subdomain]/[[...slug]]",
"x-powered-by": "Next.js",
"x-vercel-cache": "HIT",
"x-vercel-id": "iad1::iad1::bv87v-1741218444762-
a999a103a6de",
"x-firefox-spdy": "h2"
}
},
"screenshotUrl": null,
"text": "Send Plain Text - Evolution API Documentation
\nPresence time in milliseconds before sending message
\nPresence type to show\nAvailable options:\ncomposing,
\nrecording \nShows a preview of the target website if there's
a link within the message\noptions.quoted.key.remoteJid
\nReceiver phone number with country code
\noptions.quoted.key.fromMe\nIf the message is from the owner
number\noptions.quoted.key.participant
63
\noptions.quoted.message.conversation
\noptions.mentions.everyOne\noptions.mentions.mentioned
\nReceiver phone number with country code",
"markdown": "# Send Plain Text - Evolution API Documentation
\n\nPresence time in milliseconds before sending message\n
\nPresence type to show\n\nAvailable options:\n\n`composing`,
\n\n`recording`\n\nShows a preview of the target website if
there's a link within the message\n
\noptions.quoted.key.remoteJid\n\nReceiver phone number with
country code\n\noptions.quoted.key.fromMe\n\nIf the message is
from the owner number\n\noptions.quoted.key.participant\n
\noptions.quoted.message.conversation\n
\noptions.mentions.everyOne\n\noptions.mentions.mentioned\n
\nReceiver phone number with country code",
"debug": {
"requestHandlerMode": "browser"
}
},
{
"url": "https://doc.evolution-api.com/v1/api-
reference/profile-settings/remove-profile-picture",
"crawl": {
"loadedUrl": "https://doc.evolution-api.com/v1/api-
reference/profile-settings/remove-profile-picture",
"loadedTime": "2025-03-05T23:47:30.437Z",
"referrerUrl": "https://doc.evolution-api.com/v1/api-
reference/chat-controller/check-is-whatsapp",
"depth": null
},
"metadata": {
"canonicalUrl": "https://doc.evolution-api.com/v1/api-
reference/profile-settings/remove-profile-picture",
"title": "Remove Profile Picture - Evolution API
Documentation",
"description": null,
"author": null,
"keywords": null,
"languageCode": "en",
"openGraph": [
{
"property": "og:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Remove+Profile+Picture&logoLight=
https%3A%2F%2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-
eb1f2775%2Fimages%2Fbrand%2Fcover.png&logoDark=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover-white.png&primaryColor=%2349BC94
&lightColor=%2349BC94&darkColor=%2349BC94"
},
{
"property": "og:image:width",
"content": "1200"
},
{
"property": "og:image:height",
"content": "630"
},
64
 {
"property": "twitter:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Remove+Profile+Picture&logoLight=
https%3A%2F%2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-
eb1f2775%2Fimages%2Fbrand%2Fcover.png&logoDark=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover-white.png&primaryColor=%2349BC94
&lightColor=%2349BC94&darkColor=%2349BC94"
},
{
"property": "twitter:image:width",
"content": "1200"
},
{
"property": "twitter:image:height",
"content": "630"
}
],
"jsonLd": null,
"headers": {
"age": "234",
"cache-control": "public, max-age=0, must-revalidate",
"content-encoding": "br",
"content-type": "text/html; charset=utf-8",
"date": "Wed, 05 Mar 2025 23:43:35 GMT",
"etag": "W/\"15e5bfj726b4s6w\"",
"server": "Vercel",
"strict-transport-security": "max-age=63072000",
"x-frame-options": "DENY",
"x-matched-path": "/_sites/[subdomain]/[[...slug]]",
"x-powered-by": "Next.js",
"x-vercel-cache": "HIT",
"x-vercel-id":
"iad1::iad1::q26h7-1741218450363-78c3d425e57b",
"transfer-encoding": "chunked"
}
},
"screenshotUrl": null,
"text": "Remove Profile Picture - Evolution API
Documentation\nDelete Message for Everyone",
"markdown": "# Remove Profile Picture - Evolution API
Documentation\n\nDelete Message for Everyone",
"debug": {
"requestHandlerMode": "http"
}
},
{
"url": "https://doc.evolution-api.com/v1/api-
reference/message-controller/send-media",
"crawl": {
"loadedUrl": "https://doc.evolution-api.com/v1/api-
reference/message-controller/send-media",
"loadedTime": "2025-03-05T23:47:30.674Z",
"referrerUrl": "https://doc.evolution-api.com/v1/api-
reference/chat-controller/check-is-whatsapp",
"depth": null
65
 },
"metadata": {
"canonicalUrl": "https://doc.evolution-api.com/v1/api-
reference/message-controller/send-media",
"title": "Send Media - Evolution API Documentation",
"description": "Send media message",
"author": null,
"keywords": null,
"languageCode": "en",
"openGraph": [
{
"property": "og:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Send+Media&description=Send+media
+message&logoLight=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover.png&logoDark=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover-white.png&primaryColor=%2349BC94&lightColor=%2349BC94
&darkColor=%2349BC94"
},
{
"property": "og:image:width",
"content": "1200"
},
{
"property": "og:image:height",
"content": "630"
},
{
"property": "twitter:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Send+Media&description=Send+media
+message&logoLight=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover.png&logoDark=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover-white.png&primaryColor=%2349BC94&lightColor=%2349BC94
&darkColor=%2349BC94"
},
{
"property": "twitter:image:width",
"content": "1200"
},
{
"property": "twitter:image:height",
"content": "630"
}
],
"jsonLd": null,
"headers": {
"age": "261",
"cache-control": "public, max-age=0, must-revalidate",
"content-encoding": "br",
"content-type": "text/html; charset=utf-8",
"date": "Wed, 05 Mar 2025 23:43:08 GMT",
"etag": "W/\"d67q96s9rk6xx1\"",
66
 "server": "Vercel",
"strict-transport-security": "max-age=63072000",
"x-frame-options": "DENY",
"x-matched-path": "/_sites/[subdomain]/[[...slug]]",
"x-powered-by": "Next.js",
"x-vercel-cache": "HIT",
"x-vercel-id":
"iad1::iad1::fsc7r-1741218449288-88931b9c025f",
"transfer-encoding": "chunked"
}
},
"screenshotUrl": null,
"text": "Send Media - Evolution API Documentation\n{ \"key
\": { \"remoteJid\": \"[email protected]\", \"fromMe
\": true, \"id\": \"BAE5F5A632EAE722\" }, \"message\":
{ \"imageMessage\": { \"url\":
\"https://mmg.whatsapp.net/o1/v/t62.7118-2...\", \"mimetype\":
\"image/png\", \"caption\": \"Caption text\", \"fileSha256\":
\"VbCGkGBv5SZStLD5PHdkBWpQav/lNsXcY...\", \"fileLength\":
\"1305757\", \"height\": 1080, \"width\": 1920, \"mediaKey\":
\"aFQK9Ocw5tE7Nf0iBA42Xcb4Dee6G1k/pLL...\", \"fileEncSha256\":
\"bGVtYeR3458RwC0p1tsGDNuj+vOu/...\", \"directPath\":
\"/o1/v/t62.7118-24/f1/m232/up-oil...\", \"mediaKeyTimestamp
\": \"1717775573\", \"jpegThumbnail\":
\"/9j/2wBDABALDA4MChAODQ4SERATG...\", \"contextInfo\": {} } },
\"messageTimestamp\": \"1717775575\", \"status\": \"PENDING
\" }",
"markdown": "# Send Media - Evolution API Documentation\n
\n```\n{\n \"key\": {\n \"remoteJid\": \"553198296801
@s.whatsapp.net\",\n \"fromMe\": true,\n \"id\":
\"BAE5F5A632EAE722\"\n },\n \"message\": {\n
\"imageMessage\": {\n \"url\":
\"https://mmg.whatsapp.net/o1/v/t62.7118-2...\",\n
\"mimetype\": \"image/png\",\n \"caption\": \"Caption
text\",\n \"fileSha256\":
\"VbCGkGBv5SZStLD5PHdkBWpQav/lNsXcY...\",\n \"fileLength
\": \"1305757\",\n \"height\": 1080,\n \"width\":
1920,\n \"mediaKey\":
\"aFQK9Ocw5tE7Nf0iBA42Xcb4Dee6G1k/pLL...\",\n
\"fileEncSha256\": \"bGVtYeR3458RwC0p1tsGDNuj+vOu/...\",\n
\"directPath\": \"/o1/v/t62.7118-24/f1/m232/up-oil...\",\n
\"mediaKeyTimestamp\": \"1717775573\",\n \"jpegThumbnail
\": \"/9j/2wBDABALDA4MChAODQ4SERATG...\",\n \"contextInfo
\": {}\n }\n },\n \"messageTimestamp\": \"1717775575\",\n
\"status\": \"PENDING\"\n}\n```",
"debug": {
"requestHandlerMode": "http"
}
},
{
"url": "https://doc.evolution-api.com/v1/api-
reference/group-controller/find-group-by-jid",
"crawl": {
"loadedUrl": "https://doc.evolution-api.com/v1/api-
reference/group-controller/find-group-by-jid",
"loadedTime": "2025-03-05T23:47:32.571Z",
"referrerUrl": "https://doc.evolution-api.com/v1/api-
67
reference/chat-controller/check-is-whatsapp",
"depth": null
},
"metadata": {
"canonicalUrl": "https://doc.evolution-api.com/v1/api-
reference/group-controller/find-group-by-jid",
"title": "Find Group by JID - Evolution API
Documentation",
"description": "Find group by remote JID",
"author": null,
"keywords": null,
"languageCode": "en",
"openGraph": [
{
"property": "og:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Find+Group+by+JID&description=Fin
d+group+by+remote+JID&logoLight=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover.png&logoDark=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover-white.png&primaryColor=%2349BC94&lightColor=%2349BC94
&darkColor=%2349BC94"
},
{
"property": "og:image:width",
"content": "1200"
},
{
"property": "og:image:height",
"content": "630"
},
{
"property": "twitter:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Find+Group+by+JID&description=Fin
d+group+by+remote+JID&logoLight=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover.png&logoDark=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover-white.png&primaryColor=%2349BC94&lightColor=%2349BC94
&darkColor=%2349BC94"
},
{
"property": "twitter:image:width",
"content": "1200"
},
{
"property": "twitter:image:height",
"content": "630"
}
],
"jsonLd": null,
"headers": {
"age": "236",
"cache-control": "public, max-age=0, must-revalidate",
"content-encoding": "br",
68
 "content-type": "text/html; charset=utf-8",
"date": "Wed, 05 Mar 2025 23:43:36 GMT",
"etag": "W/\"csudyxlckf64yl\"",
"server": "Vercel",
"strict-transport-security": "max-age=63072000",
"x-frame-options": "DENY",
"x-matched-path": "/_sites/[subdomain]/[[...slug]]",
"x-powered-by": "Next.js",
"x-vercel-cache": "HIT",
"x-vercel-id":
"iad1::iad1::4hbvc-1741218452447-8a506e97eabd",
"transfer-encoding": "chunked"
}
},
"screenshotUrl": null,
"text": "Find Group by JID - Evolution API Documentation
\nAuthorizations\nYour authorization key header\nPath
Parameters\nID of the instance to connect\nQuery Parameters
\nThe subject (name) of the group.\nThe ID of the user who set
the subject.\nThe timestamp when the subject was set.\nURL of
the group's profile picture.\nThe number of participants in
the group.\nThe timestamp when the group was created.\nThe ID
of the group owner.\nThe description of the group.\nThe ID of
the description message.\nIndicates if the group is restricted
(only admins can send messages).\nIndicates if the group is an
announcement group (only admins can send messages).\nList of
participants in the group.\nThe ID of the participant.\nThe
role of the participant (e.g., 'admin', 'superadmin').",
"markdown": "# Find Group by JID - Evolution API
Documentation\n\n#### Authorizations\n\nYour authorization key
header\n\n#### Path Parameters\n\nID of the instance to
connect\n\n#### Query Parameters\n\nThe subject (name) of the
group.\n\nThe ID of the user who set the subject.\n\nThe
timestamp when the subject was set.\n\nURL of the group's
profile picture.\n\nThe number of participants in the group.\n
\nThe timestamp when the group was created.\n\nThe ID of the
group owner.\n\nThe description of the group.\n\nThe ID of the
description message.\n\nIndicates if the group is restricted
(only admins can send messages).\n\nIndicates if the group is
an announcement group (only admins can send messages).\n\nList
of participants in the group.\n\nThe ID of the participant.\n
\nThe role of the participant (e.g., 'admin', 'superadmin').",
"debug": {
"requestHandlerMode": "http"
}
},
{
"url": "https://doc.evolution-api.com/v1/api-
reference/group-controller/fetch-all-groups",
"crawl": {
"loadedUrl": "https://doc.evolution-api.com/v1/api-
reference/group-controller/fetch-all-groups",
"loadedTime": "2025-03-05T23:47:33.156Z",
"referrerUrl": "https://doc.evolution-api.com/v1/api-
reference/chat-controller/check-is-whatsapp",
"depth": null
},
69
 "metadata": {
"canonicalUrl": "https://doc.evolution-api.com/v1/api-
reference/group-controller/fetch-all-groups",
"title": "Fetch All Groups - Evolution API Documentation",
"description": "Fetch all groups",
"author": null,
"keywords": null,
"languageCode": "en",
"openGraph": [
{
"property": "og:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Fetch+All+Groups&description=Fetc
h+all+groups&logoLight=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover.png&logoDark=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover-white.png&primaryColor=%2349BC94&lightColor=%2349BC94
&darkColor=%2349BC94"
},
{
"property": "og:image:width",
"content": "1200"
},
{
"property": "og:image:height",
"content": "630"
},
{
"property": "twitter:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Fetch+All+Groups&description=Fetc
h+all+groups&logoLight=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover.png&logoDark=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover-white.png&primaryColor=%2349BC94&lightColor=%2349BC94
&darkColor=%2349BC94"
},
{
"property": "twitter:image:width",
"content": "1200"
},
{
"property": "twitter:image:height",
"content": "630"
}
],
"jsonLd": null,
"headers": {
"age": "236",
"cache-control": "public, max-age=0, must-revalidate",
"content-encoding": "br",
"content-type": "text/html; charset=utf-8",
"date": "Wed, 05 Mar 2025 23:43:36 GMT",
"etag": "W/\"x5hdo82h8b5zqo\"",
"server": "Vercel",
70
 "strict-transport-security": "max-age=63072000",
"x-frame-options": "DENY",
"x-matched-path": "/_sites/[subdomain]/[[...slug]]",
"x-powered-by": "Next.js",
"x-vercel-cache": "HIT",
"x-vercel-id": "iad1::iad1::7m26n-1741218452934-
e3ea456fa2e3",
"transfer-encoding": "chunked"
}
},
"screenshotUrl": null,
"text": "Fetch All Groups - Evolution API Documentation
\nAuthorizations\nYour authorization key header\nPath
Parameters\nID of the instance to connect\nQuery Parameters
\nWhether to get the group members or not\nThe subject (name)
of the group.\nThe ID of the user who set the subject.\nThe
timestamp when the subject was set.\nThe number of
participants in the group.\nThe timestamp when the group was
created.\nThe ID of the group owner.\nIndicates if the group
is restricted (only admins can send messages).\nIndicates if
the group is an announcement group (only admins can send
messages).\nURL of the group's profile picture.\nThe
description of the group.\nThe ID of the description
message.",
"markdown": "# Fetch All Groups - Evolution API
Documentation\n\n#### Authorizations\n\nYour authorization key
header\n\n#### Path Parameters\n\nID of the instance to
connect\n\n#### Query Parameters\n\nWhether to get the group
members or not\n\nThe subject (name) of the group.\n\nThe ID
of the user who set the subject.\n\nThe timestamp when the
subject was set.\n\nThe number of participants in the group.\n
\nThe timestamp when the group was created.\n\nThe ID of the
group owner.\n\nIndicates if the group is restricted (only
admins can send messages).\n\nIndicates if the group is an
announcement group (only admins can send messages).\n\nURL of
the group's profile picture.\n\nThe description of the group.
\n\nThe ID of the description message.",
"debug": {
"requestHandlerMode": "http"
}
},
{
"url": "https://doc.evolution-api.com/v1/api-
reference/profile-settings/fetch-privacy-settings",
"crawl": {
"loadedUrl": "https://doc.evolution-api.com/v1/api-
reference/profile-settings/fetch-privacy-settings",
"loadedTime": "2025-03-05T23:47:33.621Z",
"referrerUrl": "https://doc.evolution-api.com/v1/api-
reference/chat-controller/check-is-whatsapp",
"depth": null
},
"metadata": {
"canonicalUrl": "https://doc.evolution-api.com/v1/api-
reference/profile-settings/fetch-privacy-settings",
"title": "Fetch Privacy Settings - Evolution API
Documentation",
71
 "description": "Fetch privacy settings",
"author": null,
"keywords": null,
"languageCode": "en",
"openGraph": [
{
"property": "og:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Fetch+Privacy+Settings&descriptio
n=Fetch+privacy+settings&logoLight=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover.png&logoDark=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover-white.png&primaryColor=%2349BC94
&lightColor=%2349BC94&darkColor=%2349BC94"
},
{
"property": "og:image:width",
"content": "1200"
},
{
"property": "og:image:height",
"content": "630"
},
{
"property": "twitter:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Fetch+Privacy+Settings&descriptio
n=Fetch+privacy+settings&logoLight=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover.png&logoDark=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover-white.png&primaryColor=%2349BC94
&lightColor=%2349BC94&darkColor=%2349BC94"
},
{
"property": "twitter:image:width",
"content": "1200"
},
{
"property": "twitter:image:height",
"content": "630"
}
],
"jsonLd": null,
"headers": {
"age": "237",
"cache-control": "public, max-age=0, must-revalidate",
"content-encoding": "br",
"content-type": "text/html; charset=utf-8",
"date": "Wed, 05 Mar 2025 23:43:35 GMT",
"etag": "W/\"qujecg2hfk57rw\"",
"server": "Vercel",
"strict-transport-security": "max-age=63072000",
"x-frame-options": "DENY",
"x-matched-path": "/_sites/[subdomain]/[[...slug]]",
"x-powered-by": "Next.js",
72
 "x-vercel-cache": "HIT",
"x-vercel-id": "iad1::iad1::tr4zm-1741218453483-
b557661463da",
"transfer-encoding": "chunked"
}
},
"screenshotUrl": null,
"text": "Fetch Privacy Settings - Evolution API
Documentation\nFetch privacy settings\nAuthorizations\nYour
authorization key header\nPath Parameters\nID of the instance
to connect",
"markdown": "# Fetch Privacy Settings - Evolution API
Documentation\n\nFetch privacy settings\n\n#### Authorizations
\n\nYour authorization key header\n\n#### Path Parameters\n
\nID of the instance to connect",
"debug": {
"requestHandlerMode": "http"
}
},
{
"url": "https://doc.evolution-api.com/v1/api-
reference/profile-settings/update-privacy-settings",
"crawl": {
"loadedUrl": "https://doc.evolution-api.com/v1/api-
reference/profile-settings/update-privacy-settings",
"loadedTime": "2025-03-05T23:47:35.950Z",
"referrerUrl": "https://doc.evolution-api.com/v1/api-
reference/chat-controller/check-is-whatsapp",
"depth": null
},
"metadata": {
"canonicalUrl": "https://doc.evolution-api.com/v1/api-
reference/profile-settings/update-privacy-settings",
"title": "Update Privacy Settings - Evolution API
Documentation",
"description": "Update privacy settings",
"author": null,
"keywords": null,
"languageCode": "en",
"openGraph": [
{
"property": "og:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Update+Privacy+Settings&descripti
on=Update+privacy+settings&logoLight=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover.png&logoDark=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover-white.png&primaryColor=%2349BC94
&lightColor=%2349BC94&darkColor=%2349BC94"
},
{
"property": "og:image:width",
"content": "1200"
},
{
"property": "og:image:height",
73
 "content": "630"
},
{
"property": "twitter:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Update+Privacy+Settings&descripti
on=Update+privacy+settings&logoLight=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover.png&logoDark=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover-white.png&primaryColor=%2349BC94
&lightColor=%2349BC94&darkColor=%2349BC94"
},
{
"property": "twitter:image:width",
"content": "1200"
},
{
"property": "twitter:image:height",
"content": "630"
}
],
"jsonLd": null,
"headers": {
"age": "240",
"cache-control": "public, max-age=0, must-revalidate",
"content-encoding": "br",
"content-type": "text/html; charset=utf-8",
"date": "Wed, 05 Mar 2025 23:43:35 GMT",
"etag": "W/\"qkad7kphgu5l07\"",
"server": "Vercel",
"strict-transport-security": "max-age=63072000",
"x-frame-options": "DENY",
"x-matched-path": "/_sites/[subdomain]/[[...slug]]",
"x-powered-by": "Next.js",
"x-vercel-cache": "HIT",
"x-vercel-id": "iad1::iad1::7m26n-1741218455847-
d19463854869",
"transfer-encoding": "chunked"
}
},
"screenshotUrl": null,
"text": "Update Privacy Settings - Evolution API
Documentation\ncurl --request PUT \\ --url https://{server-
url}/chat/updatePrivacySettings/{instance} \\ --header
'Content-Type: application/json' \\ --header 'apikey: <api-
key>' \\ --data '{ \"privacySettings\": { \"readreceipts\":
\"all\", \"profile\": \"all\", \"status\": \"all\", \"online
\": \"all\", \"last\": \"all\", \"groupadd\": \"all\" } }'",
"markdown": "# Update Privacy Settings - Evolution API
Documentation\n\n```\ncurl --request PUT \\\n --url
https://{server-url}/chat/updatePrivacySettings/{instance}
\\\n --header 'Content-Type: application/json' \\\n --header
'apikey: <api-key>' \\\n --data '{\n \"privacySettings\":
{\n \"readreceipts\": \"all\",\n \"profile\": \"all\",\n
\"status\": \"all\",\n \"online\": \"all\",\n \"last\":
\"all\",\n \"groupadd\": \"all\"\n }\n}'\n```",
74
 "debug": {
"requestHandlerMode": "http"
}
},
{
"url": "https://doc.evolution-api.com/v1/api-
reference/message-controller/send-audio",
"crawl": {
"loadedUrl": "https://doc.evolution-api.com/v1/api-
reference/message-controller/send-audio",
"loadedTime": "2025-03-05T23:47:37.438Z",
"referrerUrl": "https://doc.evolution-api.com/v1/api-
reference/chat-controller/check-is-whatsapp",
"depth": null,
"httpStatusCode": 200
},
"metadata": {
"canonicalUrl": "https://doc.evolution-api.com/v1/api-
reference/message-controller/send-audio",
"title": "Send WhatsApp Audio - Evolution API
Documentation",
"description": "Send WhatsApp Audio",
"author": null,
"keywords": null,
"languageCode": "en",
"openGraph": [
{
"property": "og:image:width",
"content": "1200"
},
{
"property": "og:image:height",
"content": "630"
},
{
"property": "twitter:image:width",
"content": "1200"
},
{
"property": "twitter:image:height",
"content": "630"
},
{
"property": "og:image",
"content": "https://doc.evolution-api.com/api/og?
division=Documentation&title=Send+WhatsApp+Audio&description=S
end+WhatsApp+Audio&logoLight=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover.png&logoDark=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover-white.png&primaryColor=%2349BC94&lightColor=%2349BC94
&darkColor=%2349BC94"
},
{
"property": "twitter:image",
"content": "https://doc.evolution-api.com/api/og?
division=Documentation&title=Send+WhatsApp+Audio&description=S
75
end+WhatsApp+Audio&logoLight=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover.png&logoDark=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover-white.png&primaryColor=%2349BC94&lightColor=%2349BC94
&darkColor=%2349BC94"
}
],
"jsonLd": null,
"headers": {
"age": "265",
"cache-control": "public, max-age=0, must-revalidate",
"content-encoding": "br",
"content-type": "text/html; charset=utf-8",
"date": "Wed, 05 Mar 2025 23:43:08 GMT",
"etag": "W/\"4x4o6h3eby6p5y\"",
"server": "Vercel",
"strict-transport-security": "max-age=63072000",
"x-frame-options": "DENY",
"x-matched-path": "/_sites/[subdomain]/[[...slug]]",
"x-powered-by": "Next.js",
"x-vercel-cache": "HIT",
"x-vercel-id":
"iad1::iad1::lzzh6-1741218454960-2957a3b42a0d",
"x-firefox-spdy": "h2"
}
},
"screenshotUrl": null,
"text": "Send WhatsApp Audio - Evolution API Documentation
\nAuthorizations\nYour authorization key header\nPath
Parameters\nID of the instance to connect\nBody\nNumber to
receive the message (with country code)\nAudio URL or file in
base64\nPresence time in milliseconds before sending message
\nPresence type to show\nAvailable options:\nrecording \nIf
the audio must be encoded or not\nThe key of the message,
which identifies the message in the chat.\nIndicates whether
the message was sent by the user.\nThe message content, which
may include various types of messages like text, images,
audio, etc.\nDetails of the audio message.\nThe URL of the
audio message.\nmessage.audioMessage.mimetype\nThe MIME type
of the audio message.\nmessage.audioMessage.fileSha256\nThe
SHA-256 hash of the audio file.
\nmessage.audioMessage.fileLength\nThe length of the audio
file.\nmessage.audioMessage.seconds\nThe duration of the audio
message in seconds.\nIndicates whether the audio message is a
push-to-talk (PTT) message.\nmessage.audioMessage.mediaKey
\nThe media key of the audio message.
\nmessage.audioMessage.fileEncSha256\nThe SHA-256 hash of the
encrypted audio file.\nmessage.audioMessage.directPath\nThe
direct path to the audio file.
\nmessage.audioMessage.mediaKeyTimestamp\nThe timestamp of the
media key.\nThe timestamp of the message, represented as a
string.\nThe status of the message, such as sent, received, or
pending.",
"markdown": "# Send WhatsApp Audio - Evolution API
Documentation\n\n#### Authorizations\n\nYour authorization key
header\n\n#### Path Parameters\n\nID of the instance to
76
connect\n\n#### Body\n\nNumber to receive the message (with
country code)\n\nAudio URL or file in base64\n\nPresence time
in milliseconds before sending message\n\nPresence type to
show\n\nAvailable options:\n\n`recording`\n\nIf the audio must
be encoded or not\n\nThe key of the message, which identifies
the message in the chat.\n\nIndicates whether the message was
sent by the user.\n\nThe message content, which may include
various types of messages like text, images, audio, etc.\n
\nDetails of the audio message.\n\nThe URL of the audio
message.\n\nmessage.audioMessage.mimetype\n\nThe MIME type of
the audio message.\n\nmessage.audioMessage.fileSha256\n\nThe
SHA-256 hash of the audio file.\n
\nmessage.audioMessage.fileLength\n\nThe length of the audio
file.\n\nmessage.audioMessage.seconds\n\nThe duration of the
audio message in seconds.\n\nIndicates whether the audio
message is a push-to-talk (PTT) message.\n
\nmessage.audioMessage.mediaKey\n\nThe media key of the audio
message.\n\nmessage.audioMessage.fileEncSha256\n\nThe SHA-256
hash of the encrypted audio file.\n
\nmessage.audioMessage.directPath\n\nThe direct path to the
audio file.\n\nmessage.audioMessage.mediaKeyTimestamp\n\nThe
timestamp of the media key.\n\nThe timestamp of the message,
represented as a string.\n\nThe status of the message, such as
sent, received, or pending.",
"debug": {
"requestHandlerMode": "browser"
}
},
{
"url": "https://doc.evolution-api.com/v1/api-
reference/group-controller/find-participants",
"crawl": {
"loadedUrl": "https://doc.evolution-api.com/v1/api-
reference/group-controller/find-participants",
"loadedTime": "2025-03-05T23:47:41.535Z",
"referrerUrl": "https://doc.evolution-api.com/v1/api-
reference/chat-controller/check-is-whatsapp",
"depth": null
},
"metadata": {
"canonicalUrl": "https://doc.evolution-api.com/v1/api-
reference/group-controller/find-participants",
"title": "Find Group Members - Evolution API
Documentation",
"description": "Fetch all group members",
"author": null,
"keywords": null,
"languageCode": "en",
"openGraph": [
{
"property": "og:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Find+Group+Members&description=Fe
tch+all+group+members&logoLight=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover.png&logoDark=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
77
2Fcover-white.png&primaryColor=%2349BC94&lightColor=%2349BC94
&darkColor=%2349BC94"
},
{
"property": "og:image:width",
"content": "1200"
},
{
"property": "og:image:height",
"content": "630"
},
{
"property": "twitter:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Find+Group+Members&description=Fe
tch+all+group+members&logoLight=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover.png&logoDark=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover-white.png&primaryColor=%2349BC94&lightColor=%2349BC94
&darkColor=%2349BC94"
},
{
"property": "twitter:image:width",
"content": "1200"
},
{
"property": "twitter:image:height",
"content": "630"
}
],
"jsonLd": null,
"headers": {
"age": "245",
"cache-control": "public, max-age=0, must-revalidate",
"content-encoding": "br",
"content-type": "text/html; charset=utf-8",
"date": "Wed, 05 Mar 2025 23:43:35 GMT",
"etag": "W/\"15b3rud5nm5jkz\"",
"server": "Vercel",
"strict-transport-security": "max-age=63072000",
"x-frame-options": "DENY",
"x-matched-path": "/_sites/[subdomain]/[[...slug]]",
"x-powered-by": "Next.js",
"x-vercel-cache": "HIT",
"x-vercel-id":
"iad1::iad1::flsj6-1741218461394-101ed7aea916",
"transfer-encoding": "chunked"
}
},
"screenshotUrl": null,
"text": "Find Group Members - Evolution API Documentation
\nAuthorizations\nYour authorization key header\nPath
Parameters\nID of the instance to connect\nQuery Parameters
\nList of participants in the group.\nThe ID of the
participant.\nThe role of the participant (e.g., 'admin',
'superadmin').",
78
 "markdown": "# Find Group Members - Evolution API
Documentation\n\n#### Authorizations\n\nYour authorization key
header\n\n#### Path Parameters\n\nID of the instance to
connect\n\n#### Query Parameters\n\nList of participants in
the group.\n\nThe ID of the participant.\n\nThe role of the
participant (e.g., 'admin', 'superadmin').",
"debug": {
"requestHandlerMode": "http"
}
},
{
"url": "https://doc.evolution-api.com/v1/api-
reference/message-controller/send-sticker",
"crawl": {
"loadedUrl": "https://doc.evolution-api.com/v1/api-
reference/message-controller/send-sticker",
"loadedTime": "2025-03-05T23:47:38.486Z",
"referrerUrl": "https://doc.evolution-api.com/v1/api-
reference/chat-controller/check-is-whatsapp",
"depth": null,
"httpStatusCode": 200
},
"metadata": {
"canonicalUrl": "https://doc.evolution-api.com/v1/api-
reference/message-controller/send-sticker",
"title": "Send Sticker - Evolution API Documentation",
"description": "Send Sticker",
"author": null,
"keywords": null,
"languageCode": "en",
"openGraph": [
{
"property": "og:image:width",
"content": "1200"
},
{
"property": "og:image:height",
"content": "630"
},
{
"property": "twitter:image:width",
"content": "1200"
},
{
"property": "twitter:image:height",
"content": "630"
},
{
"property": "og:image",
"content": "https://doc.evolution-api.com/api/og?
division=Documentation&title=Send+Sticker&description=Send+Sti
cker&logoLight=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover.png&logoDark=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover-white.png&primaryColor=%2349BC94&lightColor=%2349BC94
&darkColor=%2349BC94"
79
 },
{
"property": "twitter:image",
"content": "https://doc.evolution-api.com/api/og?
division=Documentation&title=Send+Sticker&description=Send+Sti
cker&logoLight=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover.png&logoDark=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover-white.png&primaryColor=%2349BC94&lightColor=%2349BC94
&darkColor=%2349BC94"
}
],
"jsonLd": null,
"headers": {
"age": "267",
"cache-control": "public, max-age=0, must-revalidate",
"content-encoding": "br",
"content-type": "text/html; charset=utf-8",
"date": "Wed, 05 Mar 2025 23:43:08 GMT",
"etag": "W/\"zxv1bhzs2y5jhy\"",
"server": "Vercel",
"strict-transport-security": "max-age=63072000",
"x-frame-options": "DENY",
"x-matched-path": "/_sites/[subdomain]/[[...slug]]",
"x-powered-by": "Next.js",
"x-vercel-cache": "HIT",
"x-vercel-id":
"iad1::iad1::zp8bz-1741218456101-45460e407470",
"x-firefox-spdy": "h2"
}
},
"screenshotUrl": null,
"text": "Send Sticker - Evolution API Documentation
\nAuthorizations\nYour authorization key header\nPath
Parameters\nID of the instance to connect\nBody\nNumber to
receive the message (with country code)\nImage URL or file in
base64\nPresence time in milliseconds before sending message
\nPresence type to show\nAvailable options:\ncomposing",
"markdown": "# Send Sticker - Evolution API Documentation\n
\n#### Authorizations\n\nYour authorization key header\n\n####
Path Parameters\n\nID of the instance to connect\n\n#### Body
\n\nNumber to receive the message (with country code)\n\nImage
URL or file in base64\n\nPresence time in milliseconds before
sending message\n\nPresence type to show\n\nAvailable options:
\n\n`composing`",
"debug": {
"requestHandlerMode": "browser"
}
},
{
"url": "https://doc.evolution-api.com/v1/api-
reference/group-controller/update-participant",
"crawl": {
"loadedUrl": "https://doc.evolution-api.com/v1/api-
reference/group-controller/update-participant",
"loadedTime": "2025-03-05T23:47:44.259Z",
80
 "referrerUrl": "https://doc.evolution-api.com/v1/api-
reference/chat-controller/check-is-whatsapp",
"depth": null
},
"metadata": {
"canonicalUrl": "https://doc.evolution-api.com/v1/api-
reference/group-controller/update-participant",
"title": "Update Group Members - Evolution API
Documentation",
"description": "Update group members",
"author": null,
"keywords": null,
"languageCode": "en",
"openGraph": [
{
"property": "og:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Update+Group+Members&description=
Update+group+members&logoLight=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover.png&logoDark=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover-white.png&primaryColor=%2349BC94&lightColor=%2349BC94
&darkColor=%2349BC94"
},
{
"property": "og:image:width",
"content": "1200"
},
{
"property": "og:image:height",
"content": "630"
},
{
"property": "twitter:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Update+Group+Members&description=
Update+group+members&logoLight=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover.png&logoDark=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover-white.png&primaryColor=%2349BC94&lightColor=%2349BC94
&darkColor=%2349BC94"
},
{
"property": "twitter:image:width",
"content": "1200"
},
{
"property": "twitter:image:height",
"content": "630"
}
],
"jsonLd": null,
"headers": {
"age": "248",
"cache-control": "public, max-age=0, must-revalidate",
81
 "content-encoding": "br",
"content-type": "text/html; charset=utf-8",
"date": "Wed, 05 Mar 2025 23:43:35 GMT",
"etag": "W/\"11nuqtq8ko35djt\"",
"server": "Vercel",
"strict-transport-security": "max-age=63072000",
"x-frame-options": "DENY",
"x-matched-path": "/_sites/[subdomain]/[[...slug]]",
"x-powered-by": "Next.js",
"x-vercel-cache": "HIT",
"x-vercel-id":
"iad1::iad1::qt9s2-1741218464078-69efad885ee4",
"transfer-encoding": "chunked"
}
},
"screenshotUrl": null,
"text": "Update Group Members - Evolution API Documentation
\nAuthorizations\nYour authorization key header\nPath
Parameters\nID of the instance to connect\nQuery Parameters
\nBody\nAvailable options:\nadd,\nremove,\npromote,\ndemote
\nGroup members phone numbers with country code",
"markdown": "# Update Group Members - Evolution API
Documentation\n\n#### Authorizations\n\nYour authorization key
header\n\n#### Path Parameters\n\nID of the instance to
connect\n\n#### Query Parameters\n\n#### Body\n\nAvailable
options:\n\n`add`,\n\n`remove`,\n\n`promote`,\n\n`demote`\n
\nGroup members phone numbers with country code",
"debug": {
"requestHandlerMode": "http"
}
},
{
"url": "https://doc.evolution-api.com/v1/api-
reference/group-controller/update-setting",
"crawl": {
"loadedUrl": "https://doc.evolution-api.com/v1/api-
reference/group-controller/update-setting",
"loadedTime": "2025-03-05T23:47:48.612Z",
"referrerUrl": "https://doc.evolution-api.com/v1/api-
reference/chat-controller/check-is-whatsapp",
"depth": null
},
"metadata": {
"canonicalUrl": "https://doc.evolution-api.com/v1/api-
reference/group-controller/update-setting",
"title": "Update Group Setting - Evolution API
Documentation",
"description": "Update group settings",
"author": null,
"keywords": null,
"languageCode": "en",
"openGraph": [
{
"property": "og:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Update+Group+Setting&description=
Update+group+settings&logoLight=https%3A%2F%2Fmintlify.s3.us-
82
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover.png&logoDark=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover-white.png&primaryColor=%2349BC94&lightColor=%2349BC94
&darkColor=%2349BC94"
},
{
"property": "og:image:width",
"content": "1200"
},
{
"property": "og:image:height",
"content": "630"
},
{
"property": "twitter:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Update+Group+Setting&description=
Update+group+settings&logoLight=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover.png&logoDark=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover-white.png&primaryColor=%2349BC94&lightColor=%2349BC94
&darkColor=%2349BC94"
},
{
"property": "twitter:image:width",
"content": "1200"
},
{
"property": "twitter:image:height",
"content": "630"
}
],
"jsonLd": null,
"headers": {
"age": "252",
"cache-control": "public, max-age=0, must-revalidate",
"content-encoding": "br",
"content-type": "text/html; charset=utf-8",
"date": "Wed, 05 Mar 2025 23:43:35 GMT",
"etag": "W/\"121yb7joc8b5cds\"",
"server": "Vercel",
"strict-transport-security": "max-age=63072000",
"x-frame-options": "DENY",
"x-matched-path": "/_sites/[subdomain]/[[...slug]]",
"x-powered-by": "Next.js",
"x-vercel-cache": "HIT",
"x-vercel-id":
"iad1::iad1::flsj6-1741218468534-226aac5e464b",
"transfer-encoding": "chunked"
}
},
"screenshotUrl": null,
"text": "Update Group Setting - Evolution API Documentation
\nAuthorizations\nYour authorization key header\nPath
Parameters\nID of the instance to connect\nQuery Parameters
83
\nBody\nGroup setting (announcement = only admins can send
messages; not_announcement = everyone can send messages;
locked = only admins can edit group settings; unlocked =
everyone can edit group settings\nAvailable options:
\nannouncement,\nnot_announcement,\nlocked,\nunlocked",
"markdown": "# Update Group Setting - Evolution API
Documentation\n\n#### Authorizations\n\nYour authorization key
header\n\n#### Path Parameters\n\nID of the instance to
connect\n\n#### Query Parameters\n\n#### Body\n\nGroup setting
(`announcement` = only admins can send messages;
`not_announcement` = everyone can send messages; `locked` =
only admins can edit group settings; `unlocked` = everyone can
edit group settings\n\nAvailable options:\n\n`announcement`,\n
\n`not_announcement`,\n\n`locked`,\n\n`unlocked`",
"debug": {
"requestHandlerMode": "http"
}
},
{
"url": "https://doc.evolution-api.com/v1/api-
reference/group-controller/group-create",
"crawl": {
"loadedUrl": "https://doc.evolution-api.com/v1/api-
reference/group-controller/group-create",
"loadedTime": "2025-03-05T23:47:48.674Z",
"referrerUrl": "https://doc.evolution-api.com/v1/api-
reference/chat-controller/check-is-whatsapp",
"depth": null
},
"metadata": {
"canonicalUrl": "https://doc.evolution-api.com/v1/api-
reference/group-controller/group-create",
"title": "Create Group - Evolution API Documentation",
"description": "Create group",
"author": null,
"keywords": null,
"languageCode": "en",
"openGraph": [
{
"property": "og:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Create+Group&description=Create+g
roup&logoLight=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover.png&logoDark=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover-white.png&primaryColor=%2349BC94&lightColor=%2349BC94
&darkColor=%2349BC94"
},
{
"property": "og:image:width",
"content": "1200"
},
{
"property": "og:image:height",
"content": "630"
},
84
 {
"property": "twitter:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Create+Group&description=Create+g
roup&logoLight=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover.png&logoDark=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover-white.png&primaryColor=%2349BC94&lightColor=%2349BC94
&darkColor=%2349BC94"
},
{
"property": "twitter:image:width",
"content": "1200"
},
{
"property": "twitter:image:height",
"content": "630"
}
],
"jsonLd": null,
"headers": {
"age": "252",
"cache-control": "public, max-age=0, must-revalidate",
"content-encoding": "br",
"content-type": "text/html; charset=utf-8",
"date": "Wed, 05 Mar 2025 23:43:35 GMT",
"etag": "W/\"1wbh6p64gd5cz6\"",
"server": "Vercel",
"strict-transport-security": "max-age=63072000",
"x-frame-options": "DENY",
"x-matched-path": "/_sites/[subdomain]/[[...slug]]",
"x-powered-by": "Next.js",
"x-vercel-cache": "HIT",
"x-vercel-id": "iad1::iad1::lfvfj-1741218468594-
f4adcacf6ffd",
"transfer-encoding": "chunked"
}
},
"screenshotUrl": null,
"text": "Create Group - Evolution API Documentation
\nAuthorizations\nYour authorization key header\nPath
Parameters\nID of the instance to connect\nBody\nGroup members
phone numbers with country code",
"markdown": "# Create Group - Evolution API Documentation\n
\n#### Authorizations\n\nYour authorization key header\n\n####
Path Parameters\n\nID of the instance to connect\n\n#### Body
\n\nGroup members phone numbers with country code",
"debug": {
"requestHandlerMode": "http"
}
},
{
"url": "https://doc.evolution-api.com/v1/api-
reference/message-controller/send-location",
"crawl": {
"loadedUrl": "https://doc.evolution-api.com/v1/api-
85
reference/message-controller/send-location",
"loadedTime": "2025-03-05T23:47:45.133Z",
"referrerUrl": "https://doc.evolution-api.com/v1/api-
reference/chat-controller/check-is-whatsapp",
"depth": null,
"httpStatusCode": 200
},
"metadata": {
"canonicalUrl": "https://doc.evolution-api.com/v1/api-
reference/message-controller/send-location",
"title": "Send Location - Evolution API Documentation",
"description": "Send Location",
"author": null,
"keywords": null,
"languageCode": "en",
"openGraph": [
{
"property": "og:image:width",
"content": "1200"
},
{
"property": "og:image:height",
"content": "630"
},
{
"property": "twitter:image:width",
"content": "1200"
},
{
"property": "twitter:image:height",
"content": "630"
},
{
"property": "og:image",
"content": "https://doc.evolution-api.com/api/og?
division=Documentation&title=Send+Location&description=Send+Lo
cation&logoLight=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover.png&logoDark=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover-white.png&primaryColor=%2349BC94&lightColor=%2349BC94
&darkColor=%2349BC94"
},
{
"property": "twitter:image",
"content": "https://doc.evolution-api.com/api/og?
division=Documentation&title=Send+Location&description=Send+Lo
cation&logoLight=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover.png&logoDark=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover-white.png&primaryColor=%2349BC94&lightColor=%2349BC94
&darkColor=%2349BC94"
}
],
"jsonLd": null,
"headers": {
86
 "age": "272",
"cache-control": "public, max-age=0, must-revalidate",
"content-encoding": "br",
"content-type": "text/html; charset=utf-8",
"date": "Wed, 05 Mar 2025 23:43:08 GMT",
"etag": "W/\"16cbdeucfyb6ilk\"",
"server": "Vercel",
"strict-transport-security": "max-age=63072000",
"x-frame-options": "DENY",
"x-matched-path": "/_sites/[subdomain]/[[...slug]]",
"x-powered-by": "Next.js",
"x-vercel-cache": "HIT",
"x-vercel-id":
"iad1::iad1::8skmw-1741218462059-7deec49d85c3",
"x-firefox-spdy": "h2"
}
},
"screenshotUrl": null,
"text": "Send Location - Evolution API Documentation\nSend
Location\nPOST\n/\nmessage\n/\nsendLocation\n/
\n{instance}\ncurl --request POST \\ --url https://{server-
url}/message/sendLocation/{instance} \\ --header 'Content-
Type: application/json' \\ --header 'apikey: <api-key>' \\ --
data '{ \"number\": \"<string>\", \"options\": { \"delay\":
123, \"presence\": \"composing\" }, \"locationMessage\":
{ \"name\": \"<string>\", \"address\": \"<string>\",
\"latitude\": 123, \"longitude\": 123 } }'\n{ \"key\":
{ \"remoteJid\": \"[email protected]\", \"fromMe\":
true, \"id\": \"BAE51B6FF4470AF9\" }, \"message\":
{ \"locationMessage\": { \"degreesLatitude\": -19.93359,
\"degreesLongitude\": -43.93851, \"name\": \"Palácio da
Liberdade\", \"address\": \"Praça da Liberdade, Belo
Horizonte, MG 30140-050\", \"contextInfo\": {} } },
\"messageTimestamp\": \"1717779606\", \"status\": \"PENDING
\" }\nAuthorizations\nYour authorization key header\nPath
Parameters\nID of the instance to connect\nBody\nNumber to
receive the message (with country
code)\nlocationMessage.longitude\nPresence time in
milliseconds before sending message\nPresence type to show
\nAvailable options:\ncomposing \nThe key of the message,
which identifies the message in the chat.\nIndicates whether
the message was sent by the user.\nThe message content, which
may include various types of messages like text, images,
location, etc.\nDetails of the location message.
\nmessage.locationMessage.degreesLatitude\nThe latitude of the
location.\nmessage.locationMessage.degreesLongitude\nThe
longitude of the location.\nmessage.locationMessage.name\nThe
name of the location.\nmessage.locationMessage.address\nThe
address of the location.\nmessage.locationMessage.contextInfo
\nAdditional context information.\nThe timestamp of the
message, represented as a string.\nThe status of the message,
such as sent, received, or pending.\ncurl --request POST \\ --
url https://{server-url}/message/sendLocation/{instance} \\ --
header 'Content-Type: application/json' \\ --header 'apikey:
<api-key>' \\ --data '{ \"number\": \"<string>\", \"options\":
{ \"delay\": 123, \"presence\": \"composing\" },
\"locationMessage\": { \"name\": \"<string>\", \"address\":
87
\"<string>\", \"latitude\": 123, \"longitude\":
123 } }'\n{ \"key\": { \"remoteJid\": \"553198296801
@s.whatsapp.net\", \"fromMe\": true, \"id\":
\"BAE51B6FF4470AF9\" }, \"message\": { \"locationMessage\":
{ \"degreesLatitude\": -19.93359, \"degreesLongitude
\": -43.93851, \"name\": \"Palácio da Liberdade\", \"address
\": \"Praça da Liberdade, Belo Horizonte, MG 30140-050\",
\"contextInfo\": {} } }, \"messageTimestamp\": \"1717779606\",
\"status\": \"PENDING\" }",
"markdown": "# Send Location - Evolution API Documentation\n
\nSend Location\n\nPOST\n\n/\n\nmessage\n\n/\n\nsendLocation\n
\n/\n\n{instance}\n\n```\ncurl --request POST \\\n --url
https://{server-url}/message/sendLocation/{instance} \\\n --
header 'Content-Type: application/json' \\\n --header
'apikey: <api-key>' \\\n --data '{\n \"number\":
\"<string>\",\n \"options\": {\n \"delay\": 123,\n
\"presence\": \"composing\"\n },\n \"locationMessage\": {\n
\"name\": \"<string>\",\n \"address\": \"<string>\",\n
\"latitude\": 123,\n \"longitude\": 123\n }\n}'\n```\n
\n```\n{\n \"key\": {\n \"remoteJid\": \"553198296801
@s.whatsapp.net\",\n \"fromMe\": true,\n \"id\":
\"BAE51B6FF4470AF9\"\n },\n \"message\": {\n
\"locationMessage\": {\n \"degreesLatitude\": -19.93359,
\n \"degreesLongitude\": -43.93851,\n \"name\":
\"Palácio da Liberdade\",\n \"address\": \"Praça da
Liberdade, Belo Horizonte, MG 30140-050\",\n
\"contextInfo\": {}\n }\n },\n \"messageTimestamp\":
\"1717779606\",\n \"status\": \"PENDING\"\n}\n```\n\n####
Authorizations\n\nYour authorization key header\n\n#### Path
Parameters\n\nID of the instance to connect\n\n#### Body\n
\nNumber to receive the message (with country code)\n
\nlocationMessage.longitude\n\nPresence time in milliseconds
before sending message\n\nPresence type to show\n\nAvailable
options:\n\n`composing`\n\nThe key of the message, which
identifies the message in the chat.\n\nIndicates whether the
message was sent by the user.\n\nThe message content, which
may include various types of messages like text, images,
location, etc.\n\nDetails of the location message.\n
\nmessage.locationMessage.degreesLatitude\n\nThe latitude of
the location.\n\nmessage.locationMessage.degreesLongitude\n
\nThe longitude of the location.\n
\nmessage.locationMessage.name\n\nThe name of the location.\n
\nmessage.locationMessage.address\n\nThe address of the
location.\n\nmessage.locationMessage.contextInfo\n\nAdditional
context information.\n\nThe timestamp of the message,
represented as a string.\n\nThe status of the message, such as
sent, received, or pending.\n\n```\ncurl --request POST
\\\n --url https://{server-
url}/message/sendLocation/{instance} \\\n --header 'Content-
Type: application/json' \\\n --header 'apikey: <api-key>'
\\\n --data '{\n \"number\": \"<string>\",\n \"options\":
{\n \"delay\": 123,\n \"presence\": \"composing\"\n },
\n \"locationMessage\": {\n \"name\": \"<string>\",\n
\"address\": \"<string>\",\n \"latitude\": 123,\n
\"longitude\": 123\n }\n}'\n```\n\n```\n{\n \"key\": {\n
\"remoteJid\": \"[email protected]\",\n \"fromMe
\": true,\n \"id\": \"BAE51B6FF4470AF9\"\n },\n \"message
88
\": {\n \"locationMessage\": {\n \"degreesLatitude
\": -19.93359,\n \"degreesLongitude\": -43.93851,\n
\"name\": \"Palácio da Liberdade\",\n \"address\":
\"Praça da Liberdade, Belo Horizonte, MG 30140-050\",\n
\"contextInfo\": {}\n }\n },\n \"messageTimestamp\":
\"1717779606\",\n \"status\": \"PENDING\"\n}\n```",
"debug": {
"requestHandlerMode": "browser"
}
},
{
"url": "https://doc.evolution-api.com/v1/api-
reference/group-controller/update-group-picture",
"crawl": {
"loadedUrl": "https://doc.evolution-api.com/v1/api-
reference/group-controller/update-group-picture",
"loadedTime": "2025-03-05T23:47:48.687Z",
"referrerUrl": "https://doc.evolution-api.com/v1/api-
reference/chat-controller/check-is-whatsapp",
"depth": null
},
"metadata": {
"canonicalUrl": "https://doc.evolution-api.com/v1/api-
reference/group-controller/update-group-picture",
"title": "Update Group Picture - Evolution API
Documentation",
"description": "Create group",
"author": null,
"keywords": null,
"languageCode": "en",
"openGraph": [
{
"property": "og:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Update+Group+Picture&description=
Create+group&logoLight=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover.png&logoDark=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover-white.png&primaryColor=%2349BC94&lightColor=%2349BC94
&darkColor=%2349BC94"
},
{
"property": "og:image:width",
"content": "1200"
},
{
"property": "og:image:height",
"content": "630"
},
{
"property": "twitter:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Update+Group+Picture&description=
Create+group&logoLight=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover.png&logoDark=https%3A%2F%2Fmintlify.s3.us-
89
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover-white.png&primaryColor=%2349BC94&lightColor=%2349BC94
&darkColor=%2349BC94"
},
{
"property": "twitter:image:width",
"content": "1200"
},
{
"property": "twitter:image:height",
"content": "630"
}
],
"jsonLd": null,
"headers": {
"age": "252",
"cache-control": "public, max-age=0, must-revalidate",
"content-encoding": "br",
"content-type": "text/html; charset=utf-8",
"date": "Wed, 05 Mar 2025 23:43:35 GMT",
"etag": "W/\"ugbxic2i3z5bp9\"",
"server": "Vercel",
"strict-transport-security": "max-age=63072000",
"x-frame-options": "DENY",
"x-matched-path": "/_sites/[subdomain]/[[...slug]]",
"x-powered-by": "Next.js",
"x-vercel-cache": "HIT",
"x-vercel-id": "iad1::iad1::bv2rl-1741218468571-
d8b81d1bc9da",
"transfer-encoding": "chunked"
}
},
"screenshotUrl": null,
"text": "Update Group Picture - Evolution API Documentation
\nAuthorizations\nYour authorization key header\nPath
Parameters\nID of the instance to connect\nQuery Parameters
\nBody\nNew profile picture image URL",
"markdown": "# Update Group Picture - Evolution API
Documentation\n\n#### Authorizations\n\nYour authorization key
header\n\n#### Path Parameters\n\nID of the instance to
connect\n\n#### Query Parameters\n\n#### Body\n\nNew profile
picture image URL",
"debug": {
"requestHandlerMode": "http"
}
},
{
"url": "https://doc.evolution-api.com/v1/api-
reference/message-controller/send-contact",
"crawl": {
"loadedUrl": "https://doc.evolution-api.com/v1/api-
reference/message-controller/send-contact",
"loadedTime": "2025-03-05T23:47:50.740Z",
"referrerUrl": "https://doc.evolution-api.com/v1/api-
reference/chat-controller/check-is-whatsapp",
"depth": null
},
90
 "metadata": {
"canonicalUrl": "https://doc.evolution-api.com/v1/api-
reference/message-controller/send-contact",
"title": "Send Contact - Evolution API Documentation",
"description": "Send Contact",
"author": null,
"keywords": null,
"languageCode": "en",
"openGraph": [
{
"property": "og:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Send+Contact&description=Send+Con
tact&logoLight=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover.png&logoDark=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover-white.png&primaryColor=%2349BC94&lightColor=%2349BC94
&darkColor=%2349BC94"
},
{
"property": "og:image:width",
"content": "1200"
},
{
"property": "og:image:height",
"content": "630"
},
{
"property": "twitter:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Send+Contact&description=Send+Con
tact&logoLight=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover.png&logoDark=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover-white.png&primaryColor=%2349BC94&lightColor=%2349BC94
&darkColor=%2349BC94"
},
{
"property": "twitter:image:width",
"content": "1200"
},
{
"property": "twitter:image:height",
"content": "630"
}
],
"jsonLd": null,
"headers": {
"age": "281",
"cache-control": "public, max-age=0, must-revalidate",
"content-encoding": "br",
"content-type": "text/html; charset=utf-8",
"date": "Wed, 05 Mar 2025 23:43:09 GMT",
"etag": "W/\"uru1bie0076icu\"",
"server": "Vercel",
91
 "strict-transport-security": "max-age=63072000",
"x-frame-options": "DENY",
"x-matched-path": "/_sites/[subdomain]/[[...slug]]",
"x-powered-by": "Next.js",
"x-vercel-cache": "HIT",
"x-vercel-id": "iad1::iad1::q26h7-1741218470574-
b6132dfbaaf4",
"transfer-encoding": "chunked"
}
},
"screenshotUrl": null,
"text": "Send Contact - Evolution API Documentation
\nAuthorizations\nYour authorization key header\nPath
Parameters\nID of the instance to connect\nBody\nNumber to
receive the message (with country code)\nPhone number non-
stylized with country code
(553198296801)\ncontactMessage.phoneNumber\nPhone number
stylized (+55 31 9 9999-9999)\ncontactMessage.organization
\nOrganization name for the contact\nPresence time in
milliseconds before sending message\nPresence type to show
\nAvailable options:\ncomposing \nThe key of the message,
which identifies the message in the chat.\nIndicates whether
the message was sent by the user.\nThe message content, which
may include various types of messages like text, images,
contact, etc.\nDetails of the contact message.
\nmessage.contactMessage.displayName\nThe display name of the
contact.\nmessage.contactMessage.vcard\nThe vCard format
contact information.\nmessage.contactMessage.contextInfo
\nAdditional context information.\nThe timestamp of the
message, represented as a string.\nThe status of the message,
such as sent, received, or pending.",
"markdown": "# Send Contact - Evolution API Documentation\n
\n#### Authorizations\n\nYour authorization key header\n\n####
Path Parameters\n\nID of the instance to connect\n\n#### Body
\n\nNumber to receive the message (with country code)\n\nPhone
number non-stylized with country code (553198296801)\n
\ncontactMessage.phoneNumber\n\nPhone number stylized (+55 31
9 9999-9999)\n\ncontactMessage.organization\n\nOrganization
name for the contact\n\nPresence time in milliseconds before
sending message\n\nPresence type to show\n\nAvailable options:
\n\n`composing`\n\nThe key of the message, which identifies
the message in the chat.\n\nIndicates whether the message was
sent by the user.\n\nThe message content, which may include
various types of messages like text, images, contact, etc.\n
\nDetails of the contact message.\n
\nmessage.contactMessage.displayName\n\nThe display name of
the contact.\n\nmessage.contactMessage.vcard\n\nThe vCard
format contact information.\n
\nmessage.contactMessage.contextInfo\n\nAdditional context
information.\n\nThe timestamp of the message, represented as a
string.\n\nThe status of the message, such as sent, received,
or pending.",
"debug": {
"requestHandlerMode": "http"
}
},
{
92
 "url": "https://doc.evolution-api.com/v1/api-
reference/group-controller/update-group-subject",
"crawl": {
"loadedUrl": "https://doc.evolution-api.com/v1/api-
reference/group-controller/update-group-subject",
"loadedTime": "2025-03-05T23:47:50.862Z",
"referrerUrl": "https://doc.evolution-api.com/v1/api-
reference/chat-controller/check-is-whatsapp",
"depth": null
},
"metadata": {
"canonicalUrl": "https://doc.evolution-api.com/v1/api-
reference/group-controller/update-group-subject",
"title": "Update Group Subject - Evolution API
Documentation",
"description": "Update group subject",
"author": null,
"keywords": null,
"languageCode": "en",
"openGraph": [
{
"property": "og:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Update+Group+Subject&description=
Update+group+subject&logoLight=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover.png&logoDark=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover-white.png&primaryColor=%2349BC94&lightColor=%2349BC94
&darkColor=%2349BC94"
},
{
"property": "og:image:width",
"content": "1200"
},
{
"property": "og:image:height",
"content": "630"
},
{
"property": "twitter:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Update+Group+Subject&description=
Update+group+subject&logoLight=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover.png&logoDark=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover-white.png&primaryColor=%2349BC94&lightColor=%2349BC94
&darkColor=%2349BC94"
},
{
"property": "twitter:image:width",
"content": "1200"
},
{
"property": "twitter:image:height",
"content": "630"
93
 }
],
"jsonLd": null,
"headers": {
"age": "254",
"cache-control": "public, max-age=0, must-revalidate",
"content-encoding": "br",
"content-type": "text/html; charset=utf-8",
"date": "Wed, 05 Mar 2025 23:43:35 GMT",
"etag": "W/\"offuz4gn3z5bs3\"",
"server": "Vercel",
"strict-transport-security": "max-age=63072000",
"x-frame-options": "DENY",
"x-matched-path": "/_sites/[subdomain]/[[...slug]]",
"x-powered-by": "Next.js",
"x-vercel-cache": "HIT",
"x-vercel-id":
"iad1::iad1::jsdnb-1741218470763-787eff43d892",
"transfer-encoding": "chunked"
}
},
"screenshotUrl": null,
"text": "Update Group Subject - Evolution API Documentation
\nAuthorizations\nYour authorization key header\nPath
Parameters\nID of the instance to connect\nQuery Parameters
\nBody",
"markdown": "# Update Group Subject - Evolution API
Documentation\n\n#### Authorizations\n\nYour authorization key
header\n\n#### Path Parameters\n\nID of the instance to
connect\n\n#### Query Parameters\n\n#### Body",
"debug": {
"requestHandlerMode": "http"
}
},
{
"url": "https://doc.evolution-api.com/v1/api-
reference/group-controller/toggle-ephemeral",
"crawl": {
"loadedUrl": "https://doc.evolution-api.com/v1/api-
reference/group-controller/toggle-ephemeral",
"loadedTime": "2025-03-05T23:47:52.036Z",
"referrerUrl": "https://doc.evolution-api.com/v1/api-
reference/chat-controller/check-is-whatsapp",
"depth": null
},
"metadata": {
"canonicalUrl": "https://doc.evolution-api.com/v1/api-
reference/group-controller/toggle-ephemeral",
"title": "Toggle Ephemeral - Evolution API Documentation",
"description": "Toggle temporary messages on group",
"author": null,
"keywords": null,
"languageCode": "en",
"openGraph": [
{
"property": "og:image",
"content": "https://mintlify.com/docs/api/og?
94
division=Documentation&title=Toggle+Ephemeral&description=Togg
le+temporary+messages+on+group&logoLight=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover.png&logoDark=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover-white.png&primaryColor=%2349BC94
&lightColor=%2349BC94&darkColor=%2349BC94"
},
{
"property": "og:image:width",
"content": "1200"
},
{
"property": "og:image:height",
"content": "630"
},
{
"property": "twitter:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Toggle+Ephemeral&description=Togg
le+temporary+messages+on+group&logoLight=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover.png&logoDark=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover-white.png&primaryColor=%2349BC94
&lightColor=%2349BC94&darkColor=%2349BC94"
},
{
"property": "twitter:image:width",
"content": "1200"
},
{
"property": "twitter:image:height",
"content": "630"
}
],
"jsonLd": null,
"headers": {
"age": "255",
"cache-control": "public, max-age=0, must-revalidate",
"content-encoding": "br",
"content-type": "text/html; charset=utf-8",
"date": "Wed, 05 Mar 2025 23:43:36 GMT",
"etag": "W/\"gisle0sxnp5bzb\"",
"server": "Vercel",
"strict-transport-security": "max-age=63072000",
"x-frame-options": "DENY",
"x-matched-path": "/_sites/[subdomain]/[[...slug]]",
"x-powered-by": "Next.js",
"x-vercel-cache": "HIT",
"x-vercel-id":
"iad1::iad1::w9gdv-1741218471952-9d054df2f021",
"transfer-encoding": "chunked"
}
},
"screenshotUrl": null,
"text": "Toggle Ephemeral - Evolution API Documentation
95
\nAuthorizations\nYour authorization key header\nPath
Parameters\nID of the instance to connect\nQuery Parameters
\nBody\nTime to expire message (in seconds)",
"markdown": "# Toggle Ephemeral - Evolution API
Documentation\n\n#### Authorizations\n\nYour authorization key
header\n\n#### Path Parameters\n\nID of the instance to
connect\n\n#### Query Parameters\n\n#### Body\n\nTime to
expire message (in seconds)",
"debug": {
"requestHandlerMode": "http"
}
},
{
"url": "https://doc.evolution-api.com/v1/api-
reference/group-controller/update-group-description",
"crawl": {
"loadedUrl": "https://doc.evolution-api.com/v1/api-
reference/group-controller/update-group-description",
"loadedTime": "2025-03-05T23:47:52.942Z",
"referrerUrl": "https://doc.evolution-api.com/v1/api-
reference/chat-controller/check-is-whatsapp",
"depth": null
},
"metadata": {
"canonicalUrl": "https://doc.evolution-api.com/v1/api-
reference/group-controller/update-group-description",
"title": "Update Group Description - Evolution API
Documentation",
"description": "Update group description",
"author": null,
"keywords": null,
"languageCode": "en",
"openGraph": [
{
"property": "og:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Update+Group+Description&descript
ion=Update+group+description&logoLight=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover.png&logoDark=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover-white.png&primaryColor=%2349BC94
&lightColor=%2349BC94&darkColor=%2349BC94"
},
{
"property": "og:image:width",
"content": "1200"
},
{
"property": "og:image:height",
"content": "630"
},
{
"property": "twitter:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Update+Group+Description&descript
ion=Update+group+description&logoLight=https%3A%2F%
96
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover.png&logoDark=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover-white.png&primaryColor=%2349BC94
&lightColor=%2349BC94&darkColor=%2349BC94"
},
{
"property": "twitter:image:width",
"content": "1200"
},
{
"property": "twitter:image:height",
"content": "630"
}
],
"jsonLd": null,
"headers": {
"age": "256",
"cache-control": "public, max-age=0, must-revalidate",
"content-encoding": "br",
"content-type": "text/html; charset=utf-8",
"date": "Wed, 05 Mar 2025 23:43:35 GMT",
"etag": "W/\"ab55eopqq45bwh\"",
"server": "Vercel",
"strict-transport-security": "max-age=63072000",
"x-frame-options": "DENY",
"x-matched-path": "/_sites/[subdomain]/[[...slug]]",
"x-powered-by": "Next.js",
"x-vercel-cache": "HIT",
"x-vercel-id":
"iad1::iad1::mc4f4-1741218472837-7556fd1221b2",
"transfer-encoding": "chunked"
}
},
"screenshotUrl": null,
"text": "Update Group Description - Evolution API
Documentation\nAuthorizations\nYour authorization key header
\nPath Parameters\nID of the instance to connect\nQuery
Parameters\nBody",
"markdown": "# Update Group Description - Evolution API
Documentation\n\n#### Authorizations\n\nYour authorization key
header\n\n#### Path Parameters\n\nID of the instance to
connect\n\n#### Query Parameters\n\n#### Body",
"debug": {
"requestHandlerMode": "http"
}
},
{
"url": "https://doc.evolution-api.com/v1/api-
reference/group-controller/fetch-invite-code",
"crawl": {
"loadedUrl": "https://doc.evolution-api.com/v1/api-
reference/group-controller/fetch-invite-code",
"loadedTime": "2025-03-05T23:47:53.040Z",
"referrerUrl": "https://doc.evolution-api.com/v1/api-
reference/chat-controller/check-is-whatsapp",
"depth": null
97
 },
"metadata": {
"canonicalUrl": "https://doc.evolution-api.com/v1/api-
reference/group-controller/fetch-invite-code",
"title": "Fetch Invite Code - Evolution API
Documentation",
"description": "Fetch group invite code",
"author": null,
"keywords": null,
"languageCode": "en",
"openGraph": [
{
"property": "og:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Fetch+Invite+Code&description=Fet
ch+group+invite+code&logoLight=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover.png&logoDark=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover-white.png&primaryColor=%2349BC94&lightColor=%2349BC94
&darkColor=%2349BC94"
},
{
"property": "og:image:width",
"content": "1200"
},
{
"property": "og:image:height",
"content": "630"
},
{
"property": "twitter:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Fetch+Invite+Code&description=Fet
ch+group+invite+code&logoLight=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover.png&logoDark=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover-white.png&primaryColor=%2349BC94&lightColor=%2349BC94
&darkColor=%2349BC94"
},
{
"property": "twitter:image:width",
"content": "1200"
},
{
"property": "twitter:image:height",
"content": "630"
}
],
"jsonLd": null,
"headers": {
"age": "256",
"cache-control": "public, max-age=0, must-revalidate",
"content-encoding": "br",
"content-type": "text/html; charset=utf-8",
"date": "Wed, 05 Mar 2025 23:43:35 GMT",
98
 "etag": "W/\"5m7dt96o8z5gs9\"",
"server": "Vercel",
"strict-transport-security": "max-age=63072000",
"x-frame-options": "DENY",
"x-matched-path": "/_sites/[subdomain]/[[...slug]]",
"x-powered-by": "Next.js",
"x-vercel-cache": "HIT",
"x-vercel-id": "iad1::iad1::bv6q5-1741218472867-
d83e990b417c",
"transfer-encoding": "chunked"
}
},
"screenshotUrl": null,
"text": "Fetch Invite Code - Evolution API Documentation
\nAuthorizations\nYour authorization key header\nPath
Parameters\nID of the instance to connect\nQuery Parameters
\nThe URL for the WhatsApp group invite.\nThe code for the
WhatsApp group invite.",
"markdown": "# Fetch Invite Code - Evolution API
Documentation\n\n#### Authorizations\n\nYour authorization key
header\n\n#### Path Parameters\n\nID of the instance to
connect\n\n#### Query Parameters\n\nThe URL for the WhatsApp
group invite.\n\nThe code for the WhatsApp group invite.",
"debug": {
"requestHandlerMode": "http"
}
},
{
"url": "https://doc.evolution-api.com/v1/api-
reference/group-controller/accept-invite-code",
"crawl": {
"loadedUrl": "https://doc.evolution-api.com/v1/api-
reference/group-controller/accept-invite-code",
"loadedTime": "2025-03-05T23:47:59.237Z",
"referrerUrl": "https://doc.evolution-api.com/v1/api-
reference/chat-controller/check-is-whatsapp",
"depth": null
},
"metadata": {
"canonicalUrl": "https://doc.evolution-api.com/v1/api-
reference/group-controller/accept-invite-code",
"title": "Accept Invite Code - Evolution API
Documentation",
"description": "Fetch group invite code",
"author": null,
"keywords": null,
"languageCode": "en",
"openGraph": [
{
"property": "og:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Accept+Invite+Code&description=Fe
tch+group+invite+code&logoLight=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover.png&logoDark=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover-white.png&primaryColor=%2349BC94&lightColor=%2349BC94
99
&darkColor=%2349BC94"
},
{
"property": "og:image:width",
"content": "1200"
},
{
"property": "og:image:height",
"content": "630"
},
{
"property": "twitter:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Accept+Invite+Code&description=Fe
tch+group+invite+code&logoLight=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover.png&logoDark=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover-white.png&primaryColor=%2349BC94&lightColor=%2349BC94
&darkColor=%2349BC94"
},
{
"property": "twitter:image:width",
"content": "1200"
},
{
"property": "twitter:image:height",
"content": "630"
}
],
"jsonLd": null,
"headers": {
"age": "262",
"cache-control": "public, max-age=0, must-revalidate",
"content-encoding": "br",
"content-type": "text/html; charset=utf-8",
"date": "Wed, 05 Mar 2025 23:43:36 GMT",
"etag": "W/\"6lagu2zwc859g1\"",
"server": "Vercel",
"strict-transport-security": "max-age=63072000",
"x-frame-options": "DENY",
"x-matched-path": "/_sites/[subdomain]/[[...slug]]",
"x-powered-by": "Next.js",
"x-vercel-cache": "HIT",
"x-vercel-id": "iad1::iad1::zqsds-1741218479144-
e34205d6bd28",
"transfer-encoding": "chunked"
}
},
"screenshotUrl": null,
"text": "Accept Invite Code - Evolution API Documentation
\nAuthorizations\nYour authorization key header\nPath
Parameters\nID of the instance to connect\nQuery Parameters",
"markdown": "# Accept Invite Code - Evolution API
Documentation\n\n#### Authorizations\n\nYour authorization key
header\n\n#### Path Parameters\n\nID of the instance to
connect\n\n#### Query Parameters",
100
 "debug": {
"requestHandlerMode": "http"
}
},
{
"url": "https://doc.evolution-api.com/v1/api-
reference/integrations/typebot/set-typebot",
"crawl": {
"loadedUrl": "https://doc.evolution-api.com/v1/api-
reference/integrations/typebot/set-typebot",
"loadedTime": "2025-03-05T23:47:59.160Z",
"referrerUrl": "https://doc.evolution-api.com/v1/api-
reference/chat-controller/check-is-whatsapp",
"depth": null
},
"metadata": {
"canonicalUrl": "https://doc.evolution-api.com/v1/api-
reference/integrations/typebot/set-typebot",
"title": "Set Typebot - Evolution API Documentation",
"description": "Set typebot",
"author": null,
"keywords": null,
"languageCode": "en",
"openGraph": [
{
"property": "og:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Set+Typebot&description=Set+typeb
ot&logoLight=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover.png&logoDark=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover-white.png&primaryColor=%2349BC94&lightColor=%2349BC94
&darkColor=%2349BC94"
},
{
"property": "og:image:width",
"content": "1200"
},
{
"property": "og:image:height",
"content": "630"
},
{
"property": "twitter:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Set+Typebot&description=Set+typeb
ot&logoLight=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover.png&logoDark=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover-white.png&primaryColor=%2349BC94&lightColor=%2349BC94
&darkColor=%2349BC94"
},
{
"property": "twitter:image:width",
"content": "1200"
101
 },
{
"property": "twitter:image:height",
"content": "630"
}
],
"jsonLd": null,
"headers": {
"age": "262",
"cache-control": "public, max-age=0, must-revalidate",
"content-encoding": "br",
"content-type": "text/html; charset=utf-8",
"date": "Wed, 05 Mar 2025 23:43:36 GMT",
"etag": "W/\"7z06zllck25kdk\"",
"server": "Vercel",
"strict-transport-security": "max-age=63072000",
"x-frame-options": "DENY",
"x-matched-path": "/_sites/[subdomain]/[[...slug]]",
"x-powered-by": "Next.js",
"x-vercel-cache": "HIT",
"x-vercel-id": "iad1::iad1::mc4f4-1741218479062-
d2a564dd5a1a",
"transfer-encoding": "chunked"
}
},
"screenshotUrl": null,
"text": "Set Typebot - Evolution API Documentation\nSet
typebot\nAuthorizations\nYour authorization key header\nPath
Parameters\nID of the instance to connect\nBody\nTime to
expire the sessions\nKey word to finish typebot flow\nDefault
delay for text messages\n'Unknown message' error message
\nStart typebot for your own messages",
"markdown": "# Set Typebot - Evolution API Documentation\n
\nSet typebot\n\n#### Authorizations\n\nYour authorization key
header\n\n#### Path Parameters\n\nID of the instance to
connect\n\n#### Body\n\nTime to expire the sessions\n\nKey
word to finish typebot flow\n\nDefault delay for text messages
\n\n'Unknown message' error message\n\nStart typebot for your
own messages",
"debug": {
"requestHandlerMode": "http"
}
},
{
"url": "https://doc.evolution-api.com/v1/api-
reference/integrations/typebot/start-typebot",
"crawl": {
"loadedUrl": "https://doc.evolution-api.com/v1/api-
reference/integrations/typebot/start-typebot",
"loadedTime": "2025-03-05T23:47:59.200Z",
"referrerUrl": "https://doc.evolution-api.com/v1/api-
reference/chat-controller/check-is-whatsapp",
"depth": null
},
"metadata": {
"canonicalUrl": "https://doc.evolution-api.com/v1/api-
reference/integrations/typebot/start-typebot",
102
 "title": "Start Typebot - Evolution API Documentation",
"description": "Start typebot",
"author": null,
"keywords": null,
"languageCode": "en",
"openGraph": [
{
"property": "og:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Start+Typebot&description=Start+t
ypebot&logoLight=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover.png&logoDark=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover-white.png&primaryColor=%2349BC94&lightColor=%2349BC94
&darkColor=%2349BC94"
},
{
"property": "og:image:width",
"content": "1200"
},
{
"property": "og:image:height",
"content": "630"
},
{
"property": "twitter:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Start+Typebot&description=Start+t
ypebot&logoLight=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover.png&logoDark=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover-white.png&primaryColor=%2349BC94&lightColor=%2349BC94
&darkColor=%2349BC94"
},
{
"property": "twitter:image:width",
"content": "1200"
},
{
"property": "twitter:image:height",
"content": "630"
}
],
"jsonLd": null,
"headers": {
"age": "263",
"cache-control": "public, max-age=0, must-revalidate",
"content-encoding": "br",
"content-type": "text/html; charset=utf-8",
"date": "Wed, 05 Mar 2025 23:43:35 GMT",
"etag": "W/\"106uvsijrjr5jni\"",
"server": "Vercel",
"strict-transport-security": "max-age=63072000",
"x-frame-options": "DENY",
"x-matched-path": "/_sites/[subdomain]/[[...slug]]",
103
 "x-powered-by": "Next.js",
"x-vercel-cache": "HIT",
"x-vercel-id": "iad1::iad1::pb4t8-1741218479061-
adc2f25a7edb",
"transfer-encoding": "chunked"
}
},
"screenshotUrl": null,
"text": "Start Typebot - Evolution API Documentation\nStart
typebot\nAuthorizations\nYour authorization key header\nPath
Parameters\nID of the instance to connect\nBody",
"markdown": "# Start Typebot - Evolution API Documentation\n
\nStart typebot\n\n#### Authorizations\n\nYour authorization
key header\n\n#### Path Parameters\n\nID of the instance to
connect\n\n#### Body",
"debug": {
"requestHandlerMode": "http"
}
},
{
"url": "https://doc.evolution-api.com/v1/api-
reference/group-controller/revoke-invite-code",
"crawl": {
"loadedUrl": "https://doc.evolution-api.com/v1/api-
reference/group-controller/revoke-invite-code",
"loadedTime": "2025-03-05T23:48:00.650Z",
"referrerUrl": "https://doc.evolution-api.com/v1/api-
reference/chat-controller/check-is-whatsapp",
"depth": null
},
"metadata": {
"canonicalUrl": "https://doc.evolution-api.com/v1/api-
reference/group-controller/revoke-invite-code",
"title": "Revoke Invite Code - Evolution API
Documentation",
"description": "Fetch group invite code",
"author": null,
"keywords": null,
"languageCode": "en",
"openGraph": [
{
"property": "og:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Revoke+Invite+Code&description=Fe
tch+group+invite+code&logoLight=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover.png&logoDark=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover-white.png&primaryColor=%2349BC94&lightColor=%2349BC94
&darkColor=%2349BC94"
},
{
"property": "og:image:width",
"content": "1200"
},
{
"property": "og:image:height",
104
 "content": "630"
},
{
"property": "twitter:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Revoke+Invite+Code&description=Fe
tch+group+invite+code&logoLight=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover.png&logoDark=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover-white.png&primaryColor=%2349BC94&lightColor=%2349BC94
&darkColor=%2349BC94"
},
{
"property": "twitter:image:width",
"content": "1200"
},
{
"property": "twitter:image:height",
"content": "630"
}
],
"jsonLd": null,
"headers": {
"age": "264",
"cache-control": "public, max-age=0, must-revalidate",
"content-encoding": "br",
"content-type": "text/html; charset=utf-8",
"date": "Wed, 05 Mar 2025 23:43:35 GMT",
"etag": "W/\"w2lpcmhxkb59fp\"",
"server": "Vercel",
"strict-transport-security": "max-age=63072000",
"x-frame-options": "DENY",
"x-matched-path": "/_sites/[subdomain]/[[...slug]]",
"x-powered-by": "Next.js",
"x-vercel-cache": "HIT",
"x-vercel-id": "iad1::iad1::zqsds-1741218480548-
f1efd392623c",
"transfer-encoding": "chunked"
}
},
"screenshotUrl": null,
"text": "Revoke Invite Code - Evolution API Documentation
\nAuthorizations\nYour authorization key header\nPath
Parameters\nID of the instance to connect\nQuery Parameters",
"markdown": "# Revoke Invite Code - Evolution API
Documentation\n\n#### Authorizations\n\nYour authorization key
header\n\n#### Path Parameters\n\nID of the instance to
connect\n\n#### Query Parameters",
"debug": {
"requestHandlerMode": "http"
}
},
{
"url": "https://doc.evolution-api.com/v1/api-
reference/message-controller/send-reaction",
"crawl": {
105
 "loadedUrl": "https://doc.evolution-api.com/v1/api-
reference/message-controller/send-reaction",
"loadedTime": "2025-03-05T23:47:55.964Z",
"referrerUrl": "https://doc.evolution-api.com/v1/api-
reference/chat-controller/check-is-whatsapp",
"depth": null,
"httpStatusCode": 200
},
"metadata": {
"canonicalUrl": "https://doc.evolution-api.com/v1/api-
reference/message-controller/send-reaction",
"title": "Send Reaction - Evolution API Documentation",
"description": "Send Reaction",
"author": null,
"keywords": null,
"languageCode": "en",
"openGraph": [
{
"property": "og:image:width",
"content": "1200"
},
{
"property": "og:image:height",
"content": "630"
},
{
"property": "twitter:image:width",
"content": "1200"
},
{
"property": "twitter:image:height",
"content": "630"
},
{
"property": "og:image",
"content": "https://doc.evolution-api.com/api/og?
division=Documentation&title=Send+Reaction&description=Send+Re
action&logoLight=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover.png&logoDark=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover-white.png&primaryColor=%2349BC94&lightColor=%2349BC94
&darkColor=%2349BC94"
},
{
"property": "twitter:image",
"content": "https://doc.evolution-api.com/api/og?
division=Documentation&title=Send+Reaction&description=Send+Re
action&logoLight=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover.png&logoDark=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover-white.png&primaryColor=%2349BC94&lightColor=%2349BC94
&darkColor=%2349BC94"
}
],
"jsonLd": null,
106
 "headers": {
"age": "283",
"cache-control": "public, max-age=0, must-revalidate",
"content-encoding": "br",
"content-type": "text/html; charset=utf-8",
"date": "Wed, 05 Mar 2025 23:43:09 GMT",
"etag": "W/\"dyaaaf8l9v6frd\"",
"server": "Vercel",
"strict-transport-security": "max-age=63072000",
"x-frame-options": "DENY",
"x-matched-path": "/_sites/[subdomain]/[[...slug]]",
"x-powered-by": "Next.js",
"x-vercel-cache": "HIT",
"x-vercel-id": "iad1::iad1::8skmw-1741218472797-
c366b27a67e6",
"x-firefox-spdy": "h2"
}
},
"screenshotUrl": null,
"text": "Send Reaction - Evolution API Documentation
\ncurl --request POST \\ --url https://{server-
url}/message/sendReaction/{instance} \\ --header 'Content-
Type: application/json' \\ --header 'apikey: <api-key>' \\ --
data '{ \"reactionMessage\": { \"key\": { \"remoteJid\":
\"<string>\", \"fromMe\": true, \"id\": \"<string>\" },
\"reaction\": \"🚀\" } }'\n{ \"key\": { \"remoteJid\":
\"[email protected]\", \"fromMe\": true, \"id\":
\"BAE569F0E38F858D\" }, \"message\": { \"reactionMessage\":
{ \"key\": { \"remoteJid\": \"[email protected]\",
\"fromMe\": true, \"id\": \"BAE58DA6CBC941BC\" }, \"text\":
\"🚀\", \"senderTimestampMs\": \"1717781105034\" } },
\"messageTimestamp\": \"1717781105\", \"status\": \"PENDING
\" }",
"markdown": "# Send Reaction - Evolution API Documentation\n
\n```\ncurl --request POST \\\n --url https://{server-
url}/message/sendReaction/{instance} \\\n --header 'Content-
Type: application/json' \\\n --header 'apikey: <api-key>'
\\\n --data '{\n \"reactionMessage\": {\n \"key\": {\n
\"remoteJid\": \"<string>\",\n \"fromMe\": true,\n
\"id\": \"<string>\"\n },\n \"reaction\": \"ðŸš
€\"\n }\n}'\n```\n\n```\n{\n \"key\": {\n \"remoteJid\":
\"[email protected]\",\n \"fromMe\": true,\n
\"id\": \"BAE569F0E38F858D\"\n },\n \"message\": {\n
\"reactionMessage\": {\n \"key\": {\n \"remoteJid
\": \"[email protected]\",\n \"fromMe\":
true,\n \"id\": \"BAE58DA6CBC941BC\"\n },\n
\"text\": \"🚀\",\n \"senderTimestampMs\":
\"1717781105034\"\n }\n },\n \"messageTimestamp\":
\"1717781105\",\n \"status\": \"PENDING\"\n}\n```",
"debug": {
"requestHandlerMode": "browser"
}
},
{
"url": "https://doc.evolution-api.com/v1/api-
reference/message-controller/send-poll",
"crawl": {
107
 "loadedUrl": "https://doc.evolution-api.com/v1/api-
reference/message-controller/send-poll",
"loadedTime": "2025-03-05T23:47:56.260Z",
"referrerUrl": "https://doc.evolution-api.com/v1/api-
reference/chat-controller/check-is-whatsapp",
"depth": null,
"httpStatusCode": 200
},
"metadata": {
"canonicalUrl": "https://doc.evolution-api.com/v1/api-
reference/message-controller/send-poll",
"title": "Send Poll - Evolution API Documentation",
"description": "Send Poll",
"author": null,
"keywords": null,
"languageCode": "en",
"openGraph": [
{
"property": "og:image:width",
"content": "1200"
},
{
"property": "og:image:height",
"content": "630"
},
{
"property": "twitter:image:width",
"content": "1200"
},
{
"property": "twitter:image:height",
"content": "630"
},
{
"property": "og:image",
"content": "https://doc.evolution-api.com/api/og?
division=Documentation&title=Send+Poll&description=Send+Poll&l
ogoLight=https%3A%2F%2Fmintlify.s3.us-west-1.amazonaws.com%
2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover.png&logoDark=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover-white.png&primaryColor=%2349BC94&lightColor=%2349BC94
&darkColor=%2349BC94"
},
{
"property": "twitter:image",
"content": "https://doc.evolution-api.com/api/og?
division=Documentation&title=Send+Poll&description=Send+Poll&l
ogoLight=https%3A%2F%2Fmintlify.s3.us-west-1.amazonaws.com%
2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover.png&logoDark=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover-white.png&primaryColor=%2349BC94&lightColor=%2349BC94
&darkColor=%2349BC94"
}
],
"jsonLd": null,
108
 "headers": {
"age": "283",
"cache-control": "public, max-age=0, must-revalidate",
"content-encoding": "br",
"content-type": "text/html; charset=utf-8",
"date": "Wed, 05 Mar 2025 23:43:09 GMT",
"etag": "W/\"umim953g096lju\"",
"server": "Vercel",
"strict-transport-security": "max-age=63072000",
"x-frame-options": "DENY",
"x-matched-path": "/_sites/[subdomain]/[[...slug]]",
"x-powered-by": "Next.js",
"x-vercel-cache": "HIT",
"x-vercel-id":
"iad1::iad1::rpnk7-1741218472987-747f28c15a32",
"x-firefox-spdy": "h2"
}
},
"screenshotUrl": null,
"text": "Send Poll - Evolution API Documentation\nSend Poll
\nPOST\n/\nmessage\n/\nsendPoll\n/\n{instance}\ncurl --request
POST \\ --url https://{server-url}/message/sendPoll/{instance}
\\ --header 'Content-Type: application/json' \\ --header
'apikey: <api-key>' \\ --data '{ \"number\": \"<string>\",
\"options\": { \"delay\": 123, \"presence\": \"composing\" },
\"pollMessage\": { \"name\": \"<string>\", \"selectableCount
\": 2, \"values\": [ \"<string>\" ] } }'\n{ \"key\":
{ \"remoteJid\": \"[email protected]\", \"fromMe\":
true, \"id\": \"BAE53EC8D8E1FD8A\" }, \"message\":
{ \"messageContextInfo\": { \"messageSecret\": \"lX/
+cLHHNfnTTKZi+88mrhoyi6KNuUzWjgfaB0bTfOY=\" },
\"pollCreationMessage\": { \"name\": \"Poll Name\", \"options
\": [ { \"optionName\": \"Option 1\" }, { \"optionName\":
\"Option 2\" }, { \"optionName\": \"Option 3\" } ],
\"selectableOptionsCount\": 1 } }, \"messageTimestamp\":
\"1717781848\", \"status\": \"PENDING\" }\nAuthorizations
\nYour authorization key header\nPath Parameters\nID of the
instance to connect\nBody\nNumber to receive the message (with
country code)\npollMessage.selectableCount\nHow many options
each person can select\nRequired range: x >= 1\nPresence time
in milliseconds before sending message\nPresence type to show
\nAvailable options:\ncomposing,\nrecording \nThe key of the
message, which identifies the message in the chat.\nIndicates
whether the message was sent by the user.\nThe message
content, which may include various types of messages like
text, images, poll creation, etc.\nmessage.messageContextInfo
\nInformation about the context of the message.
\nmessage.messageContextInfo.messageSecret\nThe secret of the
message context.\nmessage.pollCreationMessage\nDetails of the
poll creation message.\nmessage.pollCreationMessage.name
\nmessage.pollCreationMessage.options\nThe options available
in the poll.\nmessage.pollCreationMessage.options.optionName
\nThe name of the poll option.
\nmessage.pollCreationMessage.selectableOptionsCount\nThe
number of options that can be selected in the poll.\nThe
timestamp of the message, represented as a string.\nThe status
of the message, such as sent, received, or pending.\ncurl --
109
request POST \\ --url https://{server-
url}/message/sendPoll/{instance} \\ --header 'Content-Type:
application/json' \\ --header 'apikey: <api-key>' \\ --data
'{ \"number\": \"<string>\", \"options\": { \"delay\": 123,
\"presence\": \"composing\" }, \"pollMessage\": { \"name\":
\"<string>\", \"selectableCount\": 2, \"values\":
[ \"<string>\" ] } }'\n{ \"key\": { \"remoteJid\":
\"[email protected]\", \"fromMe\": true, \"id\":
\"BAE53EC8D8E1FD8A\" }, \"message\": { \"messageContextInfo\":
{ \"messageSecret\": \"lX/+cLHHNfnTTKZi+
88mrhoyi6KNuUzWjgfaB0bTfOY=\" }, \"pollCreationMessage\":
{ \"name\": \"Poll Name\", \"options\": [ { \"optionName\":
\"Option 1\" }, { \"optionName\": \"Option 2\" },
{ \"optionName\": \"Option 3\" } ], \"selectableOptionsCount
\": 1 } }, \"messageTimestamp\": \"1717781848\", \"status\":
\"PENDING\" }",
"markdown": "# Send Poll - Evolution API Documentation\n
\nSend Poll\n\nPOST\n\n/\n\nmessage\n\n/\n\nsendPoll\n\n/\n
\n{instance}\n\n```\ncurl --request POST \\\n --url
https://{server-url}/message/sendPoll/{instance} \\\n --
header 'Content-Type: application/json' \\\n --header
'apikey: <api-key>' \\\n --data '{\n \"number\":
\"<string>\",\n \"options\": {\n \"delay\": 123,\n
\"presence\": \"composing\"\n },\n \"pollMessage\": {\n
\"name\": \"<string>\",\n \"selectableCount\": 2,\n
\"values\": [\n \"<string>\"\n ]\n }\n}'\n```\n\n```
\n{\n \"key\": {\n \"remoteJid\": \"553198296801
@s.whatsapp.net\",\n \"fromMe\": true,\n \"id\":
\"BAE53EC8D8E1FD8A\"\n },\n \"message\": {\n
\"messageContextInfo\": {\n \"messageSecret\": \"lX/
+cLHHNfnTTKZi+88mrhoyi6KNuUzWjgfaB0bTfOY=\"\n },\n
\"pollCreationMessage\": {\n \"name\": \"Poll Name\",\n
\"options\": [\n {\n \"optionName\": \"Option
1\"\n },\n {\n \"optionName\": \"Option
2\"\n },\n {\n \"optionName\": \"Option
3\"\n }\n ],\n \"selectableOptionsCount\": 1
\n }\n },\n \"messageTimestamp\": \"1717781848\",\n
\"status\": \"PENDING\"\n}\n```\n\n#### Authorizations\n\nYour
authorization key header\n\n#### Path Parameters\n\nID of the
instance to connect\n\n#### Body\n\nNumber to receive the
message (with country code)\n\npollMessage.selectableCount\n
\nHow many options each person can select\n\nRequired range:
`x >= 1`\n\nPresence time in milliseconds before sending
message\n\nPresence type to show\n\nAvailable options:\n
\n`composing`,\n\n`recording`\n\nThe key of the message, which
identifies the message in the chat.\n\nIndicates whether the
message was sent by the user.\n\nThe message content, which
may include various types of messages like text, images, poll
creation, etc.\n\nmessage.messageContextInfo\n\nInformation
about the context of the message.\n
\nmessage.messageContextInfo.messageSecret\n\nThe secret of
the message context.\n\nmessage.pollCreationMessage\n\nDetails
of the poll creation message.\n
\nmessage.pollCreationMessage.name\n
\nmessage.pollCreationMessage.options\n\nThe options available
in the poll.\n\nmessage.pollCreationMessage.options.optionName
\n\nThe name of the poll option.\n
110
\nmessage.pollCreationMessage.selectableOptionsCount\n\nThe
number of options that can be selected in the poll.\n\nThe
timestamp of the message, represented as a string.\n\nThe
status of the message, such as sent, received, or pending.\n
\n```\ncurl --request POST \\\n --url https://{server-
url}/message/sendPoll/{instance} \\\n --header 'Content-Type:
application/json' \\\n --header 'apikey: <api-key>' \\\n --
data '{\n \"number\": \"<string>\",\n \"options\": {\n
\"delay\": 123,\n \"presence\": \"composing\"\n },\n
\"pollMessage\": {\n \"name\": \"<string>\",\n
\"selectableCount\": 2,\n \"values\": [\n
\"<string>\"\n ]\n }\n}'\n```\n\n```\n{\n \"key\": {\n
\"remoteJid\": \"[email protected]\",\n \"fromMe
\": true,\n \"id\": \"BAE53EC8D8E1FD8A\"\n },\n \"message
\": {\n \"messageContextInfo\": {\n \"messageSecret\":
\"lX/+cLHHNfnTTKZi+88mrhoyi6KNuUzWjgfaB0bTfOY=\"\n },\n
\"pollCreationMessage\": {\n \"name\": \"Poll Name\",\n
\"options\": [\n {\n \"optionName\": \"Option
1\"\n },\n {\n \"optionName\": \"Option
2\"\n },\n {\n \"optionName\": \"Option
3\"\n }\n ],\n \"selectableOptionsCount\": 1
\n }\n },\n \"messageTimestamp\": \"1717781848\",\n
\"status\": \"PENDING\"\n}\n```",
"debug": {
"requestHandlerMode": "browser"
}
},
{
"url": "https://doc.evolution-api.com/v1/api-
reference/integrations/typebot/find-typebot",
"crawl": {
"loadedUrl": "https://doc.evolution-api.com/v1/api-
reference/integrations/typebot/find-typebot",
"loadedTime": "2025-03-05T23:48:01.947Z",
"referrerUrl": "https://doc.evolution-api.com/v1/api-
reference/chat-controller/check-is-whatsapp",
"depth": null
},
"metadata": {
"canonicalUrl": "https://doc.evolution-api.com/v1/api-
reference/integrations/typebot/find-typebot",
"title": "Find Typebot - Evolution API Documentation",
"description": "Find typebot",
"author": null,
"keywords": null,
"languageCode": "en",
"openGraph": [
{
"property": "og:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Find+Typebot&description=Find+typ
ebot&logoLight=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover.png&logoDark=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover-white.png&primaryColor=%2349BC94&lightColor=%2349BC94
&darkColor=%2349BC94"
111
 },
{
"property": "og:image:width",
"content": "1200"
},
{
"property": "og:image:height",
"content": "630"
},
{
"property": "twitter:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Find+Typebot&description=Find+typ
ebot&logoLight=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover.png&logoDark=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover-white.png&primaryColor=%2349BC94&lightColor=%2349BC94
&darkColor=%2349BC94"
},
{
"property": "twitter:image:width",
"content": "1200"
},
{
"property": "twitter:image:height",
"content": "630"
}
],
"jsonLd": null,
"headers": {
"age": "265",
"cache-control": "public, max-age=0, must-revalidate",
"content-encoding": "br",
"content-type": "text/html; charset=utf-8",
"date": "Wed, 05 Mar 2025 23:43:36 GMT",
"etag": "W/\"1853kr9yh7657hm\"",
"server": "Vercel",
"strict-transport-security": "max-age=63072000",
"x-frame-options": "DENY",
"x-matched-path": "/_sites/[subdomain]/[[...slug]]",
"x-powered-by": "Next.js",
"x-vercel-cache": "HIT",
"x-vercel-id":
"iad1::iad1::h4sbb-1741218481848-23a82466b113",
"transfer-encoding": "chunked"
}
},
"screenshotUrl": null,
"text": "Find Typebot - Evolution API Documentation\nFind
typebot\ncurl --request GET \\ --url https://{server-
url}/typebot/find/{instance} \\ --header 'apikey: <api-
key>'\nAuthorizations\nYour authorization key header\nPath
Parameters\nID of the instance to connect\ncurl --request GET
\\ --url https://{server-url}/typebot/find/{instance} \\ --
header 'apikey: <api-key>'",
"markdown": "# Find Typebot - Evolution API Documentation\n
112
\nFind typebot\n\n```\ncurl --request GET \\\n --url
https://{server-url}/typebot/find/{instance} \\\n --header
'apikey: <api-key>'\n```\n\n#### Authorizations\n\nYour
authorization key header\n\n#### Path Parameters\n\nID of the
instance to connect\n\n```\ncurl --request GET \\\n --url
https://{server-url}/typebot/find/{instance} \\\n --header
'apikey: <api-key>'\n```",
"debug": {
"requestHandlerMode": "http"
}
},
{
"url": "https://doc.evolution-api.com/v1/api-
reference/group-controller/send-invite-url",
"crawl": {
"loadedUrl": "https://doc.evolution-api.com/v1/api-
reference/group-controller/send-invite-url",
"loadedTime": "2025-03-05T23:48:02.348Z",
"referrerUrl": "https://doc.evolution-api.com/v1/api-
reference/chat-controller/check-is-whatsapp",
"depth": null
},
"metadata": {
"canonicalUrl": "https://doc.evolution-api.com/v1/api-
reference/group-controller/send-invite-url",
"title": "Send Group Invite - Evolution API
Documentation",
"description": "Send group invite",
"author": null,
"keywords": null,
"languageCode": "en",
"openGraph": [
{
"property": "og:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Send+Group+Invite&description=Sen
d+group+invite&logoLight=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover.png&logoDark=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover-white.png&primaryColor=%2349BC94&lightColor=%2349BC94
&darkColor=%2349BC94"
},
{
"property": "og:image:width",
"content": "1200"
},
{
"property": "og:image:height",
"content": "630"
},
{
"property": "twitter:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Send+Group+Invite&description=Sen
d+group+invite&logoLight=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
113
2Fcover.png&logoDark=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover-white.png&primaryColor=%2349BC94&lightColor=%2349BC94
&darkColor=%2349BC94"
},
{
"property": "twitter:image:width",
"content": "1200"
},
{
"property": "twitter:image:height",
"content": "630"
}
],
"jsonLd": null,
"headers": {
"age": "266",
"cache-control": "public, max-age=0, must-revalidate",
"content-encoding": "br",
"content-type": "text/html; charset=utf-8",
"date": "Wed, 05 Mar 2025 23:43:35 GMT",
"etag": "W/\"ikhawskle15ko1\"",
"server": "Vercel",
"strict-transport-security": "max-age=63072000",
"x-frame-options": "DENY",
"x-matched-path": "/_sites/[subdomain]/[[...slug]]",
"x-powered-by": "Next.js",
"x-vercel-cache": "HIT",
"x-vercel-id":
"iad1::iad1::4jrmx-1741218482049-7236f7ea121b",
"transfer-encoding": "chunked"
}
},
"screenshotUrl": null,
"text": "Send Group Invite - Evolution API Documentation
\nAuthorizations\nYour authorization key header\nPath
Parameters\nID of the instance to connect\nBody\nNumbers to
receive the invitation\nDescription to send with the
invitation\nIndicates if the invite was sent successfully.
\nThe URL for the WhatsApp group invite.",
"markdown": "# Send Group Invite - Evolution API
Documentation\n\n#### Authorizations\n\nYour authorization key
header\n\n#### Path Parameters\n\nID of the instance to
connect\n\n#### Body\n\nNumbers to receive the invitation\n
\nDescription to send with the invitation\n\nIndicates if the
invite was sent successfully.\n\nThe URL for the WhatsApp
group invite.",
"debug": {
"requestHandlerMode": "http"
}
},
{
"url": "https://doc.evolution-api.com/v1/api-
reference/integrations/typebot/change-session-status",
"crawl": {
"loadedUrl": "https://doc.evolution-api.com/v1/api-
reference/integrations/typebot/change-session-status",
114
 "loadedTime": "2025-03-05T23:48:02.033Z",
"referrerUrl": "https://doc.evolution-api.com/v1/api-
reference/chat-controller/check-is-whatsapp",
"depth": null
},
"metadata": {
"canonicalUrl": "https://doc.evolution-api.com/v1/api-
reference/integrations/typebot/change-session-status",
"title": "Change Typebot Status - Evolution API
Documentation",
"description": "Start typebot",
"author": null,
"keywords": null,
"languageCode": "en",
"openGraph": [
{
"property": "og:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Change+Typebot+Status&description
=Start+typebot&logoLight=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover.png&logoDark=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover-white.png&primaryColor=%2349BC94&lightColor=%2349BC94
&darkColor=%2349BC94"
},
{
"property": "og:image:width",
"content": "1200"
},
{
"property": "og:image:height",
"content": "630"
},
{
"property": "twitter:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Change+Typebot+Status&description
=Start+typebot&logoLight=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover.png&logoDark=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover-white.png&primaryColor=%2349BC94&lightColor=%2349BC94
&darkColor=%2349BC94"
},
{
"property": "twitter:image:width",
"content": "1200"
},
{
"property": "twitter:image:height",
"content": "630"
}
],
"jsonLd": null,
"headers": {
"age": "265",
115
 "cache-control": "public, max-age=0, must-revalidate",
"content-encoding": "br",
"content-type": "text/html; charset=utf-8",
"date": "Wed, 05 Mar 2025 23:43:36 GMT",
"etag": "W/\"10yexqgd6e35bqu\"",
"server": "Vercel",
"strict-transport-security": "max-age=63072000",
"x-frame-options": "DENY",
"x-matched-path": "/_sites/[subdomain]/[[...slug]]",
"x-powered-by": "Next.js",
"x-vercel-cache": "HIT",
"x-vercel-id": "iad1::iad1::4jrmx-1741218481857-
bd0ad818e790",
"transfer-encoding": "chunked"
}
},
"screenshotUrl": null,
"text": "Change Typebot Status - Evolution API Documentation
\nStart typebot\nAuthorizations\nYour authorization key header
\nPath Parameters\nID of the instance to connect\nBody\nNew
typebot status\nAvailable options:\nopened,\nclosed,\npaused",
"markdown": "# Change Typebot Status - Evolution API
Documentation\n\nStart typebot\n\n#### Authorizations\n\nYour
authorization key header\n\n#### Path Parameters\n\nID of the
instance to connect\n\n#### Body\n\nNew typebot status\n
\nAvailable options:\n\n`opened`,\n\n`closed`,\n\n`paused`",
"debug": {
"requestHandlerMode": "http"
}
},
{
"url": "https://doc.evolution-api.com/v1/api-
reference/group-controller/find-group-by-invite-code",
"crawl": {
"loadedUrl": "https://doc.evolution-api.com/v1/api-
reference/group-controller/find-group-by-invite-code",
"loadedTime": "2025-03-05T23:48:03.750Z",
"referrerUrl": "https://doc.evolution-api.com/v1/api-
reference/chat-controller/check-is-whatsapp",
"depth": null
},
"metadata": {
"canonicalUrl": "https://doc.evolution-api.com/v1/api-
reference/group-controller/find-group-by-invite-code",
"title": "Find Group by Invite Code - Evolution API
Documentation",
"description": "Find group by invite code",
"author": null,
"keywords": null,
"languageCode": "en",
"openGraph": [
{
"property": "og:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Find+Group+by+Invite+Code&descrip
tion=Find+group+by+invite+code&logoLight=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
116
2Fimages%2Fbrand%2Fcover.png&logoDark=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover-white.png&primaryColor=%2349BC94
&lightColor=%2349BC94&darkColor=%2349BC94"
},
{
"property": "og:image:width",
"content": "1200"
},
{
"property": "og:image:height",
"content": "630"
},
{
"property": "twitter:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Find+Group+by+Invite+Code&descrip
tion=Find+group+by+invite+code&logoLight=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover.png&logoDark=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover-white.png&primaryColor=%2349BC94
&lightColor=%2349BC94&darkColor=%2349BC94"
},
{
"property": "twitter:image:width",
"content": "1200"
},
{
"property": "twitter:image:height",
"content": "630"
}
],
"jsonLd": null,
"headers": {
"age": "267",
"cache-control": "public, max-age=0, must-revalidate",
"content-encoding": "br",
"content-type": "text/html; charset=utf-8",
"date": "Wed, 05 Mar 2025 23:43:35 GMT",
"etag": "W/\"s5oias62ds59dz\"",
"server": "Vercel",
"strict-transport-security": "max-age=63072000",
"x-frame-options": "DENY",
"x-matched-path": "/_sites/[subdomain]/[[...slug]]",
"x-powered-by": "Next.js",
"x-vercel-cache": "HIT",
"x-vercel-id":
"iad1::iad1::pb4t8-1741218482859-042161aa90ab",
"transfer-encoding": "chunked"
}
},
"screenshotUrl": null,
"text": "Find Group by Invite Code\nAuthorizations\nYour
authorization key header\nPath Parameters\nID of the instance
to connect\nQuery Parameters",
"markdown": "# Find Group by Invite Code\n\n####
117
Authorizations\n\nYour authorization key header\n\n#### Path
Parameters\n\nID of the instance to connect\n\n#### Query
Parameters",
"debug": {
"requestHandlerMode": "http"
}
},
{
"url": "https://doc.evolution-api.com/v1/api-
reference/integrations/sqs/set-sqs",
"crawl": {
"loadedUrl": "https://doc.evolution-api.com/v1/api-
reference/integrations/sqs/set-sqs",
"loadedTime": "2025-03-05T23:48:09.212Z",
"referrerUrl": "https://doc.evolution-api.com/v1/api-
reference/chat-controller/check-is-whatsapp",
"depth": null
},
"metadata": {
"canonicalUrl": "https://doc.evolution-api.com/v1/api-
reference/integrations/sqs/set-sqs",
"title": "Set SQS - Evolution API Documentation",
"description": "Set SQS",
"author": null,
"keywords": null,
"languageCode": "en",
"openGraph": [
{
"property": "og:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Set+SQS&description=Set+SQS&logoL
ight=https%3A%2F%2Fmintlify.s3.us-west-1.amazonaws.com%
2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover.png&logoDark=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover-white.png&primaryColor=%2349BC94&lightColor=%2349BC94
&darkColor=%2349BC94"
},
{
"property": "og:image:width",
"content": "1200"
},
{
"property": "og:image:height",
"content": "630"
},
{
"property": "twitter:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Set+SQS&description=Set+SQS&logoL
ight=https%3A%2F%2Fmintlify.s3.us-west-1.amazonaws.com%
2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover.png&logoDark=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover-white.png&primaryColor=%2349BC94&lightColor=%2349BC94
&darkColor=%2349BC94"
},
118
 {
"property": "twitter:image:width",
"content": "1200"
},
{
"property": "twitter:image:height",
"content": "630"
}
],
"jsonLd": null,
"headers": {
"age": "272",
"cache-control": "public, max-age=0, must-revalidate",
"content-encoding": "br",
"content-type": "text/html; charset=utf-8",
"date": "Wed, 05 Mar 2025 23:43:36 GMT",
"etag": "W/\"adtmcktww95cjo\"",
"server": "Vercel",
"strict-transport-security": "max-age=63072000",
"x-frame-options": "DENY",
"x-matched-path": "/_sites/[subdomain]/[[...slug]]",
"x-powered-by": "Next.js",
"x-vercel-cache": "HIT",
"x-vercel-id":
"iad1::iad1::ckkkg-1741218489132-312c2e7f1494",
"transfer-encoding": "chunked"
}
},
"screenshotUrl": null,
"text": "Set SQS - Evolution API Documentation\nSet SQS
\nAuthorizations\nYour authorization key header\nPath
Parameters\nID of the instance to connect\nBody\nEvents to be
sent to the Webhook\nAvailable options:\nAPPLICATION_STARTUP,
\nQRCODE_UPDATED,\nMESSAGES_SET,\nMESSAGES_UPSERT,
\nMESSAGES_UPDATE,\nMESSAGES_DELETE,\nSEND_MESSAGE,
\nCONTACTS_SET,\nCONTACTS_UPSERT,\nCONTACTS_UPDATE,
\nPRESENCE_UPDATE,\nCHATS_SET,\nCHATS_UPSERT,\nCHATS_UPDATE,
\nCHATS_DELETE,\nGROUPS_UPSERT,\nGROUP_UPDATE,
\nGROUP_PARTICIPANTS_UPDATE,\nCONNECTION_UPDATE,\nCALL,
\nNEW_JWT_TOKEN",
"markdown": "# Set SQS - Evolution API Documentation\n\nSet
SQS\n\n#### Authorizations\n\nYour authorization key header\n
\n#### Path Parameters\n\nID of the instance to connect\n
\n#### Body\n\nEvents to be sent to the Webhook\n\nAvailable
options:\n\n`APPLICATION_STARTUP`,\n\n`QRCODE_UPDATED`,\n
\n`MESSAGES_SET`,\n\n`MESSAGES_UPSERT`,\n\n`MESSAGES_UPDATE`,
\n\n`MESSAGES_DELETE`,\n\n`SEND_MESSAGE`,\n\n`CONTACTS_SET`,\n
\n`CONTACTS_UPSERT`,\n\n`CONTACTS_UPDATE`,\n
\n`PRESENCE_UPDATE`,\n\n`CHATS_SET`,\n\n`CHATS_UPSERT`,\n
\n`CHATS_UPDATE`,\n\n`CHATS_DELETE`,\n\n`GROUPS_UPSERT`,\n
\n`GROUP_UPDATE`,\n\n`GROUP_PARTICIPANTS_UPDATE`,\n
\n`CONNECTION_UPDATE`,\n\n`CALL`,\n\n`NEW_JWT_TOKEN`",
"debug": {
"requestHandlerMode": "http"
}
},
{
119
 "url": "https://doc.evolution-api.com/v1/api-
reference/integrations/chatwoot/find-chatwoot",
"crawl": {
"loadedUrl": "https://doc.evolution-api.com/v1/api-
reference/integrations/chatwoot/find-chatwoot",
"loadedTime": "2025-03-05T23:48:09.258Z",
"referrerUrl": "https://doc.evolution-api.com/v1/api-
reference/chat-controller/check-is-whatsapp",
"depth": null
},
"metadata": {
"canonicalUrl": "https://doc.evolution-api.com/v1/api-
reference/integrations/chatwoot/find-chatwoot",
"title": "Find Chatwoot - Evolution API Documentation",
"description": "Find Chatwoot",
"author": null,
"keywords": null,
"languageCode": "en",
"openGraph": [
{
"property": "og:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Find+Chatwoot&description=Find+Ch
atwoot&logoLight=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover.png&logoDark=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover-white.png&primaryColor=%2349BC94&lightColor=%2349BC94
&darkColor=%2349BC94"
},
{
"property": "og:image:width",
"content": "1200"
},
{
"property": "og:image:height",
"content": "630"
},
{
"property": "twitter:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Find+Chatwoot&description=Find+Ch
atwoot&logoLight=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover.png&logoDark=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover-white.png&primaryColor=%2349BC94&lightColor=%2349BC94
&darkColor=%2349BC94"
},
{
"property": "twitter:image:width",
"content": "1200"
},
{
"property": "twitter:image:height",
"content": "630"
}
120
 ],
"jsonLd": null,
"headers": {
"age": "272",
"cache-control": "public, max-age=0, must-revalidate",
"content-encoding": "br",
"content-type": "text/html; charset=utf-8",
"date": "Wed, 05 Mar 2025 23:43:36 GMT",
"etag": "W/\"v8agy9o69c57hv\"",
"server": "Vercel",
"strict-transport-security": "max-age=63072000",
"x-frame-options": "DENY",
"x-matched-path": "/_sites/[subdomain]/[[...slug]]",
"x-powered-by": "Next.js",
"x-vercel-cache": "HIT",
"x-vercel-id":
"iad1::iad1::w2rp6-1741218489115-56626302dc40",
"transfer-encoding": "chunked"
}
},
"screenshotUrl": null,
"text": "Find Chatwoot - Evolution API Documentation\nFind
Chatwoot\nAuthorizations\nYour authorization key header\nPath
Parameters\nID of the instance to connect",
"markdown": "# Find Chatwoot - Evolution API Documentation\n
\nFind Chatwoot\n\n#### Authorizations\n\nYour authorization
key header\n\n#### Path Parameters\n\nID of the instance to
connect",
"debug": {
"requestHandlerMode": "http"
}
},
{
"url": "https://doc.evolution-api.com/v1/api-
reference/integrations/rabbitmq/find-rabbitmq",
"crawl": {
"loadedUrl": "https://doc.evolution-api.com/v1/api-
reference/integrations/rabbitmq/find-rabbitmq",
"loadedTime": "2025-03-05T23:48:09.285Z",
"referrerUrl": "https://doc.evolution-api.com/v1/api-
reference/chat-controller/check-is-whatsapp",
"depth": null
},
"metadata": {
"canonicalUrl": "https://doc.evolution-api.com/v1/api-
reference/integrations/rabbitmq/find-rabbitmq",
"title": "Find RabbitMQ - Evolution API Documentation",
"description": "Find RabbitMQ",
"author": null,
"keywords": null,
"languageCode": "en",
"openGraph": [
{
"property": "og:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Find+RabbitMQ&description=Find+Ra
bbitMQ&logoLight=https%3A%2F%2Fmintlify.s3.us-
121
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover.png&logoDark=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover-white.png&primaryColor=%2349BC94&lightColor=%2349BC94
&darkColor=%2349BC94"
},
{
"property": "og:image:width",
"content": "1200"
},
{
"property": "og:image:height",
"content": "630"
},
{
"property": "twitter:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Find+RabbitMQ&description=Find+Ra
bbitMQ&logoLight=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover.png&logoDark=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover-white.png&primaryColor=%2349BC94&lightColor=%2349BC94
&darkColor=%2349BC94"
},
{
"property": "twitter:image:width",
"content": "1200"
},
{
"property": "twitter:image:height",
"content": "630"
}
],
"jsonLd": null,
"headers": {
"age": "272",
"cache-control": "public, max-age=0, must-revalidate",
"content-encoding": "br",
"content-type": "text/html; charset=utf-8",
"date": "Wed, 05 Mar 2025 23:43:36 GMT",
"etag": "W/\"bwge2tsvb257id\"",
"server": "Vercel",
"strict-transport-security": "max-age=63072000",
"x-frame-options": "DENY",
"x-matched-path": "/_sites/[subdomain]/[[...slug]]",
"x-powered-by": "Next.js",
"x-vercel-cache": "HIT",
"x-vercel-id":
"iad1::iad1::lkgqz-1741218489143-24b6b92a1793",
"transfer-encoding": "chunked"
}
},
"screenshotUrl": null,
"text": "Find RabbitMQ - Evolution API Documentation\nFind
RabbitMQ\nAuthorizations\nYour authorization key header\nPath
Parameters\nID of the instance to connect",
122
 "markdown": "# Find RabbitMQ - Evolution API Documentation\n
\nFind RabbitMQ\n\n#### Authorizations\n\nYour authorization
key header\n\n#### Path Parameters\n\nID of the instance to
connect",
"debug": {
"requestHandlerMode": "http"
}
},
{
"url": "https://doc.evolution-api.com/v1/api-
reference/integrations/sqs/find-sqs",
"crawl": {
"loadedUrl": "https://doc.evolution-api.com/v1/api-
reference/integrations/sqs/find-sqs",
"loadedTime": "2025-03-05T23:48:09.240Z",
"referrerUrl": "https://doc.evolution-api.com/v1/api-
reference/chat-controller/check-is-whatsapp",
"depth": null
},
"metadata": {
"canonicalUrl": "https://doc.evolution-api.com/v1/api-
reference/integrations/sqs/find-sqs",
"title": "Find SQS - Evolution API Documentation",
"description": "Find SQS",
"author": null,
"keywords": null,
"languageCode": "en",
"openGraph": [
{
"property": "og:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Find+SQS&description=Find+SQS&log
oLight=https%3A%2F%2Fmintlify.s3.us-west-1.amazonaws.com%
2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover.png&logoDark=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover-white.png&primaryColor=%2349BC94&lightColor=%2349BC94
&darkColor=%2349BC94"
},
{
"property": "og:image:width",
"content": "1200"
},
{
"property": "og:image:height",
"content": "630"
},
{
"property": "twitter:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Find+SQS&description=Find+SQS&log
oLight=https%3A%2F%2Fmintlify.s3.us-west-1.amazonaws.com%
2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover.png&logoDark=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover-white.png&primaryColor=%2349BC94&lightColor=%2349BC94
&darkColor=%2349BC94"
123
 },
{
"property": "twitter:image:width",
"content": "1200"
},
{
"property": "twitter:image:height",
"content": "630"
}
],
"jsonLd": null,
"headers": {
"age": "272",
"cache-control": "public, max-age=0, must-revalidate",
"content-encoding": "br",
"content-type": "text/html; charset=utf-8",
"date": "Wed, 05 Mar 2025 23:43:36 GMT",
"etag": "W/\"msltr1gqqi57c1\"",
"server": "Vercel",
"strict-transport-security": "max-age=63072000",
"x-frame-options": "DENY",
"x-matched-path": "/_sites/[subdomain]/[[...slug]]",
"x-powered-by": "Next.js",
"x-vercel-cache": "HIT",
"x-vercel-id": "iad1::iad1::cljqr-1741218489132-
c88bf6961c5c",
"transfer-encoding": "chunked"
}
},
"screenshotUrl": null,
"text": "Find SQS - Evolution API Documentation\nFind SQS
\ncurl --request GET \\ --url https://{server-
url}/sqs/find/{instance} \\ --header 'apikey: <api-
key>'\nAuthorizations\nYour authorization key header\nPath
Parameters\nID of the instance to connect\ncurl --request GET
\\ --url https://{server-url}/sqs/find/{instance} \\ --header
'apikey: <api-key>'",
"markdown": "# Find SQS - Evolution API Documentation\n
\nFind SQS\n\n```\ncurl --request GET \\\n --url
https://{server-url}/sqs/find/{instance} \\\n --header
'apikey: <api-key>'\n```\n\n#### Authorizations\n\nYour
authorization key header\n\n#### Path Parameters\n\nID of the
instance to connect\n\n```\ncurl --request GET \\\n --url
https://{server-url}/sqs/find/{instance} \\\n --header
'apikey: <api-key>'\n```",
"debug": {
"requestHandlerMode": "http"
}
},
{
"url": "https://doc.evolution-api.com/v1/api-
reference/integrations/rabbitmq/set-rabbitmq",
"crawl": {
"loadedUrl": "https://doc.evolution-api.com/v1/api-
reference/integrations/rabbitmq/set-rabbitmq",
"loadedTime": "2025-03-05T23:48:09.306Z",
"referrerUrl": "https://doc.evolution-api.com/v1/api-
124
reference/chat-controller/check-is-whatsapp",
"depth": null
},
"metadata": {
"canonicalUrl": "https://doc.evolution-api.com/v1/api-
reference/integrations/rabbitmq/set-rabbitmq",
"title": "Set RabbitMQ - Evolution API Documentation",
"description": "Set RabbitMQ",
"author": null,
"keywords": null,
"languageCode": "en",
"openGraph": [
{
"property": "og:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Set+RabbitMQ&description=Set+Rabb
itMQ&logoLight=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover.png&logoDark=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover-white.png&primaryColor=%2349BC94&lightColor=%2349BC94
&darkColor=%2349BC94"
},
{
"property": "og:image:width",
"content": "1200"
},
{
"property": "og:image:height",
"content": "630"
},
{
"property": "twitter:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Set+RabbitMQ&description=Set+Rabb
itMQ&logoLight=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover.png&logoDark=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover-white.png&primaryColor=%2349BC94&lightColor=%2349BC94
&darkColor=%2349BC94"
},
{
"property": "twitter:image:width",
"content": "1200"
},
{
"property": "twitter:image:height",
"content": "630"
}
],
"jsonLd": null,
"headers": {
"age": "272",
"cache-control": "public, max-age=0, must-revalidate",
"content-encoding": "br",
"content-type": "text/html; charset=utf-8",
125
 "date": "Wed, 05 Mar 2025 23:43:36 GMT",
"etag": "W/\"c5uvvc6b0m5cpi\"",
"server": "Vercel",
"strict-transport-security": "max-age=63072000",
"x-frame-options": "DENY",
"x-matched-path": "/_sites/[subdomain]/[[...slug]]",
"x-powered-by": "Next.js",
"x-vercel-cache": "HIT",
"x-vercel-id":
"iad1::iad1::5mjs4-1741218489159-47c4f4882c23",
"transfer-encoding": "chunked"
}
},
"screenshotUrl": null,
"text": "Set RabbitMQ - Evolution API Documentation\nSet
RabbitMQ\nAuthorizations\nYour authorization key header\nPath
Parameters\nID of the instance to connect\nBody\nEvents to be
sent to the Webhook\nAvailable options:\nAPPLICATION_STARTUP,
\nQRCODE_UPDATED,\nMESSAGES_SET,\nMESSAGES_UPSERT,
\nMESSAGES_UPDATE,\nMESSAGES_DELETE,\nSEND_MESSAGE,
\nCONTACTS_SET,\nCONTACTS_UPSERT,\nCONTACTS_UPDATE,
\nPRESENCE_UPDATE,\nCHATS_SET,\nCHATS_UPSERT,\nCHATS_UPDATE,
\nCHATS_DELETE,\nGROUPS_UPSERT,\nGROUP_UPDATE,
\nGROUP_PARTICIPANTS_UPDATE,\nCONNECTION_UPDATE,\nCALL,
\nNEW_JWT_TOKEN",
"markdown": "# Set RabbitMQ - Evolution API Documentation\n
\nSet RabbitMQ\n\n#### Authorizations\n\nYour authorization
key header\n\n#### Path Parameters\n\nID of the instance to
connect\n\n#### Body\n\nEvents to be sent to the Webhook\n
\nAvailable options:\n\n`APPLICATION_STARTUP`,\n
\n`QRCODE_UPDATED`,\n\n`MESSAGES_SET`,\n\n`MESSAGES_UPSERT`,\n
\n`MESSAGES_UPDATE`,\n\n`MESSAGES_DELETE`,\n\n`SEND_MESSAGE`,
\n\n`CONTACTS_SET`,\n\n`CONTACTS_UPSERT`,\n
\n`CONTACTS_UPDATE`,\n\n`PRESENCE_UPDATE`,\n\n`CHATS_SET`,\n
\n`CHATS_UPSERT`,\n\n`CHATS_UPDATE`,\n\n`CHATS_DELETE`,\n
\n`GROUPS_UPSERT`,\n\n`GROUP_UPDATE`,\n
\n`GROUP_PARTICIPANTS_UPDATE`,\n\n`CONNECTION_UPDATE`,\n
\n`CALL`,\n\n`NEW_JWT_TOKEN`",
"debug": {
"requestHandlerMode": "http"
}
},
{
"url": "https://doc.evolution-api.com/v1/api-
reference/integrations/chatwoot/set-chatwoot",
"crawl": {
"loadedUrl": "https://doc.evolution-api.com/v1/api-
reference/integrations/chatwoot/set-chatwoot",
"loadedTime": "2025-03-05T23:48:08.334Z",
"referrerUrl": "https://doc.evolution-api.com/v1/api-
reference/chat-controller/check-is-whatsapp",
"depth": null,
"httpStatusCode": 200
},
"metadata": {
"canonicalUrl": "https://doc.evolution-api.com/v1/api-
reference/integrations/chatwoot/set-chatwoot",
126
 "title": "Set Chatwoot - Evolution API Documentation",
"description": "Set Chatwoot",
"author": null,
"keywords": null,
"languageCode": "en",
"openGraph": [
{
"property": "og:image:width",
"content": "1200"
},
{
"property": "og:image:height",
"content": "630"
},
{
"property": "twitter:image:width",
"content": "1200"
},
{
"property": "twitter:image:height",
"content": "630"
},
{
"property": "og:image",
"content": "https://doc.evolution-api.com/api/og?
division=Documentation&title=Set+Chatwoot&description=Set+Chat
woot&logoLight=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover.png&logoDark=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover-white.png&primaryColor=%2349BC94&lightColor=%2349BC94
&darkColor=%2349BC94"
},
{
"property": "twitter:image",
"content": "https://doc.evolution-api.com/api/og?
division=Documentation&title=Set+Chatwoot&description=Set+Chat
woot&logoLight=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover.png&logoDark=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover-white.png&primaryColor=%2349BC94&lightColor=%2349BC94
&darkColor=%2349BC94"
}
],
"jsonLd": null,
"headers": {
"age": "270",
"cache-control": "public, max-age=0, must-revalidate",
"content-encoding": "br",
"content-type": "text/html; charset=utf-8",
"date": "Wed, 05 Mar 2025 23:43:36 GMT",
"etag": "W/\"y9lx1ak0pq5py2\"",
"server": "Vercel",
"strict-transport-security": "max-age=63072000",
"x-frame-options": "DENY",
"x-matched-path": "/_sites/[subdomain]/[[...slug]]",
127
 "x-powered-by": "Next.js",
"x-vercel-cache": "HIT",
"x-vercel-id": "iad1::iad1::r4vps-1741218487174-
aba5f7282931",
"x-firefox-spdy": "h2"
}
},
"screenshotUrl": null,
"text": "Set Chatwoot - Evolution API Documentation\ncurl --
request POST \\ --url https://{server-
url}/chatwoot/set/{instance} \\ --header 'Content-Type:
application/json' \\ --header 'apikey: <api-key>' \\ --data
'{ \"enabled\": true, \"account_id\": \"<string>\", \"token\":
\"<string>\", \"url\": \"<string>\", \"sign_msg\": true,
\"sign_delimiter\": \"<string>\", \"reopen_conversation\":
true, \"conversation_pending\": true, \"import_contacts\":
true, \"import_messages\": true, \"days_limit_import_messages
\": 123, \"auto_create\": true }'",
"markdown": "# Set Chatwoot - Evolution API Documentation\n
\n```\ncurl --request POST \\\n --url https://{server-
url}/chatwoot/set/{instance} \\\n --header 'Content-Type:
application/json' \\\n --header 'apikey: <api-key>' \\\n --
data '{\n \"enabled\": true,\n \"account_id\": \"<string>\",
\n \"token\": \"<string>\",\n \"url\": \"<string>\",\n
\"sign_msg\": true,\n \"sign_delimiter\": \"<string>\",\n
\"reopen_conversation\": true,\n \"conversation_pending\":
true,\n \"import_contacts\": true,\n \"import_messages\":
true,\n \"days_limit_import_messages\": 123,\n \"auto_create
\": true\n}'\n```",
"debug": {
"requestHandlerMode": "browser"
}
},
{
"url": "https://doc.evolution-api.com/v1/api-
reference/integrations/websocket/set-websocket",
"crawl": {
"loadedUrl": "https://doc.evolution-api.com/v1/api-
reference/integrations/websocket/set-websocket",
"loadedTime": "2025-03-05T23:48:12.493Z",
"referrerUrl": "https://doc.evolution-api.com/v1/api-
reference/chat-controller/check-is-whatsapp",
"depth": null
},
"metadata": {
"canonicalUrl": "https://doc.evolution-api.com/v1/api-
reference/integrations/websocket/set-websocket",
"title": "Find Chatwoot - Evolution API Documentation",
"description": "Find Chatwoot",
"author": null,
"keywords": null,
"languageCode": "en",
"openGraph": [
{
"property": "og:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Find+Chatwoot&description=Find+Ch
128
atwoot&logoLight=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover.png&logoDark=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover-white.png&primaryColor=%2349BC94&lightColor=%2349BC94
&darkColor=%2349BC94"
},
{
"property": "og:image:width",
"content": "1200"
},
{
"property": "og:image:height",
"content": "630"
},
{
"property": "twitter:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Find+Chatwoot&description=Find+Ch
atwoot&logoLight=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover.png&logoDark=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover-white.png&primaryColor=%2349BC94&lightColor=%2349BC94
&darkColor=%2349BC94"
},
{
"property": "twitter:image:width",
"content": "1200"
},
{
"property": "twitter:image:height",
"content": "630"
}
],
"jsonLd": null,
"headers": {
"age": "276",
"cache-control": "public, max-age=0, must-revalidate",
"content-encoding": "br",
"content-type": "text/html; charset=utf-8",
"date": "Wed, 05 Mar 2025 23:43:36 GMT",
"etag": "W/\"zsyhr93df057in\"",
"server": "Vercel",
"strict-transport-security": "max-age=63072000",
"x-frame-options": "DENY",
"x-matched-path": "/_sites/[subdomain]/[[...slug]]",
"x-powered-by": "Next.js",
"x-vercel-cache": "HIT",
"x-vercel-id":
"iad1::iad1::ll226-1741218492369-278ff60c120c",
"transfer-encoding": "chunked"
}
},
"screenshotUrl": null,
"text": "Find Chatwoot - Evolution API Documentation\nFind
Chatwoot\nAuthorizations\nYour authorization key header\nPath
129
Parameters\nID of the instance to connect",
"markdown": "# Find Chatwoot - Evolution API Documentation\n
\nFind Chatwoot\n\n#### Authorizations\n\nYour authorization
key header\n\n#### Path Parameters\n\nID of the instance to
connect",
"debug": {
"requestHandlerMode": "http"
}
},
{
"url": "https://doc.evolution-
api.com/v1/en/configuration/webhooks",
"crawl": {
"loadedUrl": "https://doc.evolution-
api.com/v1/en/configuration/webhooks",
"loadedTime": "2025-03-05T23:48:12.694Z"
},
"metadata": {
"canonicalUrl": "https://doc.evolution-
api.com/v1/en/configuration/webhooks",
"title": "Webhooks - Evolution API Documentation",
"description": null,
"author": null,
"keywords": null,
"languageCode": "en",
"openGraph": [
{
"property": "og:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Webhooks&logoLight=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover.png&logoDark=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover-white.png&primaryColor=%2349BC94
&lightColor=%2349BC94&darkColor=%2349BC94"
},
{
"property": "og:image:width",
"content": "1200"
},
{
"property": "og:image:height",
"content": "630"
},
{
"property": "twitter:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Webhooks&logoLight=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover.png&logoDark=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover-white.png&primaryColor=%2349BC94
&lightColor=%2349BC94&darkColor=%2349BC94"
},
{
"property": "twitter:image:width",
"content": "1200"
130
 },
{
"property": "twitter:image:height",
"content": "630"
}
],
"jsonLd": null,
"headers": {
"age": "587",
"cache-control": "public, max-age=0, must-revalidate",
"content-encoding": "br",
"content-type": "text/html; charset=utf-8",
"date": "Wed, 05 Mar 2025 23:38:24 GMT",
"etag": "W/\"10dxom5i2bq60xt\"",
"server": "Vercel",
"strict-transport-security": "max-age=63072000",
"x-frame-options": "DENY",
"x-matched-path": "/_sites/[subdomain]/[[...slug]]",
"x-powered-by": "Next.js",
"x-vercel-cache": "HIT",
"x-vercel-id": "iad1::iad1::kcr85-1741218492525-
ec51c5d80b09",
"transfer-encoding": "chunked"
}
},
"screenshotUrl": null,
"text": "Webhooks - Evolution API Documentation\nWebhooks
enable real-time integration between the Evolution API and
WhatsAppâ„¢, allowing automated data synchronization and
sharing.\nIt is exactly this feature that enables the creation
of self-service bots and multi-service systems.\nActivating
webhooks\nThere is two ways to activate the webhook:\nIn
the .env with global events\nBy calling the endpoint
/webhook/instance\nInstance webhook events\nMost of the users
will prefer the activation by instance, this way is easier to
control the events that are received, however in some cases a
global webhook is needed this could be done by using the
global webhook variable.\nHere is an example with some
commonly listened events:\nParameters
\nParameterTypeRequiredDescription\nenabled\tboolean\tRequired
\tEnter “true†to create or change Webhook data, or â
€œfalse†if you want to stop using it.\t\nurl\tstring
\tRequired\tWebhook URL to receive event data.\t
\nwebhook_by_events\tboolean\tOptional\tWant to generate a
specific Webhook URL for each of your events.\t\nevents\tarray
\tOptional\tList of events to be processed. If you don’t
want to use some of these events, just remove them from the
list.\t\nGlobal Webhook events\nEach instance’s Webhook URL
and events will be requested at the time it is created Define
a global webhook that will listen for enabled events from all
instances\nSupported events\nThese are the available and
supported webhook events:\nEnvironment variableURLDescription
\nAPPLICATION_STARTUP\t/application-startup\tNotifies you when
an application startup\t\nQRCODE_UPDATED\t/qrcode-updated
\tSends the base64 of the qrcode for reading\t
\nCONNECTION_UPDATE\t/connection-update\tInforms the status of
the connection with WhatsApp\t\nMESSAGES_SET\t/messages-set
131
\tSends a list of all your messages uploaded on WhatsApp. This
event occurs only once\t\nMESSAGES_UPSERT\t/messages-upsert
\tNotifies you when a message is received\t\nMESSAGES_UPDATE
\t/messages-update\tTells you when a message is updated\t
\nMESSAGES_DELETE\t/messages-delete\tTells you when a message
is deleted\t\nSEND_MESSAGE\t/send-message\tNotifies when a
message is sent\t\nCONTACTS_SET\t/contacts-set\tPerforms
initial loading of all contacts.This event occurs only once\t
\nCONTACTS_UPSERT\t/contacts-upsert\tReloads all contacts with
additional information.This event occurs only once\t
\nCONTACTS_UPDATE\t/contacts-update\tInforms you when the chat
is updated\t\nPRESENCE_UPDATE\t/presence-update\tInforms if
the user is online, if he is performing some action like
writing or recording and his last seen: ‘unavailable’, â
€˜available’, ‘composing’, ‘recording’, ‘paused’
\t\nCHATS_SET\t/chats-set\tSend a list of all loaded chats\t
\nCHATS_UPDATE\t/chats-update\tInforms you when the chat is
updated\t\nCHATS_UPSERT\t/chats-upsert\tSends any new chat
information\t\nCHATS_DELETE\t/chats-delete\tNotify you when a
message is deleted\t\nGROUPS_UPSERT\t/groups-upsert\tNotifies
when a group is created\t\nGROUPS_UPDATE\t/groups-update
\tNotifies when a group has its information updated\t
\nGROUP_PARTICIPANTS_UPDATE\t/group-participants-update
\tNotifies when an action occurs involving a participant: â
€˜add’, ‘remove’, ‘promote’, ‘demote’\t
\nNEW_TOKEN\t/new-jwt\tNotifies when the token (jwt) is
updated\t\nWebhook by events\nWhen enabling the
WEBHOOK_BY_EVENTS options in the global and local webhooks,
the following paths will be added at the end of the webhook.
\nExample\nAssuming your webhook url was
https://sub.domain.com/webhook/. Evolution will add
automatically in the end of the url the name of the event when
webhook_by_events is set to true.\nEventNew webhook by Events
URL\nAPPLICATION_STARTUP
\thttps://sub.domain.com/webhook/application-startup\t
\nQRCODE_UPDATED\thttps://sub.domain.com/webhook/qrcode-
updated\t\nCONNECTION_UPDATE
\thttps://sub.domain.com/webhook/connection-update\t
\nMESSAGES_SET\thttps://sub.domain.com/webhook/messages-set\t
\nMESSAGES_UPSERT\thttps://sub.domain.com/webhook/messages-
upsert\t\nMESSAGES_UPDATE
\thttps://sub.domain.com/webhook/messages-update\t
\nMESSAGES_DELETE\thttps://sub.domain.com/webhook/messages-
delete\t\nSEND_MESSAGE\thttps://sub.domain.com/webhook/send-
message\t\nCONTACTS_SET
\thttps://sub.domain.com/webhook/contacts-set\t
\nCONTACTS_UPSERT\thttps://sub.domain.com/webhook/contacts-
upsert\t\nCONTACTS_UPDATE
\thttps://sub.domain.com/webhook/contacts-update\t
\nPRESENCE_UPDATE\thttps://sub.domain.com/webhook/presence-
update\t\nCHATS_SET\thttps://sub.domain.com/webhook/chats-set
\t\nCHATS_UPDATE\thttps://sub.domain.com/webhook/chats-update
\t\nCHATS_UPSERT\thttps://sub.domain.com/webhook/chats-upsert
\t\nCHATS_DELETE\thttps://sub.domain.com/webhook/chats-delete
\t\nGROUPS_UPSERT\thttps://sub.domain.com/webhook/groups-
upsert\t\nGROUPS_UPDATE
\thttps://sub.domain.com/webhook/groups-update\t
132
\nGROUP_PARTICIPANTS_UPDATE
\thttps://sub.domain.com/webhook/group-participants-update\t
\nNEW_TOKEN\thttps://sub.domain.com/webhook/new-jwt\t\nFind
Webhook\nIf necessary, there is an option to find any active
webhook on the specific instance.\nMethodEndpoint\nGET
\t[baseUrl]/webhook/find/[instance]\t\nData returned from the
Request:\nCalling the endpoint will return all the information
about the webhook that is being used by the instance.",
"markdown": "# Webhooks - Evolution API Documentation\n
\nWebhooks enable real-time integration between the Evolution
API and WhatsAppâ„¢, allowing automated data synchronization
and sharing.\n\nIt is exactly this feature that enables the
creation of self-service bots and multi-service systems.\n\n##
Activating webhooks\n\nThere is two ways to activate the
webhook:\n\n* In the `.env` with global events\n* By
calling the endpoint `/webhook/instance`\n\n### Instance
webhook events\n\nMost of the users will prefer the activation
by instance, this way is easier to control the events that are
received, however in some cases a global webhook is needed
this could be done by using the global webhook variable.\n
\nHere is an example with some commonly listened events:\n
\n### Parameters\n\n| Parameter | Type | Required |
Description |\n| --- | --- | --- | --- |\n| enabled | boolean
| Required | Enter “true†to create or change Webhook
data, or “false†if you want to stop using it. |\n| url |
string | Required | Webhook URL to receive event data. |\n|
webhook\\_by\\_events | boolean | Optional | Want to generate
a specific Webhook URL for each of your events. |\n| events |
array | Optional | List of events to be processed. If you donâ
€™t want to use some of these events, just remove them from
the list. |\n\n### Global Webhook events\n\nEach instance’s
Webhook URL and events will be requested at the time it is
created Define a global webhook that will listen for enabled
events from all instances\n\n## Supported events\n\nThese are
the available and supported webhook events:\n\n| **Environment
variable** | **URL** | **Description** |\n| --- | --- | --- |
\n| APPLICATION\\_STARTUP | /application-startup | Notifies
you when an application startup |\n| QRCODE\\_UPDATED |
/qrcode-updated | Sends the base64 of the qrcode for reading |
\n| CONNECTION\\_UPDATE | /connection-update | Informs the
status of the connection with WhatsApp |\n| MESSAGES\\_SET |
/messages-set | Sends a list of all your messages uploaded on
WhatsApp. This event occurs only once |\n| MESSAGES\\_UPSERT |
/messages-upsert | Notifies you when a message is received |
\n| MESSAGES\\_UPDATE | /messages-update | Tells you when a
message is updated |\n| MESSAGES\\_DELETE | /messages-delete |
Tells you when a message is deleted |\n| SEND\\_MESSAGE |
/send-message | Notifies when a message is sent |\n| CONTACTS
\\_SET | /contacts-set | Performs initial loading of all
contacts.This event occurs only once |\n| CONTACTS\\_UPSERT |
/contacts-upsert | Reloads all contacts with additional
information.This event occurs only once |\n| CONTACTS\\_UPDATE
| /contacts-update | Informs you when the chat is updated |\n|
PRESENCE\\_UPDATE | /presence-update | Informs if the user is
online, if he is performing some action like writing or
recording and his last seen: ‘unavailable’, ‘availableâ
€™, ‘composing’, ‘recording’, ‘paused’ |\n| CHATS
133
\\_SET | /chats-set | Send a list of all loaded chats |\n|
CHATS\\_UPDATE | /chats-update | Informs you when the chat is
updated |\n| CHATS\\_UPSERT | /chats-upsert | Sends any new
chat information |\n| CHATS\\_DELETE | /chats-delete | Notify
you when a message is deleted |\n| GROUPS\\_UPSERT | /groups-
upsert | Notifies when a group is created |\n| GROUPS\\_UPDATE
| /groups-update | Notifies when a group has its information
updated |\n| GROUP\\_PARTICIPANTS\\_UPDATE | /group-
participants-update | Notifies when an action occurs involving
a participant: ‘add’, ‘remove’, ‘promote’, â
€˜demote’ |\n| NEW\\_TOKEN | /new-jwt | Notifies when the
token (jwt) is updated |\n\n## Webhook by events\n\nWhen
enabling the WEBHOOK\\_BY\\_EVENTS options in the global and
local webhooks, the following paths will be added at the end
of the webhook.\n\n### Example\n\nAssuming your webhook url
was `https://sub.domain.com/webhook/`. Evolution will add
automatically in the end of the url the name of the event when
`webhook_by_events` is set to true.\n\n| **Event** | **New
webhook by Events URL** |\n| --- | --- |\n| APPLICATION
\\_STARTUP | [https://sub.domain.com/webhook/application-
startup](https://sub.domain.com/webhook/application-startup) |
\n| QRCODE\\_UPDATED | [https://sub.domain.com/webhook/qrcode-
updated](https://sub.domain.com/webhook/qrcode-updated) |\n|
CONNECTION\\_UPDATE |
[https://sub.domain.com/webhook/connection-update]
(https://sub.domain.com/webhook/connection-update) |\n|
MESSAGES\\_SET | [https://sub.domain.com/webhook/messages-set]
(https://sub.domain.com/webhook/messages-set) |\n| MESSAGES
\\_UPSERT | [https://sub.domain.com/webhook/messages-upsert]
(https://sub.domain.com/webhook/messages-upsert) |\n| MESSAGES
\\_UPDATE | [https://sub.domain.com/webhook/messages-update]
(https://sub.domain.com/webhook/messages-update) |\n| MESSAGES
\\_DELETE | [https://sub.domain.com/webhook/messages-delete]
(https://sub.domain.com/webhook/messages-delete) |\n| SEND
\\_MESSAGE | [https://sub.domain.com/webhook/send-message]
(https://sub.domain.com/webhook/send-message) |\n| CONTACTS
\\_SET | [https://sub.domain.com/webhook/contacts-set]
(https://sub.domain.com/webhook/contacts-set) |\n| CONTACTS
\\_UPSERT | [https://sub.domain.com/webhook/contacts-upsert]
(https://sub.domain.com/webhook/contacts-upsert) |\n| CONTACTS
\\_UPDATE | [https://sub.domain.com/webhook/contacts-update]
(https://sub.domain.com/webhook/contacts-update) |\n| PRESENCE
\\_UPDATE | [https://sub.domain.com/webhook/presence-update]
(https://sub.domain.com/webhook/presence-update) |\n| CHATS
\\_SET | [https://sub.domain.com/webhook/chats-set]
(https://sub.domain.com/webhook/chats-set) |\n| CHATS\\_UPDATE
| [https://sub.domain.com/webhook/chats-update]
(https://sub.domain.com/webhook/chats-update) |\n| CHATS
\\_UPSERT | [https://sub.domain.com/webhook/chats-upsert]
(https://sub.domain.com/webhook/chats-upsert) |\n| CHATS
\\_DELETE | [https://sub.domain.com/webhook/chats-delete]
(https://sub.domain.com/webhook/chats-delete) |\n| GROUPS
\\_UPSERT | [https://sub.domain.com/webhook/groups-upsert]
(https://sub.domain.com/webhook/groups-upsert) |\n| GROUPS
\\_UPDATE | [https://sub.domain.com/webhook/groups-update]
(https://sub.domain.com/webhook/groups-update) |\n| GROUP
\\_PARTICIPANTS\\_UPDATE |
134
[https://sub.domain.com/webhook/group-participants-update]
(https://sub.domain.com/webhook/group-participants-update) |
\n| NEW\\_TOKEN | [https://sub.domain.com/webhook/new-jwt]
(https://sub.domain.com/webhook/new-jwt) |\n\n## Find Webhook
\n\nIf necessary, there is an option to find any active
webhook on the specific instance.\n\n| Method | Endpoint |
\n| --- | --- |\n| GET | \\[baseUrl\\]/webhook/find/
\\[instance\\] |\n\n### Data returned from the Request:\n
\nCalling the endpoint will return all the information about
the webhook that is being used by the instance.",
"debug": {
"requestHandlerMode": "http"
}
},
{
"url": "https://doc.evolution-
api.com/v1/en/configuration/available-resources",
"crawl": {
"loadedUrl": "https://doc.evolution-
api.com/v1/en/configuration/available-resources",
"loadedTime": "2025-03-05T23:48:12.671Z"
},
"metadata": {
"canonicalUrl": "https://doc.evolution-
api.com/v1/en/configuration/available-resources",
"title": "Available Resources - Evolution API
Documentation",
"description": null,
"author": null,
"keywords": null,
"languageCode": "en",
"openGraph": [
{
"property": "og:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Available+Resources&logoLight=htt
ps%3A%2F%2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-
eb1f2775%2Fimages%2Fbrand%2Fcover.png&logoDark=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover-white.png&primaryColor=%2349BC94
&lightColor=%2349BC94&darkColor=%2349BC94"
},
{
"property": "og:image:width",
"content": "1200"
},
{
"property": "og:image:height",
"content": "630"
},
{
"property": "twitter:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Available+Resources&logoLight=htt
ps%3A%2F%2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-
eb1f2775%2Fimages%2Fbrand%2Fcover.png&logoDark=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
135
2Fimages%2Fbrand%2Fcover-white.png&primaryColor=%2349BC94
&lightColor=%2349BC94&darkColor=%2349BC94"
},
{
"property": "twitter:image:width",
"content": "1200"
},
{
"property": "twitter:image:height",
"content": "630"
}
],
"jsonLd": null,
"headers": {
"age": "587",
"cache-control": "public, max-age=0, must-revalidate",
"content-encoding": "br",
"content-type": "text/html; charset=utf-8",
"date": "Wed, 05 Mar 2025 23:38:24 GMT",
"etag": "W/\"hx3rn1y1y54idb\"",
"server": "Vercel",
"strict-transport-security": "max-age=63072000",
"x-frame-options": "DENY",
"x-matched-path": "/_sites/[subdomain]/[[...slug]]",
"x-powered-by": "Next.js",
"x-vercel-cache": "HIT",
"x-vercel-id": "iad1::iad1::fhm94-1741218492513-
eeb871845377",
"transfer-encoding": "chunked"
}
},
"screenshotUrl": null,
"text": "Available Resources - Evolution API Documentation
\nMessaging and Group features\nMessages (Individual or
Group)\nFeatureAvailabilityDescription\nSend Text\t✅
\t(Plain, bold, italic, strikethrough, monospaced text and
emojis)\t\nSend Media\t✅\t(VÃdeo, image and document)\t
\nSend Narrated Audio\t✅\t(Working fine in Android and
iOS)\t\nSend Location\t✅\t(With name and description of the
place)\t\nSend Contact\t✅\t(With Name, Company, Phone, Email
and Url)\t\nSend Reaction\t✅\t(Send any emoji for
reaction)\t\nSend Link Preview\t✅\t(Searching for SEO
information) 🆕\t\nSend Reply\t✅\t(Mark messages in reply)
🆕\t\nSend Mention\t✅\t(Individual, some or all members)
🆕\t\nSend Poll Message\t✅\t(Send and receive votes from a
poll) 🆕\t\nSend Status/Storie\t✅\t(Text, linkpreview, vÃ-
deo, image and waveform) 🆕\t\nSend Sticker\t✅\t(Static
Image) 🆕\t\nSend List (Homolog)\t✅\t(Testing)\t\nSend
Buttons (Deprecated)\t⠌\t(Only works on Cloud API)\t
\nProfile\nFeatureAvailabilityDescription\nUpdate Name\t✅
\t(Change the connected profile name)\t\nUpdate Picture\t✅
\t(Change the connected profile picture) 🆕\t\nUpdate Status
\t✅\t(Change the connected profile status) 🆕\t\nAnd many
others…\t\t\t\nGroup\nFeatureAvailabilityDescription\nCreate
Group\t✅\t(New groups)\t\nUpdate Picture\t✅\t(Change group
picture)\t\nUpdate Subject\t✅\t(Change group name) 🆕\t
\nUpdate Description\t✅\t(Change group description) 🆕\t
136
\nFetch All Groups\t✅\t(Fetch all groups and participants)
🆕\t\nAnd many others…",
"markdown": "# Available Resources - Evolution API
Documentation\n\n## Messaging and Group features\n\n###
Messages (Individual or Group)\n\n| Feature | Availability |
Description |\n| --- | --- | --- |\n| Send Text | ✅ |
(Plain, bold, italic, strikethrough, monospaced text and
emojis) |\n| Send Media | ✅ | (VÃdeo, image and document)
|\n| Send Narrated Audio | ✅ | (Working fine in Android
and iOS) |\n| Send Location | ✅ | (With name and
description of the place) |\n| Send Contact | ✅ | (With
Name, Company, Phone, Email and Url) |\n| Send Reaction | ✅
| (Send any emoji for reaction) |\n| Send Link Preview | ✅
| (Searching for SEO information) 🆕 |\n| Send Reply | ✅
| (Mark messages in reply) 🆕 |\n| Send Mention | ✅ |
(Individual, some or all members) 🆕 |\n| Send Poll Message
| ✅ | (Send and receive votes from a poll) 🆕 |\n| Send
Status/Storie | ✅ | (Text, linkpreview, vÃdeo, image and
waveform) 🆕 |\n| Send Sticker | ✅ | (Static Image) 🆕
|\n| Send List (Homolog) | ✅ | (Testing) |\n| Send Buttons
(Deprecated) | ⠌ | (Only works on Cloud API) |\n\n###
Profile\n\n| Feature | Availability | Description |\n| ---
| --- | --- |\n| Update Name | ✅ | (Change the connected
profile name) |\n| Update Picture | ✅ | (Change the
connected profile picture) 🆕 |\n| Update Status | ✅ |
(Change the connected profile status) 🆕 |\n| And many
others… | | |\n\n### Group\n\n| Feature |
Availability | Description |\n| --- | --- | --- |\n| Create
Group | ✅ | (New groups) |\n| Update Picture | ✅ |
(Change group picture) |\n| Update Subject | ✅ | (Change
group name) 🆕 |\n| Update Description | ✅ | (Change
group description) 🆕 |\n| Fetch All Groups | ✅ | (Fetch
all groups and participants) 🆕 |\n| And many others… |
| |",
"debug": {
"requestHandlerMode": "http"
}
},
{
"url": "https://doc.evolution-api.com/v1/api-
reference/integrations/websocket/find-websocket",
"crawl": {
"loadedUrl": "https://doc.evolution-api.com/v1/api-
reference/integrations/websocket/find-websocket",
"loadedTime": "2025-03-05T23:48:12.977Z",
"referrerUrl": "https://doc.evolution-api.com/v1/api-
reference/chat-controller/check-is-whatsapp",
"depth": null
},
"metadata": {
"canonicalUrl": "https://doc.evolution-api.com/v1/api-
reference/integrations/websocket/find-websocket",
"title": "Set Chatwoot - Evolution API Documentation",
"description": "Set Chatwoot",
"author": null,
"keywords": null,
"languageCode": "en",
137
 "openGraph": [
{
"property": "og:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Set+Chatwoot&description=Set+Chat
woot&logoLight=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover.png&logoDark=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover-white.png&primaryColor=%2349BC94&lightColor=%2349BC94
&darkColor=%2349BC94"
},
{
"property": "og:image:width",
"content": "1200"
},
{
"property": "og:image:height",
"content": "630"
},
{
"property": "twitter:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Set+Chatwoot&description=Set+Chat
woot&logoLight=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover.png&logoDark=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover-white.png&primaryColor=%2349BC94&lightColor=%2349BC94
&darkColor=%2349BC94"
},
{
"property": "twitter:image:width",
"content": "1200"
},
{
"property": "twitter:image:height",
"content": "630"
}
],
"jsonLd": null,
"headers": {
"age": "276",
"cache-control": "public, max-age=0, must-revalidate",
"content-encoding": "br",
"content-type": "text/html; charset=utf-8",
"date": "Wed, 05 Mar 2025 23:43:36 GMT",
"etag": "W/\"ze62rykfef5plg\"",
"server": "Vercel",
"strict-transport-security": "max-age=63072000",
"x-frame-options": "DENY",
"x-matched-path": "/_sites/[subdomain]/[[...slug]]",
"x-powered-by": "Next.js",
"x-vercel-cache": "HIT",
"x-vercel-id":
"iad1::iad1::7cqdp-1741218492857-03c5d2dfd666",
"transfer-encoding": "chunked"
138
 }
},
"screenshotUrl": null,
"text": "Set Chatwoot - Evolution API Documentation\ncurl --
request POST \\ --url https://{server-
url}/chatwoot/set/{instance} \\ --header 'Content-Type:
application/json' \\ --header 'apikey: <api-key>' \\ --data
'{ \"enabled\": true, \"account_id\": \"<string>\", \"token\":
\"<string>\", \"url\": \"<string>\", \"sign_msg\": true,
\"sign_delimiter\": \"<string>\", \"reopen_conversation\":
true, \"conversation_pending\": true, \"import_contacts\":
true, \"import_messages\": true, \"days_limit_import_messages
\": 123, \"auto_create\": true }'",
"markdown": "# Set Chatwoot - Evolution API Documentation\n
\n```\ncurl --request POST \\\n --url https://{server-
url}/chatwoot/set/{instance} \\\n --header 'Content-Type:
application/json' \\\n --header 'apikey: <api-key>' \\\n --
data '{\n \"enabled\": true,\n \"account_id\": \"<string>\",
\n \"token\": \"<string>\",\n \"url\": \"<string>\",\n
\"sign_msg\": true,\n \"sign_delimiter\": \"<string>\",\n
\"reopen_conversation\": true,\n \"conversation_pending\":
true,\n \"import_contacts\": true,\n \"import_messages\":
true,\n \"days_limit_import_messages\": 123,\n \"auto_create
\": true\n}'\n```",
"debug": {
"requestHandlerMode": "http"
}
},
{
"url": "https://doc.evolution-api.com/v1/api-
reference/settings/get",
"crawl": {
"loadedUrl": "https://doc.evolution-api.com/v1/api-
reference/settings/get",
"loadedTime": "2025-03-05T23:48:14.947Z",
"referrerUrl": "https://doc.evolution-api.com/v1/api-
reference/chat-controller/check-is-whatsapp",
"depth": null
},
"metadata": {
"canonicalUrl": "https://doc.evolution-api.com/v1/api-
reference/settings/get",
"title": "Find Settings - Evolution API Documentation",
"description": "Fetch Webhook configuration",
"author": null,
"keywords": null,
"languageCode": "en",
"openGraph": [
{
"property": "og:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Find+Settings&description=Fetch+W
ebhook+configuration&logoLight=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover.png&logoDark=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover-white.png&primaryColor=%2349BC94&lightColor=%2349BC94
139
&darkColor=%2349BC94"
},
{
"property": "og:image:width",
"content": "1200"
},
{
"property": "og:image:height",
"content": "630"
},
{
"property": "twitter:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Find+Settings&description=Fetch+W
ebhook+configuration&logoLight=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover.png&logoDark=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover-white.png&primaryColor=%2349BC94&lightColor=%2349BC94
&darkColor=%2349BC94"
},
{
"property": "twitter:image:width",
"content": "1200"
},
{
"property": "twitter:image:height",
"content": "630"
}
],
"jsonLd": null,
"headers": {
"age": "327",
"cache-control": "public, max-age=0, must-revalidate",
"content-encoding": "br",
"content-type": "text/html; charset=utf-8",
"date": "Wed, 05 Mar 2025 23:42:47 GMT",
"etag": "W/\"qgwof8l7pg5lwr\"",
"server": "Vercel",
"strict-transport-security": "max-age=63072000",
"x-frame-options": "DENY",
"x-matched-path": "/_sites/[subdomain]/[[...slug]]",
"x-powered-by": "Next.js",
"x-vercel-cache": "HIT",
"x-vercel-id":
"iad1::iad1::pfvxg-1741218494848-6ff6917df225",
"transfer-encoding": "chunked"
}
},
"screenshotUrl": null,
"text": "Find Settings - Evolution API Documentation
\nAuthorizations\nYour authorization key header\nPath
Parameters\nID of the instance to connect\nIndicates whether
to reject incoming calls.\nIndicates whether to ignore group
messages.\nIndicates whether to always keep the instance
online.\nIndicates whether to mark messages as read.
\nIndicates whether to read status updates.\nIndicates whether
140
to synchronize full message history.",
"markdown": "# Find Settings - Evolution API Documentation\n
\n#### Authorizations\n\nYour authorization key header\n\n####
Path Parameters\n\nID of the instance to connect\n\nIndicates
whether to reject incoming calls.\n\nIndicates whether to
ignore group messages.\n\nIndicates whether to always keep the
instance online.\n\nIndicates whether to mark messages as
read.\n\nIndicates whether to read status updates.\n
\nIndicates whether to synchronize full message history.",
"debug": {
"requestHandlerMode": "http"
}
},
{
"url": "https://doc.evolution-api.com/v1/pt/env",
"crawl": {
"loadedUrl": "https://doc.evolution-api.com/v1/pt/env",
"loadedTime": "2025-03-05T23:48:15.088Z",
"referrerUrl": "https://doc.evolution-api.com/",
"depth": 1
},
"metadata": {
"canonicalUrl": "https://doc.evolution-api.com/v1/pt/env",
"title": "Variáveis de Ambiente - Evolution API
Documentation",
"description": null,
"author": null,
"keywords": null,
"languageCode": "en",
"openGraph": [
{
"property": "og:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Vari%C3%
A1veis+de+Ambiente&logoLight=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover.png&logoDark=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover-white.png&primaryColor=%2349BC94&lightColor=%2349BC94
&darkColor=%2349BC94"
},
{
"property": "og:image:width",
"content": "1200"
},
{
"property": "og:image:height",
"content": "630"
},
{
"property": "twitter:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Vari%C3%
A1veis+de+Ambiente&logoLight=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover.png&logoDark=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
141
2Fcover-white.png&primaryColor=%2349BC94&lightColor=%2349BC94
&darkColor=%2349BC94"
},
{
"property": "twitter:image:width",
"content": "1200"
},
{
"property": "twitter:image:height",
"content": "630"
}
],
"jsonLd": null,
"headers": {
"age": "603",
"cache-control": "public, max-age=0, must-revalidate",
"content-encoding": "br",
"content-type": "text/html; charset=utf-8",
"date": "Wed, 05 Mar 2025 23:38:11 GMT",
"etag": "W/\"mjp7cnj1kx6h0g\"",
"server": "Vercel",
"strict-transport-security": "max-age=63072000",
"x-frame-options": "DENY",
"x-matched-path": "/_sites/[subdomain]/[[...slug]]",
"x-powered-by": "Next.js",
"x-vercel-cache": "HIT",
"x-vercel-id":
"iad1::iad1::pfvxg-1741218494988-49ff50123214",
"transfer-encoding": "chunked"
}
},
"screenshotUrl": null,
"text": "Variáveis de Ambiente - Evolution API
Documentation\nVeja o arquivo de exemplo do env no
repositório oficial.\nPrincipais variáveis
\nVariávelValorExemplo\nSERVER_URL\tO endereço para seu
servidor em execução. Esse endereço é utilizado para
retornar dados de requisição interna, como links de webhook.
\thttps://exemplo.evolution-api.com\t\nWEBSOCKET_ENABLED
\tHabilitar ou não o WebSocket\ttrue\t
\nWEBSOCKET_GLOBAL_EVENTS\tHabilita os WebSocket de forma
global\ttrue\t\nCONFIG_SESSION_PHONE_CLIENT\tNome que
será exibido na conexão do smartphone\tEvolutionAPI\t
\nCONFIG_SESSION_PHONE_NAME\tNome do navegador que
será exibido na conexão do smartphone\tChrome\t\nLogs
\nVariávelValorExemplo\nLOG_LEVEL\tLogs que serão mostrados
entre: ERROR,WARN,DEBUG,INFO,LOG,VERBOSE,DARK,WEBHOOKS
\tERROR,WARN,DEBUG,INFO,LOG,VERBOSE,DARK,WEBHOOKS\t\nLOG_COLOR
\tMostrar ou não cores nos Logs (true ou false)\ttrue\t
\nLOG_BAILEYS\tQuais logs da Baileys serão mostrados entre: â
€œfatal†, “error†, “warn†, “info†, “debug†e
“trace†\terror\t\nStorage Temporáreo\nArmazenamento
temporáreo de dados. Valores são true ou false para armazena
ou não.\nVariávelValor\nSTORE_MESSAGES\tGuarda mensagens\t
\nSTORE_MESSAGE_UP\tGuarda atualização das mensagens\t
\nSTORE_CONTACTS\tGuarda contatos\t\nSTORE_CHATS\tGuarda
conversas\t\nLimpeza do Storage Temporáreo\nLimpeza do
142
armazenamento temporáreo.\nVariávelValor
\nCLEAN_STORE_CLEANING_INTERVAL\tIntervalo de limpeza em
segundos\t\nCLEAN_STORE_MESSAGES\tSe excluirá as mensagens
(true ou false)\t\nCLEAN_STORE_MESSAGE_UP\tSe excluirá as
atualizações de mensagens (true ou false)\t
\nCLEAN_STORE_CONTACTS\tSe excluirá os contatos (true ou
false)\t\nCLEAN_STORE_CHATS\tSe excluirá as conversas (true
ou false)\t\nStorage Persistente\nConfigurações de conexão:
\nVariávelValorExemplo\nDATABASE_ENABLED\tSe o armazenamento
persistente está habilitado\ttrue\t\nDATABASE_CONNECTION_URI
\tA URI de conexão do MongoDB\ttrue\t
\nDATABASE_CONNECTION_DB_PREFIX_NAME\tQuais logs da Baileys
serão mostrados entre: “fatal†, “error†, “warn†,
“info†, “debug†e “trace†\terror\t\nQuais dados
serão salvos (true ou false)\nVariávelValor
\nDATABASE_SAVE_DATA_INSTANCE\tSalva dados de instâncias\t
\nDATABASE_SAVE_DATA_NEW_MESSAGE\tSalva novas mensagens\t
\nDATABASE_SAVE_MESSAGE_UPDATE\tSalva atualizações de
mensagens\t\nDATABASE_SAVE_DATA_CONTACTS\tSalva contatos\t
\nDATABASE_SAVE_DATA_CHATS\tSalva conversas\t\nRedis
\nVariávelValorExemplo\nCACHE_REDIS_ENABLED\tSe o Redis
está habilitado (true ou false)\ttrue\t\nCACHE_REDIS_URI\tA
URI de conexão do Redis\tredis://redis:6379\t
\nCACHE_REDIS_PREFIX_KEY\tPrefixo do nome de chave\tevolution
\t\nCACHE_REDIS_TTL\tTempo para manter os dados no Redis
\t604800\t\nCACHE_REDIS_SAVE_INSTANCES\tSalva as credencias de
conexão do whatsapp no Redis\tfalse\t\nCACHE_LOCAL_ENABLED
\tFaz cache em memória, alternativa ao Redis\tfalse\t
\nCACHE_LOCAL_TTL\tTempo para manter os dados localmente
\t604800\t\nRabbitMQ\nVariávelValorExemplo\nRABBITMQ_ENABLED
\tHabilita o RabbitMQ (true ou false)\ttrue\t
\nRABBITMQ_GLOBAL_ENABLED\tHabilita o RabbitMQ de forma global
(true ou false)\tfalse\t\nRABBITMQ_URI\tURI de conexão do
RabbitMQ\tamqp://guest:guest@rabbitmq:5672\t
\nRABBITMQ_EXCHANGE_NAME\tNome do exchange\tevolution_exchange
\t\nRABBITMQ_EVENTS_APPLICATION_STARTUP\tEnvia um evento na
inicialização do app\tfalse\t
\nRABBITMQ_EVENTS_QRCODE_UPDATED\tEnvia eventos de AtualizaçÃ
£o do QR Code\ttrue\t\nRABBITMQ_EVENTS_MESSAGES_SET\tEnvia
eventos de Criação de Mensagens (recuperação de
mensagens)\ttrue\t\nRABBITMQ_EVENTS_MESSAGES_UPSERT\tEnvia
eventos de Recebimento de Mensagens\ttrue\t
\nRABBITMQ_EVENTS_MESSAGES_UPDATE\tEnvia eventos de
Atualização de Mensagens\ttrue\t
\nRABBITMQ_EVENTS_MESSAGES_DELETE\tEnvia eventos de Deleção
de Mensagens\ttrue\t\nRABBITMQ_EVENTS_SEND_MESSAGE\tEnvia
eventos de Envio de Mensagens\ttrue\t
\nRABBITMQ_EVENTS_CONTACTS_SET\tEnvia eventos de Criação de
Contatos\ttrue\t\nRABBITMQ_EVENTS_CONTACTS_UPSERT\tEnvia
eventos de Criação de Contatos (recuperação de
contatos)\ttrue\t\nRABBITMQ_EVENTS_CONTACTS_UPDATE\tEnvia
eventos de Atualização de Contatos\ttrue\t
\nRABBITMQ_EVENTS_PRESENCE_UPDATE\tEnvia eventos de
Atualização de presença (“digitando…†ou “gravandoâ
€¦â€œ)\ttrue\t\nRABBITMQ_EVENTS_CHATS_SET\tEnvia eventos de
Criação de Conversas (recuperação de conversas)\ttrue\t
\nRABBITMQ_EVENTS_CHATS_UPSERT\tEnvia eventos de Criação de
143
Conversas (recebimento ou envio de mensagens em novos
chats)\ttrue\t\nRABBITMQ_EVENTS_CHATS_UPDATE\tEnvia eventos de
Atualização de Conversas\ttrue\t
\nRABBITMQ_EVENTS_CHATS_DELETE\tEnvia eventos de Deleção de
Conversas\ttrue\t\nRABBITMQ_EVENTS_GROUPS_UPSERT\tEnvia
eventos de Criação de Grupos\ttrue\t
\nRABBITMQ_EVENTS_GROUPS_UPDATE\tEnvia eventos de AtualizaçÃ
£o de Grupos\ttrue\t
\nRABBITMQ_EVENTS_GROUP_PARTICIPANTS_UPDATE\tEnvia eventos de
Atualização nos Participantes de Grupos\ttrue\t
\nRABBITMQ_EVENTS_CONNECTION_UPDATE\tEnvia eventos de
Atualização de Conexão\ttrue\t\nRABBITMQ_EVENTS_LABELS_EDIT
\tEnvia eventos de Edição de Etiquetas\ttrue\t
\nRABBITMQ_EVENTS_LABELS_ASSOCIATION\tEnvia eventos de
Associação de Etiquetas\ttrue\t\nRABBITMQ_EVENTS_CALL\tEnvia
eventos de Chamadas\ttrue\t\nRABBITMQ_EVENTS_TYPEBOT_START
\tEnvia eventos de InÃcio de fluxo do Typebot\tfalse\t
\nRABBITMQ_EVENTS_TYPEBOT_CHANGE_STATUS\tEnvia eventos de
Atualização no status do Typebot\tfalse\t\nSQS
\nVariávelValor\nSQS_ENABLED\tSe o SQS está habilitado (true
ou false)\t\nSQS_ACCESS_KEY_ID\tO ID de chave do SQS\t
\nSQS_SECRET_ACCESS_KEY\tChave de acesso\t\nSQS_ACCOUNT_ID\tID
da conta\t\nSQS_REGION\tRegião do SQS\t\nInstâncias
\nVariávelValorExemplo\nDEL_INSTANCE\tEm quantos minutos uma
instânica será excluÃda se não conectada. Use “falseâ€
para nunca excluir.\t5\t\nDEL_TEMP_INSTANCES\tDeleta instâ
ncias fechadas na inicialização\ttrue\t\nCORS
\nVariávelValorExemplo\nCORS_ORIGIN\tAs origens permitidas
pela API separadas por vÃrgula (utilize †*†para
aceiteitar requisições de qualquer origem).\thttps://meu-
frontend.com,https://meu-outro-frontend.com\t\nCORS_METHODS
\tMétodos HTTP permitidos separados por vÃrgula.
\tPOST,GET,PUT,DELETE\t\nCORS_CREDENTIALS\tPermisão de
cookies em requisições (true ou false).\ttrue\t\nWebhook
\nVariávelValor\nWEBHOOK_GLOBAL_URL\tUrl que receberá as
requisições de webhook\t\nWEBHOOK_GLOBAL_ENABLED\tSe os
webhooks estão habilitados (true ou false)\t
\nWEBHOOK_GLOBAL_WEBHOOK_BY_EVENTS\t\t\nEventos de webhook com
valor true ou false:\nVariável
\nWEBHOOK_EVENTS_APPLICATION_STARTUP\t
\nWEBHOOK_EVENTS_QRCODE_UPDATED\t\nWEBHOOK_EVENTS_MESSAGES_SET
\t\nWEBHOOK_EVENTS_MESSAGES_UPSERT\t
\nWEBHOOK_EVENTS_MESSAGES_UPDATE\t
\nWEBHOOK_EVENTS_MESSAGES_DELETE\t
\nWEBHOOK_EVENTS_SEND_MESSAGE\t\nWEBHOOK_EVENTS_CONTACTS_SET\t
\nWEBHOOK_EVENTS_CONTACTS_UPSERT\t
\nWEBHOOK_EVENTS_CONTACTS_UPDATE\t
\nWEBHOOK_EVENTS_PRESENCE_UPDATE\t\nWEBHOOK_EVENTS_CHATS_SET\t
\nWEBHOOK_EVENTS_CHATS_UPSERT\t\nWEBHOOK_EVENTS_CHATS_UPDATE\t
\nWEBHOOK_EVENTS_CHATS_DELETE\t\nWEBHOOK_EVENTS_GROUPS_UPSERT
\t\nWEBHOOK_EVENTS_GROUPS_UPDATE\t
\nWEBHOOK_EVENTS_GROUP_PARTICIPANTS_UPDATE\t
\nWEBHOOK_EVENTS_CONNECTION_UPDATE\t
\nWEBHOOK_EVENTS_LABELS_EDIT\t
\nWEBHOOK_EVENTS_LABELS_ASSOCIATION\t\nWEBHOOK_EVENTS_CALL\t
\nWEBHOOK_EVENTS_NEW_JWT_TOKEN\t\nWEBHOOK_EVENTS_TYPEBOT_START
\t\nWEBHOOK_EVENTS_TYPEBOT_CHANGE_STATUS\t
144
\nWEBHOOK_EVENTS_CHAMA_AI_ACTION\t\nWEBHOOK_EVENTS_ERRORS\t
\nWEBHOOK_EVENTS_ERRORS_WEBHOOK\t\nQR Code\nVariávelValor
\nQRCODE_LIMIT\tPor quanto tempo o QR code durará\t
\nQRCODE_COLOR\tCor do QR code gerado\t\nTypebot
\nVariávelValor\nTYPEBOT_API_VERSION\tVersão da API (versão
fixa ou latest)\t\nTYPEBOT_KEEP_OPEN\tMantém o Typebot aberto
(true ou false)\t\nAutenticação\nVariávelValor
\nAUTHENTICATION_TYPE\tTipo de autenticação (jwt ou
apikey)\t\nAUTHENTICATION_API_KEY\tChave da API que
será usada para autenticação\t
\nAUTHENTICATION_EXPOSE_IN_FETCH_INSTANCES\t\t
\nAUTHENTICATION_JWT_EXPIRIN_IN\tTempo de expiração do token
JWT\t\nAUTHENTICATION_JWT_SECRET\tSegredo usado para gerar o
JWT",
"markdown": "# Variáveis de Ambiente - Evolution API
Documentation\n\nVeja o arquivo de exemplo do env no
[repositório oficial]
(https://github.com/EvolutionAPI/evolution-
api/blob/main/Docker/.env.example).\n\n## Principais
variáveis\n\n| Variável | Valor | Exemplo |\n| --- | ---
| --- |\n| `SERVER_URL` | O endereço para seu servidor em
execução. Esse endereço é utilizado para retornar dados de
requisição interna, como links de webhook. |
[https://exemplo.evolution-api.com](https://exemplo.evolution-
api.com/) |\n| `WEBSOCKET_ENABLED` | Habilitar ou não o
WebSocket | true |\n| `WEBSOCKET_GLOBAL_EVENTS` | Habilita os
WebSocket de forma global | true |\n|
`CONFIG_SESSION_PHONE_CLIENT` | Nome que será exibido na
conexão do smartphone | EvolutionAPI |\n|
`CONFIG_SESSION_PHONE_NAME` | Nome do navegador que
será exibido na conexão do smartphone | Chrome |\n\n## Logs
\n\n| Variável | Valor | Exemplo |\n| --- | --- | --- |\n|
`LOG_LEVEL` | Logs que serão mostrados entre:
ERROR,WARN,DEBUG,INFO,LOG,VERBOSE,DARK,WEBHOOKS |
ERROR,WARN,DEBUG,INFO,LOG,VERBOSE,DARK,WEBHOOKS |\n|
`LOG_COLOR` | Mostrar ou não cores nos Logs (true ou false) |
true |\n| `LOG_BAILEYS` | Quais logs da Baileys serão
mostrados entre: “fatal†, “error†, “warn†, â
€œinfo†, “debug†e “trace†| error |\n\n## Storage
Temporáreo\n\nArmazenamento temporáreo de dados. Valores sÃ
£o `true` ou `false` para armazena ou não.\n\n| Variável |
Valor |\n| --- | --- |\n| `STORE_MESSAGES` | Guarda mensagens
|\n| `STORE_MESSAGE_UP` | Guarda atualização das mensagens |
\n| `STORE_CONTACTS` | Guarda contatos |\n| `STORE_CHATS` |
Guarda conversas |\n\n## Limpeza do Storage Temporáreo\n
\nLimpeza do armazenamento temporáreo.\n\n| Variável | Valor
|\n| --- | --- |\n| `CLEAN_STORE_CLEANING_INTERVAL` |
Intervalo de limpeza em segundos |\n| `CLEAN_STORE_MESSAGES` |
Se excluirá as mensagens (true ou false) |\n|
`CLEAN_STORE_MESSAGE_UP` | Se excluirá as atualizações de
mensagens (true ou false) |\n| `CLEAN_STORE_CONTACTS` | Se
excluirá os contatos (true ou false) |\n| `CLEAN_STORE_CHATS`
| Se excluirá as conversas (true ou false) |\n\n## Storage
Persistente\n\nConfigurações de conexão:\n\n| Variável |
Valor | Exemplo |\n| --- | --- | --- |\n| `DATABASE_ENABLED` |
Se o armazenamento persistente está habilitado | true |\n|
`DATABASE_CONNECTION_URI` | A URI de conexão do MongoDB |
145
true |\n| `DATABASE_CONNECTION_DB_PREFIX_NAME` | Quais logs da
Baileys serão mostrados entre: “fatal†, “error†, â
€œwarn†, “info†, “debug†e “trace†| error |\n
\nQuais dados serão salvos (true ou false)\n\n| Variável |
Valor |\n| --- | --- |\n| `DATABASE_SAVE_DATA_INSTANCE` |
Salva dados de instâncias |\n|
`DATABASE_SAVE_DATA_NEW_MESSAGE` | Salva novas mensagens |\n|
`DATABASE_SAVE_MESSAGE_UPDATE` | Salva atualizações de
mensagens |\n| `DATABASE_SAVE_DATA_CONTACTS` | Salva contatos
|\n| `DATABASE_SAVE_DATA_CHATS` | Salva conversas |\n\n##
Redis\n\n| Variável | Valor | Exemplo |\n| --- | --- | --- |
\n| `CACHE_REDIS_ENABLED` | Se o Redis está habilitado (true
ou false) | true |\n| `CACHE_REDIS_URI` | A URI de conexão do
Redis | redis://redis:6379 |\n| `CACHE_REDIS_PREFIX_KEY` |
Prefixo do nome de chave | evolution |\n| `CACHE_REDIS_TTL` |
Tempo para manter os dados no Redis | 604800 |\n|
`CACHE_REDIS_SAVE_INSTANCES` | Salva as credencias de conexão
do whatsapp no Redis | false |\n| `CACHE_LOCAL_ENABLED` | Faz
cache em memória, alternativa ao Redis | false |\n|
`CACHE_LOCAL_TTL` | Tempo para manter os dados localmente |
604800 |\n\n## RabbitMQ\n\n| Variável | Valor | Exemplo |
\n| --- | --- | --- |\n| `RABBITMQ_ENABLED` | Habilita o
RabbitMQ (true ou false) | true |\n| `RABBITMQ_GLOBAL_ENABLED`
| Habilita o RabbitMQ de forma global (true ou false) | false
|\n| `RABBITMQ_URI` | URI de conexão do RabbitMQ |
amqp://guest:guest@rabbitmq:5672 |\n| `RABBITMQ_EXCHANGE_NAME`
| Nome do exchange | evolution\\_exchange |\n|
`RABBITMQ_EVENTS_APPLICATION_STARTUP` | Envia um evento na
inicialização do app | false |\n|
`RABBITMQ_EVENTS_QRCODE_UPDATED` | Envia eventos de
Atualização do QR Code | true |\n|
`RABBITMQ_EVENTS_MESSAGES_SET` | Envia eventos de Criação de
Mensagens (recuperação de mensagens) | true |\n|
`RABBITMQ_EVENTS_MESSAGES_UPSERT` | Envia eventos de
Recebimento de Mensagens | true |\n|
`RABBITMQ_EVENTS_MESSAGES_UPDATE` | Envia eventos de
Atualização de Mensagens | true |\n|
`RABBITMQ_EVENTS_MESSAGES_DELETE` | Envia eventos de Deleção
de Mensagens | true |\n| `RABBITMQ_EVENTS_SEND_MESSAGE` |
Envia eventos de Envio de Mensagens | true |\n|
`RABBITMQ_EVENTS_CONTACTS_SET` | Envia eventos de Criação de
Contatos | true |\n| `RABBITMQ_EVENTS_CONTACTS_UPSERT` | Envia
eventos de Criação de Contatos (recuperação de contatos) |
true |\n| `RABBITMQ_EVENTS_CONTACTS_UPDATE` | Envia eventos de
Atualização de Contatos | true |\n|
`RABBITMQ_EVENTS_PRESENCE_UPDATE` | Envia eventos de
Atualização de presença (“digitando…†ou “gravandoâ
€¦â€œ) | true |\n| `RABBITMQ_EVENTS_CHATS_SET` | Envia eventos
de Criação de Conversas (recuperação de conversas) | true
|\n| `RABBITMQ_EVENTS_CHATS_UPSERT` | Envia eventos de CriaçÃ
£o de Conversas (recebimento ou envio de mensagens em novos
chats) | true |\n| `RABBITMQ_EVENTS_CHATS_UPDATE` | Envia
eventos de Atualização de Conversas | true |\n|
`RABBITMQ_EVENTS_CHATS_DELETE` | Envia eventos de Deleção de
Conversas | true |\n| `RABBITMQ_EVENTS_GROUPS_UPSERT` | Envia
eventos de Criação de Grupos | true |\n|
`RABBITMQ_EVENTS_GROUPS_UPDATE` | Envia eventos de AtualizaçÃ
146
£o de Grupos | true |\n|
`RABBITMQ_EVENTS_GROUP_PARTICIPANTS_UPDATE` | Envia eventos de
Atualização nos Participantes de Grupos | true |\n|
`RABBITMQ_EVENTS_CONNECTION_UPDATE` | Envia eventos de
Atualização de Conexão | true |\n|
`RABBITMQ_EVENTS_LABELS_EDIT` | Envia eventos de Edição de
Etiquetas | true |\n| `RABBITMQ_EVENTS_LABELS_ASSOCIATION` |
Envia eventos de Associação de Etiquetas | true |\n|
`RABBITMQ_EVENTS_CALL` | Envia eventos de Chamadas | true |\n|
`RABBITMQ_EVENTS_TYPEBOT_START` | Envia eventos de InÃcio de
fluxo do Typebot | false |\n|
`RABBITMQ_EVENTS_TYPEBOT_CHANGE_STATUS` | Envia eventos de
Atualização no status do Typebot | false |\n\n## SQS\n\n|
Variável | Valor |\n| --- | --- |\n| `SQS_ENABLED` | Se o SQS
está habilitado (true ou false) |\n| `SQS_ACCESS_KEY_ID` | O
ID de chave do SQS |\n| `SQS_SECRET_ACCESS_KEY` | Chave de
acesso |\n| `SQS_ACCOUNT_ID` | ID da conta |\n| `SQS_REGION` |
Região do SQS |\n\n## Instâncias\n\n| Variável | Valor |
Exemplo |\n| --- | --- | --- |\n| `DEL_INSTANCE` | Em quantos
minutos uma instânica será excluÃda se não conectada. Use â
€œfalse†para nunca excluir. | 5 |\n| `DEL_TEMP_INSTANCES`
| Deleta instâncias fechadas na inicialização | true |\n
\n## CORS\n\n| Variável | Valor | Exemplo |\n| --- | ---
| --- |\n| `CORS_ORIGIN` | As origens permitidas pela API
separadas por vÃrgula (utilize †\\*†para aceiteitar
requisições de qualquer origem). | [https://meu-
frontend.com,https://meu-outro-frontend.com](https://meu-
frontend.com,https//meu-outro-frontend.com) |\n|
`CORS_METHODS` | Métodos HTTP permitidos separados por vÃ-
rgula. | POST,GET,PUT,DELETE |\n| `CORS_CREDENTIALS` | PermisÃ
£o de cookies em requisições (true ou false). | true |\n\n##
Webhook\n\n| Variável | Valor |\n| --- | --- |\n|
`WEBHOOK_GLOBAL_URL` | Url que receberá as requisições de
webhook |\n| `WEBHOOK_GLOBAL_ENABLED` | Se os webhooks estão
habilitados (true ou false) |\n|
`WEBHOOK_GLOBAL_WEBHOOK_BY_EVENTS` | |\n\nEventos de
webhook com valor true ou false:\n\n| Variável |\n| --- |\n|
`WEBHOOK_EVENTS_APPLICATION_STARTUP` |\n|
`WEBHOOK_EVENTS_QRCODE_UPDATED` |\n|
`WEBHOOK_EVENTS_MESSAGES_SET` |\n|
`WEBHOOK_EVENTS_MESSAGES_UPSERT` |\n|
`WEBHOOK_EVENTS_MESSAGES_UPDATE` |\n|
`WEBHOOK_EVENTS_MESSAGES_DELETE` |\n|
`WEBHOOK_EVENTS_SEND_MESSAGE` |\n|
`WEBHOOK_EVENTS_CONTACTS_SET` |\n|
`WEBHOOK_EVENTS_CONTACTS_UPSERT` |\n|
`WEBHOOK_EVENTS_CONTACTS_UPDATE` |\n|
`WEBHOOK_EVENTS_PRESENCE_UPDATE` |\n|
`WEBHOOK_EVENTS_CHATS_SET` |\n| `WEBHOOK_EVENTS_CHATS_UPSERT`
|\n| `WEBHOOK_EVENTS_CHATS_UPDATE` |\n|
`WEBHOOK_EVENTS_CHATS_DELETE` |\n|
`WEBHOOK_EVENTS_GROUPS_UPSERT` |\n|
`WEBHOOK_EVENTS_GROUPS_UPDATE` |\n|
`WEBHOOK_EVENTS_GROUP_PARTICIPANTS_UPDATE` |\n|
`WEBHOOK_EVENTS_CONNECTION_UPDATE` |\n|
`WEBHOOK_EVENTS_LABELS_EDIT` |\n|
`WEBHOOK_EVENTS_LABELS_ASSOCIATION` |\n| `WEBHOOK_EVENTS_CALL`
147
|\n| `WEBHOOK_EVENTS_NEW_JWT_TOKEN` |\n|
`WEBHOOK_EVENTS_TYPEBOT_START` |\n|
`WEBHOOK_EVENTS_TYPEBOT_CHANGE_STATUS` |\n|
`WEBHOOK_EVENTS_CHAMA_AI_ACTION` |\n| `WEBHOOK_EVENTS_ERRORS`
|\n| `WEBHOOK_EVENTS_ERRORS_WEBHOOK` |\n\n## QR Code\n\n|
Variável | Valor |\n| --- | --- |\n| `QRCODE_LIMIT` | Por
quanto tempo o QR code durará |\n| `QRCODE_COLOR` | Cor do QR
code gerado |\n\n## Typebot\n\n| Variável | Valor |\n| ---
| --- |\n| `TYPEBOT_API_VERSION` | Versão da API (versão
fixa ou latest) |\n| `TYPEBOT_KEEP_OPEN` | Mantém o Typebot
aberto (true ou false) |\n\n## Autenticação\n\n| Variável |
Valor |\n| --- | --- |\n| `AUTHENTICATION_TYPE` | Tipo de
autenticação (`jwt` ou `apikey`) |\n|
`AUTHENTICATION_API_KEY` | Chave da API que será usada para
autenticação |\n| `AUTHENTICATION_EXPOSE_IN_FETCH_INSTANCES`
| |\n| `AUTHENTICATION_JWT_EXPIRIN_IN` | Tempo de
expiração do token JWT |\n| `AUTHENTICATION_JWT_SECRET` |
Segredo usado para gerar o JWT |",
"debug": {
"requestHandlerMode": "http"
}
},
{
"url": "https://doc.evolution-api.com/v1/en/optional-
resources/mongo-db",
"crawl": {
"loadedUrl": "https://doc.evolution-
api.com/v1/en/optional-resources/mongo-db",
"loadedTime": "2025-03-05T23:48:15.542Z"
},
"metadata": {
"canonicalUrl": "https://doc.evolution-
api.com/v1/en/optional-resources/mongo-db",
"title": "MongoDB - Evolution API Documentation",
"description": null,
"author": null,
"keywords": null,
"languageCode": "en",
"openGraph": [
{
"property": "og:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=MongoDB&logoLight=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover.png&logoDark=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover-white.png&primaryColor=%2349BC94
&lightColor=%2349BC94&darkColor=%2349BC94"
},
{
"property": "og:image:width",
"content": "1200"
},
{
"property": "og:image:height",
"content": "630"
},
148
 {
"property": "twitter:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=MongoDB&logoLight=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover.png&logoDark=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover-white.png&primaryColor=%2349BC94
&lightColor=%2349BC94&darkColor=%2349BC94"
},
{
"property": "twitter:image:width",
"content": "1200"
},
{
"property": "twitter:image:height",
"content": "630"
}
],
"jsonLd": null,
"headers": {
"age": "596",
"cache-control": "public, max-age=0, must-revalidate",
"content-encoding": "br",
"content-type": "text/html; charset=utf-8",
"date": "Wed, 05 Mar 2025 23:38:18 GMT",
"etag": "W/\"9l5fazxn8u4gzd\"",
"server": "Vercel",
"strict-transport-security": "max-age=63072000",
"x-frame-options": "DENY",
"x-matched-path": "/_sites/[subdomain]/[[...slug]]",
"x-powered-by": "Next.js",
"x-vercel-cache": "HIT",
"x-vercel-id": "iad1::iad1::6tqph-1741218495449-
df23afa90a96",
"transfer-encoding": "chunked"
}
},
"screenshotUrl": null,
"text": "MongoDB - Evolution API Documentation\nSetup
\nMongoDB, a NoSQL database, is known for high performance and
scalability. It’s ideal for handling large data volumes in
the Evolution API.\nSet the MongoDB environment variables in
the .env for Docker or the dev-env.yml for NPM file as
follows:\nMigrate your data in NPM or NVM\nStop the PM2
execution:\nFlush and Stop: Clears all logs from PM2, useful
for troubleshooting after the update and temporarily stops the
Evolution API to safely apply updates.\nEvolution API
directory: access your directory installation with the
following command:\nMigrate command: Run the migration command
in the installation directory:\nFollow the script steps and
migrate specific WhatsApp instances or all your instances.",
"markdown": "# MongoDB - Evolution API Documentation\n\n##
Setup\n\nMongoDB, a NoSQL database, is known for high
performance and scalability. It’s ideal for handling large
data volumes in the Evolution API.\n\nSet the MongoDB
environment variables in the `.env` for Docker or the `dev-
149
env.yml` for NPM file as follows:\n\n## Migrate your data in
NPM or NVM\n\nStop the PM2 execution:\n\n**Flush and Stop**:
Clears all logs from PM2, useful for troubleshooting after the
update and temporarily stops the Evolution API to safely apply
updates.\n\n**Evolution API directory**: access your directory
installation with the following command:\n\n**Migrate
command**: Run the migration command in the installation
directory:\n\nFollow the script steps and migrate specific
WhatsApp instances or all your instances.",
"debug": {
"requestHandlerMode": "http"
}
},
{
"url": "https://doc.evolution-api.com/v1/en/install/nvm",
"crawl": {
"loadedUrl": "https://doc.evolution-
api.com/v1/en/install/nvm",
"loadedTime": "2025-03-05T23:48:15.810Z"
},
"metadata": {
"canonicalUrl": "https://doc.evolution-
api.com/v1/en/install/nvm",
"title": "NVM - Evolution API Documentation",
"description": null,
"author": null,
"keywords": null,
"languageCode": "en",
"openGraph": [
{
"property": "og:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=NVM&logoLight=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover.png&logoDark=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover-white.png&primaryColor=%2349BC94
&lightColor=%2349BC94&darkColor=%2349BC94"
},
{
"property": "og:image:width",
"content": "1200"
},
{
"property": "og:image:height",
"content": "630"
},
{
"property": "twitter:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=NVM&logoLight=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover.png&logoDark=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover-white.png&primaryColor=%2349BC94
&lightColor=%2349BC94&darkColor=%2349BC94"
},
150
 {
"property": "twitter:image:width",
"content": "1200"
},
{
"property": "twitter:image:height",
"content": "630"
}
],
"jsonLd": null,
"headers": {
"age": "0",
"cache-control": "public, max-age=0, must-revalidate",
"content-encoding": "br",
"content-type": "text/html; charset=utf-8",
"date": "Wed, 05 Mar 2025 23:48:15 GMT",
"etag": "W/\"ijl0a5xn227dn1\"",
"server": "Vercel",
"strict-transport-security": "max-age=63072000",
"x-frame-options": "DENY",
"x-matched-path": "/_sites/[subdomain]/[[...slug]]",
"x-powered-by": "Next.js",
"x-vercel-cache": "MISS",
"x-vercel-id": "iad1::iad1::7cqdp-1741218495337-
e57e67cd0fec",
"transfer-encoding": "chunked"
}
},
"screenshotUrl": null,
"text": "NVM - Evolution API Documentation\nEvolution API
can be easily installed using the Node Version Manager (NVM).
Follow these steps to set up your environment and start the
Evolution API on your server.\nInstall NVM\nFirst, download
and install Node.js. You can do this by running the following
commands:\nNow, just point to the NVM directories and install
Node:\nConfirm that NVM was successfully installed:\nClone the
official GitHub repository to your private server.\nNext,
navigate to the folder where the project is located.\nNow,
let’s copy the env.yml file with the settings you need to
edit.\nThis command creates a copy of the default environment
file.\nNext, open the env.yml file in a text editor to enter
your configuration settings. You can use nano, a command-line
text editor, for this purpose:\nIn the nano editor, navigate
through the file and replace the default values with your
specific settings. This can include database connection
strings, API keys, server ports, etc.\nTo start the Evolution
API, use the following command:\nInstall and Configure PM2
\nUse PM2 to install PM2 and start the manager for the API
process:\nIf you want to ensure the API is running, simply use
your browser to access http://localhost:8080. This should be
the response from your browser:\nEvolutionAPI has built-in
Swagger endpoint documentation, which you can use to see all
possible endpoints and test requests by accessing
http://localhost:8080/docs.\nNginx Configuration\nFirst, letâ
€™s install, start, enable, and test the Nginx service on your
private server.\nIf the information “Active: active
(running)†appears in green, it means that Nginx is running
151
and you can proceed to the next step.\nRemove Default Nginx
Configuration\nFirst, remove the default site file that comes
enabled with Nginx:\nCreate a new server block file in the
directory\nNext, paste the Nginx configuration into the
default.conf file:\n/etc/nginx/conf.d/default.conf\nAfter
making changes to the Nginx settings, it is essential to
reload the Nginx service. This ensures that any modifications
you have made are applied and become effective.\nRun the
following command in the terminal to reload Nginx:\nMake the
nginx user the owner of the web directory, by default, it is
owned by the root user:\nNow, create a Virtual Host pointing
to your subdomain by editing the api file:\nNext, paste the
Nginx configuration into the api file:\n/etc/nginx/sites-
available/api\nCreate a symbolic link between the api and
sites-enabled files:\nNext, validate the Nginx configuration
for the subdomain:\nReload Nginx for the changes to take
effect.\nInstall Certbot for SSL Certificate\nTo secure your
Evolution API with an SSL certificate, you can use Certbot.
Install Certbot using the following command:\nCertify the API
subdomain\nYou will be asked if you want to enter an email to
receive notifications when the generated certificate is close
to its expiration date.",
"markdown": "# NVM - Evolution API Documentation\n
\nEvolution API can be easily installed using the Node Version
Manager (NVM). Follow these steps to set up your environment
and start the Evolution API on your server.\n\n## Install NVM
\n\nFirst, download and install Node.js. You can do this by
running the following commands:\n\nNow, just point to the NVM
directories and install Node:\n\nConfirm that NVM was
successfully installed:\n\nClone the official GitHub
repository to your private server.\n\nNext, navigate to the
folder where the project is located.\n\nNow, let’s copy the
`env.yml` file with the settings you need to edit.\n\nThis
command creates a copy of the default environment file.\n
\nNext, open the env.yml file in a text editor to enter your
configuration settings. You can use nano, a command-line text
editor, for this purpose:\n\nIn the nano editor, navigate
through the file and replace the default values with your
specific settings. This can include database connection
strings, API keys, server ports, etc.\n\nTo start the
Evolution API, use the following command:\n\n## Install and
Configure PM2\n\nUse PM2 to install PM2 and start the manager
for the API process:\n\nIf you want to ensure the API is
running, simply use your browser to access
[http://localhost:8080](http://localhost:8080/). This should
be the response from your browser:\n\nEvolutionAPI has built-
in Swagger endpoint documentation, which you can use to see
all possible endpoints and test requests by accessing
`http://localhost:8080/docs`.\n\n## Nginx Configuration\n
\nFirst, let’s install, start, enable, and test the Nginx
service on your private server.\n\nIf the information â
€œActive: active (running)†appears in green, it means that
Nginx is running and you can proceed to the next step.\n\n###
Remove Default Nginx Configuration\n\nFirst, remove the
default site file that comes enabled with Nginx:\n\n### Create
a new server block file in the directory\n\nNext, paste the
Nginx configuration into the `default.conf` file:\n
152
\n/etc/nginx/conf.d/default.conf\n\nAfter making changes to
the Nginx settings, it is essential to reload the Nginx
service. This ensures that any modifications you have made are
applied and become effective.\n\nRun the following command in
the terminal to reload Nginx:\n\nMake the nginx user the owner
of the web directory, by default, it is owned by the root
user:\n\nNow, create a Virtual Host pointing to your subdomain
by editing the `api` file:\n\nNext, paste the Nginx
configuration into the `api` file:\n\n/etc/nginx/sites-
available/api\n\nCreate a symbolic link between the `api` and
`sites-enabled` files:\n\nNext, validate the Nginx
configuration for the subdomain:\n\nReload Nginx for the
changes to take effect.\n\n## Install Certbot for SSL
Certificate\n\nTo secure your Evolution API with an SSL
certificate, you can use Certbot. Install Certbot using the
following command:\n\n### Certify the API subdomain\n\nYou
will be asked if you want to enter an email to receive
notifications when the generated certificate is close to its
expiration date.",
"debug": {
"requestHandlerMode": "http"
}
},
{
"url": "https://doc.evolution-api.com/v1/en/optional-
resources/rabbitmq",
"crawl": {
"loadedUrl": "https://doc.evolution-
api.com/v1/en/optional-resources/rabbitmq",
"loadedTime": "2025-03-05T23:48:17.076Z"
},
"metadata": {
"canonicalUrl": "https://doc.evolution-
api.com/v1/en/optional-resources/rabbitmq",
"title": "RabbitMQ - Evolution API Documentation",
"description": null,
"author": null,
"keywords": null,
"languageCode": "en",
"openGraph": [
{
"property": "og:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=RabbitMQ&logoLight=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover.png&logoDark=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover-white.png&primaryColor=%2349BC94
&lightColor=%2349BC94&darkColor=%2349BC94"
},
{
"property": "og:image:width",
"content": "1200"
},
{
"property": "og:image:height",
"content": "630"
153
 },
{
"property": "twitter:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=RabbitMQ&logoLight=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover.png&logoDark=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover-white.png&primaryColor=%2349BC94
&lightColor=%2349BC94&darkColor=%2349BC94"
},
{
"property": "twitter:image:width",
"content": "1200"
},
{
"property": "twitter:image:height",
"content": "630"
}
],
"jsonLd": null,
"headers": {
"age": "598",
"cache-control": "public, max-age=0, must-revalidate",
"content-encoding": "br",
"content-type": "text/html; charset=utf-8",
"date": "Wed, 05 Mar 2025 23:38:18 GMT",
"etag": "W/\"mxjpy7epdf4mzf\"",
"server": "Vercel",
"strict-transport-security": "max-age=63072000",
"x-frame-options": "DENY",
"x-matched-path": "/_sites/[subdomain]/[[...slug]]",
"x-powered-by": "Next.js",
"x-vercel-cache": "HIT",
"x-vercel-id":
"iad1::iad1::qv5cv-1741218496751-31a0b8eb246b",
"transfer-encoding": "chunked"
}
},
"screenshotUrl": null,
"text": "RabbitMQ - Evolution API Documentation\nActivating
RabbitMQ\nTo effectively utilize RabbitMQ with the Evolution
API for managing WhatsApp instances, it’s essential to
activate RabbitMQ on each individual WhatsApp instance. This
activation allows each instance to start receiving and
processing AMQP (Advanced Message Queuing Protocol) queue
requests that are specific to that particular WhatsApp
instance.\nIn other words, for each WhatsApp instance where
you want to use RabbitMQ, you need to ensure that RabbitMQ
integration is enabled. This setup will allow the instance to
communicate with the RabbitMQ server and handle its queue of
messages and requests. Enabling RabbitMQ on each instance is
crucial for proper distribution and management of messaging
tasks across different WhatsApp instances in your system.
\nRabbitMQ setup for an individual instance\nFor developers
who wants to use in their applications AMQP messaging system,
you could use RabbitMQ for queue your instances actions.\nTo
154
configure RabbitMQ for individual WhatsApp instances in the
Evolution API, you can use the following endpoint:\nThis
endpoint allows you to enable RabbitMQ and specify which
events each WhatsApp instance should subscribe to in the AMQP
queue. Below is an example of the JSON body for this endpoint:
\nWhen setting up RabbitMQ integration, adjust the events
array in the JSON body to include only the events you want to
subscribe to. Uncomment any event you wish to enable for
RabbitMQ notifications.\nNow you can send to your application
the messages and consume them in RabbitMQ.\nCheckout RabbitMQ
environment variables here",
"markdown": "# RabbitMQ - Evolution API Documentation\n\n##
Activating RabbitMQ\n\nTo effectively utilize RabbitMQ with
the Evolution API for managing WhatsApp instances, it’s
essential to activate RabbitMQ on each individual WhatsApp
instance. This activation allows each instance to start
receiving and processing AMQP (Advanced Message Queuing
Protocol) queue requests that are specific to that particular
WhatsApp instance.\n\nIn other words, for each WhatsApp
instance where you want to use RabbitMQ, you need to ensure
that RabbitMQ integration is enabled. This setup will allow
the instance to communicate with the RabbitMQ server and
handle its queue of messages and requests. Enabling RabbitMQ
on each instance is crucial for proper distribution and
management of messaging tasks across different WhatsApp
instances in your system.\n\n## RabbitMQ setup for an
individual instance\n\nFor **developers** who wants to use in
their applications AMQP messaging system, you could use
RabbitMQ for queue your instances actions.\n\nTo configure
RabbitMQ for individual WhatsApp instances in the Evolution
API, you can use the following endpoint:\n\nThis endpoint
allows you to enable RabbitMQ and specify which events each
WhatsApp instance should subscribe to in the AMQP queue. Below
is an example of the JSON body for this endpoint:\n\nWhen
setting up RabbitMQ integration, adjust the events array in
the JSON body to include only the events you want to subscribe
to. Uncomment any event you wish to enable for RabbitMQ
notifications.\n\nNow you can send to your application the
messages and consume them in RabbitMQ.\n\nCheckout RabbitMQ
environment variables [here](https://doc.evolution-
api.com/en/env#rabbitmq)",
"debug": {
"requestHandlerMode": "http"
}
},
{
"url": "https://doc.evolution-api.com/v1/en/optional-
resources/websocket",
"crawl": {
"loadedUrl": "https://doc.evolution-
api.com/v1/en/optional-resources/websocket",
"loadedTime": "2025-03-05T23:48:17.161Z"
},
"metadata": {
"canonicalUrl": "https://doc.evolution-
api.com/v1/en/optional-resources/websocket",
"title": "Websocket - Evolution API Documentation",
155
 "description": null,
"author": null,
"keywords": null,
"languageCode": "en",
"openGraph": [
{
"property": "og:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Websocket&logoLight=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover.png&logoDark=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover-white.png&primaryColor=%2349BC94
&lightColor=%2349BC94&darkColor=%2349BC94"
},
{
"property": "og:image:width",
"content": "1200"
},
{
"property": "og:image:height",
"content": "630"
},
{
"property": "twitter:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Websocket&logoLight=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover.png&logoDark=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover-white.png&primaryColor=%2349BC94
&lightColor=%2349BC94&darkColor=%2349BC94"
},
{
"property": "twitter:image:width",
"content": "1200"
},
{
"property": "twitter:image:height",
"content": "630"
}
],
"jsonLd": null,
"headers": {
"age": "597",
"cache-control": "public, max-age=0, must-revalidate",
"content-encoding": "br",
"content-type": "text/html; charset=utf-8",
"date": "Wed, 05 Mar 2025 23:38:18 GMT",
"etag": "W/\"ponn1mpz124ymj\"",
"server": "Vercel",
"strict-transport-security": "max-age=63072000",
"x-frame-options": "DENY",
"x-matched-path": "/_sites/[subdomain]/[[...slug]]",
"x-powered-by": "Next.js",
"x-vercel-cache": "HIT",
"x-vercel-id": "iad1::iad1::ztmtj-1741218496977-
156
bd350985fe05",
"transfer-encoding": "chunked"
}
},
"screenshotUrl": null,
"text": "Websocket - Evolution API Documentation\nEvolution
API utilizes socket.io to emit events, leveraging WebSocket
technology. This makes the development of integrations more
efficient and straightforward for developers. WebSocket
provides a full-duplex communication channel over a single,
long-lived connection, enabling real-time data flow between
the client and server.\nConnecting to WebSocket\nTo connect to
the WebSocket server in the Evolution API, you can use the
following URL format:\nReplace api.yoursite.com with your
actual API domain and instance_name with the name of your
specific instance.\nExample of Establishing a WebSocket
Connection Here’s a basic example of how to establish a
WebSocket connection using JavaScript:\nIn this example,
replace event_name with the specific event you want to listen
to.\nHandling Events\nOnce connected, you can listen for
various events emitted by the server. Each event may carry
data relevant to the event’s context. For instance, if youâ
€™re listening for message updates, you might receive data
containing the updated message content and metadata.\nSending
Messages\nYou can also send messages to the server using the
emit method:\nClosing the Connection\nTo close the WebSocket
connection, use the disconnect method:\nRemember to handle the
connection responsibly, disconnecting when your application or
component unmounts to prevent memory leaks and ensure
efficient resource usage.\nBy leveraging WebSockets, Evolution
API offers a powerful way to interact with the system in real
time, providing a seamless experience for both developers and
end-users.",
"markdown": "# Websocket - Evolution API Documentation\n
\nEvolution API utilizes socket.io to emit events, leveraging
WebSocket technology. This makes the development of
integrations more efficient and straightforward for
developers. WebSocket provides a full-duplex communication
channel over a single, long-lived connection, enabling real-
time data flow between the client and server.\n\n## Connecting
to WebSocket\n\nTo connect to the WebSocket server in the
Evolution API, you can use the following URL format:\n
\nReplace api.yoursite.com with your actual API domain and
instance\\_name with the name of your specific instance.\n
\nExample of Establishing a WebSocket Connection Here’s a
basic example of how to establish a WebSocket connection using
JavaScript:\n\nIn this example, replace event\\_name with the
specific event you want to listen to.\n\n## Handling Events\n
\nOnce connected, you can listen for various events emitted by
the server. Each event may carry data relevant to the eventâ
€™s context. For instance, if you’re listening for message
updates, you might receive data containing the updated message
content and metadata.\n\n## Sending Messages\n\nYou can also
send messages to the server using the emit method:\n\n##
Closing the Connection\n\nTo close the WebSocket connection,
use the disconnect method:\n\nRemember to handle the
connection responsibly, disconnecting when your application or
157
component unmounts to prevent memory leaks and ensure
efficient resource usage.\n\nBy leveraging WebSockets,
Evolution API offers a powerful way to interact with the
system in real time, providing a seamless experience for both
developers and end-users.",
"debug": {
"requestHandlerMode": "http"
}
},
{
"url": "https://doc.evolution-api.com/v1/pt/updates",
"crawl": {
"loadedUrl": "https://doc.evolution-
api.com/v1/pt/updates",
"loadedTime": "2025-03-05T23:48:17.364Z",
"referrerUrl": "https://doc.evolution-api.com/",
"depth": 1
},
"metadata": {
"canonicalUrl": "https://doc.evolution-
api.com/v1/pt/updates",
"title": "Atualização - Evolution API Documentation",
"description": null,
"author": null,
"keywords": null,
"languageCode": "en",
"openGraph": [
{
"property": "og:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Atualiza%C3%A7%C3%
A3o&logoLight=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover.png&logoDark=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover-white.png&primaryColor=%2349BC94&lightColor=%2349BC94
&darkColor=%2349BC94"
},
{
"property": "og:image:width",
"content": "1200"
},
{
"property": "og:image:height",
"content": "630"
},
{
"property": "twitter:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Atualiza%C3%A7%C3%
A3o&logoLight=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover.png&logoDark=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover-white.png&primaryColor=%2349BC94&lightColor=%2349BC94
&darkColor=%2349BC94"
},
158
 {
"property": "twitter:image:width",
"content": "1200"
},
{
"property": "twitter:image:height",
"content": "630"
}
],
"jsonLd": null,
"headers": {
"age": "606",
"cache-control": "public, max-age=0, must-revalidate",
"content-encoding": "br",
"content-type": "text/html; charset=utf-8",
"date": "Wed, 05 Mar 2025 23:38:10 GMT",
"etag": "W/\"pyxrs7oct84ykn\"",
"server": "Vercel",
"strict-transport-security": "max-age=63072000",
"x-frame-options": "DENY",
"x-matched-path": "/_sites/[subdomain]/[[...slug]]",
"x-powered-by": "Next.js",
"x-vercel-cache": "HIT",
"x-vercel-id":
"iad1::iad1::8bb7j-1741218497324-168ccb5c93a0",
"transfer-encoding": "chunked"
}
},
"screenshotUrl": null,
"text": "Atualização - Evolution API Documentation\nManter
sua instância da Evolution API atualizada é crucial para
segurança, desempenho e acesso a novos recursos. O método de
atualização depende de como você inicialmente instalou a
API. Este guia cobre os passos para atualizar sua Evolution
API usando Docker Compose e NPM.\nSe você configurou
inicialmente sua Evolution API usando Docker, siga estas
etapas para atualizar:\nAtualização com Docker CLI\nSe sua
Evolution API foi instalada inicialmente usando Docker Compose
via interface de linha de comando (CLI), e não através do
Portainer ou qualquer outra ferramenta de gerenciamento de
contêiner, siga estas etapas para atualizá-la:\nNavegue até
o Diretório do Docker Compose: Abra um terminal e vá para o
diretório onde seu arquivo Docker Compose (docker-
compose.yml) está localizado.\nPuxe a Imagem Mais Recente:
Atualize a imagem da Evolution API para a versão mais recente
executando o seguinte comando:\nPare e Reinicie os
Contêineres: Após puxar a imagem mais recente, pare os
contêineres atuais e reinicie-os. Isso pode ser feito usando
o seguinte comando:\nSe você está usando o Portainer para
gerenciamento de contêineres, siga estas etapas para
atualizar sua Evolution API:\nAcesse o Painel do Portainer:
Abra o painel do Portainer em um navegador web.\nNavegue até
Seus Contêineres: Vá para a seção ‘Stacks’ onde seu
contêiner da Evolution API está listado.\nAtualize o
Compose:\nLocalize o campo image na sua configuração do
Docker Compose.\nAtualize o valor para atendai/evolution-
api:latest para a versão mais recente, ou use
159
atendai/evolutionapi:v1.x.x para uma versão especÃfica.
\nApós fazer as alterações, clique no botão ‘Deploy’
no final da janela de edição do compose.\nVerifique a
Atualização: Após recriar o contêiner, verifique se a
Evolution API está executando a versão mais recente. Isso
pode ser verificado tipicamente através do endpoint de versÃ
£o da API ou dos logs.\nSeguindo esses passos, você pode
garantir que sua Evolution API esteja sempre atualizada usando
o Portainer.\nAtualizar sua instalação da Evolution API via
NPM envolve várias etapas para garantir uma transição suave
para a nova versão. Aqui está um guia passo a passo:\nLimpar
e Parar: Limpe todos os logs do PM2, útil para resolução de
problemas após a atualização, e pare temporariamente a
Evolution API para aplicar as atualizações com segurança.
\nResetar o repositório local e puxar as atualizações mais
recentes: Garanta que seu código local esteja em sincronia
com o commit mais recente e baixe as atualizações mais
recentes do repositório. Opcionalmente, mude para uma versão
especÃfica se não estiver usando a mais recente. É
recomendado para ambientes de produção.\nInstalação Limpa:
Remova o node_modules existente para evitar possÃveis
conflitos com novas dependências e instale as dependências
necessárias do Node.js para a versão atualizada.",
"markdown": "# Atualização - Evolution API Documentation\n
\nManter sua instância da Evolution API atualizada é crucial
para segurança, desempenho e acesso a novos recursos. O
método de atualização depende de como você inicialmente
instalou a API. Este guia cobre os passos para atualizar sua
Evolution API usando Docker Compose e NPM.\n\nSe você
configurou inicialmente sua Evolution API usando Docker, siga
estas etapas para atualizar:\n\n### Atualização com Docker
CLI\n\nSe sua Evolution API foi instalada inicialmente usando
Docker Compose via interface de linha de comando (CLI), e não
através do Portainer ou qualquer outra ferramenta de
gerenciamento de contêiner, siga estas etapas para atualizá-
la:\n\n1. **Navegue até o Diretório do Docker Compose**:
Abra um terminal e vá para o diretório onde seu arquivo
Docker Compose (`docker-compose.yml`) está localizado.\n
\n2. **Puxe a Imagem Mais Recente**: Atualize a imagem da
Evolution API para a versão mais recente executando o
seguinte comando:\n \n\n3. **Pare e Reinicie os
Contêineres**: Após puxar a imagem mais recente, pare os
contêineres atuais e reinicie-os. Isso pode ser feito usando
o seguinte comando:\n\nSe você está usando o Portainer para
gerenciamento de contêineres, siga estas etapas para
atualizar sua Evolution API:\n\n1. **Acesse o Painel do
Portainer**: Abra o painel do Portainer em um navegador web.\n
\n2. **Navegue até Seus Contêineres**: Vá para a seção â
€˜Stacks’ onde seu contêiner da Evolution API
está listado.\n \n3. **Atualize o Compose**:\n \n *
Localize o campo `image` na sua configuração do Docker
Compose.\n\n* Atualize o valor para `atendai/evolution-
api:latest` para a versão mais recente, ou use
`atendai/evolutionapi:v1.x.x` para uma versão especÃfica.\n*
Após fazer as alterações, clique no botão ‘Deploy’ no
final da janela de edição do compose.\n\n4. **Verifique a
Atualização**: Após recriar o contêiner, verifique se a
160
Evolution API está executando a versão mais recente. Isso
pode ser verificado tipicamente através do endpoint de versÃ
£o da API ou dos logs.\n\nSeguindo esses passos, você pode
garantir que sua Evolution API esteja sempre atualizada usando
o Portainer.\n\nAtualizar sua instalação da Evolution API
via NPM envolve várias etapas para garantir uma transição
suave para a nova versão. Aqui está um guia passo a passo:\n
\n1. **Limpar e Parar**: Limpe todos os logs do PM2, útil
para resolução de problemas após a atualização, e pare
temporariamente a Evolution API para aplicar as atualizações
com segurança.\n\n2. **Resetar o repositório local e puxar
as atualizações mais recentes**: Garanta que seu código
local esteja em sincronia com o commit mais recente e baixe as
atualizações mais recentes do repositório. Opcionalmente,
mude para uma versão especÃfica se não estiver usando a mais
recente. É recomendado para ambientes de produção.\n\n3.
**Instalação Limpa**: Remova o `node_modules` existente para
evitar possÃveis conflitos com novas dependências e instale
as dependências necessárias do Node.js para a versão
atualizada.",
"debug": {
"requestHandlerMode": "http"
}
},
{
"url": "https://doc.evolution-
api.com/v1/pt/configuration/available-resources",
"crawl": {
"loadedUrl": "https://doc.evolution-
api.com/v1/pt/configuration/available-resources",
"loadedTime": "2025-03-05T23:48:18.139Z"
},
"metadata": {
"canonicalUrl": "https://doc.evolution-
api.com/v1/pt/configuration/available-resources",
"title": "Recursos DisponÃveis - Evolution API
Documentation",
"description": null,
"author": null,
"keywords": null,
"languageCode": "en",
"openGraph": [
{
"property": "og:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Recursos+Dispon%C3%
ADveis&logoLight=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover.png&logoDark=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover-white.png&primaryColor=%2349BC94&lightColor=%2349BC94
&darkColor=%2349BC94"
},
{
"property": "og:image:width",
"content": "1200"
},
161
 {
"property": "og:image:height",
"content": "630"
},
{
"property": "twitter:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Recursos+Dispon%C3%
ADveis&logoLight=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover.png&logoDark=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover-white.png&primaryColor=%2349BC94&lightColor=%2349BC94
&darkColor=%2349BC94"
},
{
"property": "twitter:image:width",
"content": "1200"
},
{
"property": "twitter:image:height",
"content": "630"
}
],
"jsonLd": null,
"headers": {
"age": "582",
"cache-control": "public, max-age=0, must-revalidate",
"content-encoding": "br",
"content-type": "text/html; charset=utf-8",
"date": "Wed, 05 Mar 2025 23:38:35 GMT",
"etag": "W/\"xzigi4ntq64i5e\"",
"server": "Vercel",
"strict-transport-security": "max-age=63072000",
"x-frame-options": "DENY",
"x-matched-path": "/_sites/[subdomain]/[[...slug]]",
"x-powered-by": "Next.js",
"x-vercel-cache": "HIT",
"x-vercel-id": "iad1::iad1::ztmtj-1741218498002-
af03905faeca",
"transfer-encoding": "chunked"
}
},
"screenshotUrl": null,
"text": "Recursos DisponÃveis - Evolution API Documentation
\nRecursos de Mensagens e Grupos\nMensagens (Individuais ou em
Grupo)\nRecursoDisponibilidadeDescrição\nEnvio de Texto\t✅
\t(Texto simples, em negrito, itálico, riscado, em formato de
código e emojis)\t\nEnvio de MÃdia\t✅\t(VÃdeo, imagem e
documento)\t\nEnvio de à udio Narrado\t✅\t(Funcionando bem
no Android e iOS)\t\nEnvio de Localização\t✅\t(Com nome e
descrição do local)\t\nEnvio de Contato\t✅\t(Com Nome,
Empresa, Telefone, E-mail e URL)\t\nEnvio de Reação\t✅
\t(Envie qualquer emoji para reação)\t\nEnvio de Pré-
visualização de Link\t✅\t(Busca por informações de SEO)
🆕\t\nEnvio de Resposta\t✅\t(Marcar mensagens em resposta)
🆕\t\nEnvio de Menção\t✅\t(Individual, para alguns ou
162
todos os membros) 🆕\t\nEnvio de Enquete\t✅\t(Enviar e
receber votos de uma enquete) 🆕\t\nEnvio de
Status/História\t✅\t(Texto, pré-visualização de link,
vÃdeo, imagem e forma de onda) 🆕\t\nEnvio de Adesivo\t✅
\t(Imagem estática) 🆕\t\nEnvio de Lista (HomologaçÃ
£o)\t✅\t(Testando)\t\nEnvio de Botões (Descontinuado)\tâ Œ
\t(Só funciona na API em nuvem)\t\nPerfil
\nRecursoDisponibilidadeDescrição\nAtualizar Nome\t✅
\t(Alterar o nome do perfil conectado)\t\nAtualizar Foto\t✅
\t(Alterar a foto do perfil conectado) 🆕\t\nAtualizar
Status\t✅\t(Alterar o status do perfil conectado) 🆕\t\nE
muitos outros…\t\t\t\nGrupo\nRecursoDisponibilidadeDescriçÃ
£o\nCriar Grupo\t✅\t(Novos grupos)\t\nAtualizar Foto\t✅
\t(Alterar foto do grupo)\t\nAtualizar Assunto\t✅\t(Alterar
o nome do grupo) 🆕\t\nAtualizar Descrição\t✅\t(Alterar
a descrição do grupo) 🆕\t\nObter Todos os Grupos\t✅
\t(Obter todos os grupos e participantes) 🆕\t\nE muitos
outros…",
"markdown": "# Recursos DisponÃveis - Evolution API
Documentation\n\n## Recursos de Mensagens e Grupos\n\n###
Mensagens (Individuais ou em Grupo)\n\n| Recurso |
Disponibilidade | Descrição |\n| --- | --- | --- |\n| Envio
de Texto | ✅ | (Texto simples, em negrito, itálico,
riscado, em formato de código e emojis) |\n| Envio de MÃdia |
✅ | (VÃdeo, imagem e documento) |\n| Envio de à udio
Narrado | ✅ | (Funcionando bem no Android e iOS) |\n|
Envio de Localização | ✅ | (Com nome e descrição do
local) |\n| Envio de Contato | ✅ | (Com Nome, Empresa,
Telefone, E-mail e URL) |\n| Envio de Reação | ✅ |
(Envie qualquer emoji para reação) |\n| Envio de Pré-
visualização de Link | ✅ | (Busca por informações de
SEO) 🆕 |\n| Envio de Resposta | ✅ | (Marcar mensagens
em resposta) 🆕 |\n| Envio de Menção | ✅ |
(Individual, para alguns ou todos os membros) 🆕 |\n| Envio
de Enquete | ✅ | (Enviar e receber votos de uma enquete)
🆕 |\n| Envio de Status/História | ✅ | (Texto, pré-
visualização de link, vÃdeo, imagem e forma de onda) 🆕 |
\n| Envio de Adesivo | ✅ | (Imagem estática) 🆕 |\n|
Envio de Lista (Homologação) | ✅ | (Testando) |\n| Envio
de Botões (Descontinuado) | ⠌ | (Só funciona na API em
nuvem) |\n\n### Perfil\n\n| Recurso | Disponibilidade |
Descrição |\n| --- | --- | --- |\n| Atualizar Nome | ✅ |
(Alterar o nome do perfil conectado) |\n| Atualizar Foto | ✅
| (Alterar a foto do perfil conectado) 🆕 |\n| Atualizar
Status | ✅ | (Alterar o status do perfil conectado) 🆕 |
\n| E muitos outros… | | |\n\n### Grupo\n\n| Recurso
| Disponibilidade | Descrição |\n| --- | --- | --- |\n|
Criar Grupo | ✅ | (Novos grupos) |\n| Atualizar Foto | ✅
| (Alterar foto do grupo) |\n| Atualizar Assunto | ✅ |
(Alterar o nome do grupo) 🆕 |\n| Atualizar Descrição |
✅ | (Alterar a descrição do grupo) 🆕 |\n| Obter Todos
os Grupos | ✅ | (Obter todos os grupos e participantes)
🆕 |\n| E muitos outros… | | |",
"debug": {
"requestHandlerMode": "http"
}
},
163
{
"url": "https://doc.evolution-
api.com/v1/pt/configuration/webhooks",
"crawl": {
"loadedUrl": "https://doc.evolution-
api.com/v1/pt/configuration/webhooks",
"loadedTime": "2025-03-05T23:48:18.889Z"
},
"metadata": {
"canonicalUrl": "https://doc.evolution-
api.com/v1/pt/configuration/webhooks",
"title": "Webhooks - Evolution API Documentation",
"description": null,
"author": null,
"keywords": null,
"languageCode": "en",
"openGraph": [
{
"property": "og:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Webhooks&logoLight=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover.png&logoDark=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover-white.png&primaryColor=%2349BC94
&lightColor=%2349BC94&darkColor=%2349BC94"
},
{
"property": "og:image:width",
"content": "1200"
},
{
"property": "og:image:height",
"content": "630"
},
{
"property": "twitter:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Webhooks&logoLight=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover.png&logoDark=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover-white.png&primaryColor=%2349BC94
&lightColor=%2349BC94&darkColor=%2349BC94"
},
{
"property": "twitter:image:width",
"content": "1200"
},
{
"property": "twitter:image:height",
"content": "630"
}
],
"jsonLd": null,
"headers": {
"age": "583",
164
 "cache-control": "public, max-age=0, must-revalidate",
"content-encoding": "br",
"content-type": "text/html; charset=utf-8",
"date": "Wed, 05 Mar 2025 23:38:35 GMT",
"etag": "W/\"72jxnrnqth61lf\"",
"server": "Vercel",
"strict-transport-security": "max-age=63072000",
"x-frame-options": "DENY",
"x-matched-path": "/_sites/[subdomain]/[[...slug]]",
"x-powered-by": "Next.js",
"x-vercel-cache": "HIT",
"x-vercel-id": "iad1::iad1::v8r77-1741218498842-
dcba90f1b2e0",
"transfer-encoding": "chunked"
}
},
"screenshotUrl": null,
"text": "Webhooks - Evolution API Documentation\nOs Webhooks
permitem integração em tempo real entre a Evolution API e o
WhatsApp™, permitindo sincronização e compartilhamento
automatizados de dados.\nÉ exatamente esse recurso que
possibilita a criação de bots de autoatendimento e sistemas
multi-serviço.\nAtivando Webhooks\nExistem duas maneiras de
ativar o webhook:\nNo arquivo .env com eventos globais
\nChamando o endpoint /webhook/instance\nEventos de webhook da
instância\nA maioria dos usuários preferirá a ativação
por instância, desta forma é mais fácil controlar os
eventos recebidos, no entanto em alguns casos é necessário
um webhook global, isso pode ser feito usando a variável de
webhook global.\nAqui está um exemplo com alguns eventos
comuns ouvidos:\nParâmetros\nParâ
metroTipoObrigatórioDescrição\nenabled\tboolean\tSim
\tInsira “true†para criar ou alterar dados do Webhook, ou
“false†se quiser parar de usá-lo.\t\nurl\tstring\tSim
\tURL do Webhook para receber dados do evento.\t
\nwebhook_by_events\tboolean\tNão\tDeseja gerar uma URL
especÃfica do Webhook para cada um dos seus eventos.\t\nevents
\tarray\tNão\tLista de eventos a serem processados. Se você
não quiser usar alguns desses eventos, apenas remova-os da
lista.\t\nEventos Globais de Webhook\nCada URL e eventos de
Webhook da instância serão solicitados no momento em que
forem criados Defina um webhook global que ouvirá eventos
habilitados de todas as instâncias\nEventos Suportados\nEstes
são os eventos de webhook disponÃveis e suportados:
\nVariável de ambienteURLDescrição\nAPPLICATION_STARTUP
\t/application-startup\tNotifica quando uma inicialização de
aplicativo ocorre\t\nQRCODE_UPDATED\t/qrcode-updated\tEnvia o
base64 do qrcode para leitura\t\nCONNECTION_UPDATE
\t/connection-update\tInforma o status da conexão com o
WhatsApp\t\nMESSAGES_SET\t/messages-set\tEnvia uma lista de
todas as suas mensagens carregadas no WhatsApp. Este evento
ocorre apenas uma vez\t\nMESSAGES_UPSERT\t/messages-upsert
\tNotifica quando uma mensagem é recebida\t\nMESSAGES_UPDATE
\t/messages-update\tInforma quando uma mensagem é atualizada
\t\nMESSAGES_DELETE\t/messages-delete\tInforma quando uma
mensagem é excluÃda\t\nSEND_MESSAGE\t/send-message\tNotifica
quando uma mensagem é enviada\t\nCONTACTS_SET\t/contacts-set
165
\tRealiza o carregamento inicial de todos os contatos. Este
evento ocorre apenas uma vez\t\nCONTACTS_UPSERT\t/contacts-
upsert\tRecarrega todos os contatos com informações
adicionais. Este evento ocorre apenas uma vez\t
\nCONTACTS_UPDATE\t/contacts-update\tInforma quando o contato
é atualizado\t\nPRESENCE_UPDATE\t/presence-update\tInforma se
o usuário está online, se ele está realizando alguma ação
como escrever ou gravar e seu último visto: ‘indisponÃvelâ
€™, ‘disponÃvel’, ‘compondo’, ‘gravando’, â
€˜pausado’\t\nCHATS_SET\t/chats-set\tEnvia uma lista de
todos os chats carregados\t\nCHATS_UPDATE\t/chats-update
\tInforma quando o chat é atualizado\t\nCHATS_UPSERT\t/chats-
upsert\tEnvia qualquer nova informação de chat\t
\nCHATS_DELETE\t/chats-delete\tNotifica quando um chat é
excluÃdo\t\nGROUPS_UPSERT\t/groups-upsert\tNotifica quando um
grupo é criado\t\nGROUPS_UPDATE\t/groups-update\tNotifica
quando um grupo tem suas informações atualizadas\t
\nGROUP_PARTICIPANTS_UPDATE\t/group-participants-update
\tNotifica quando uma ação ocorre envolvendo um
participante: ‘adicionar’, ‘remover’, ‘promover’,
‘rebaixar’\t\nNEW_TOKEN\t/new-jwt\tNotifica quando o token
(jwt) é atualizado\t\nWebhook por eventos\nAo habilitar as
opções WEBHOOK_BY_EVENTS nos webhooks globais e locais, os
seguintes caminhos serão adicionados ao final do webhook.
\nExemplo\nSupondo que sua URL de webhook fosse
https://sub.domain.com/webhook/. A Evolution
adicionará automaticamente ao final da URL o nome do evento
quando webhook_by_events estiver definido como verdadeiro.
\nEventoNova URL de Webhook por Eventos\nAPPLICATION_STARTUP
\thttps://sub.domain.com/webhook/application-startup\t
\nQRCODE_UPDATED\thttps://sub.domain.com/webhook/qrcode-
updated\t\nCONNECTION_UPDATE
\thttps://sub.domain.com/webhook/connection-update\t
\nMESSAGES_SET\thttps://sub.domain.com/webhook/messages-set\t
\nMESSAGES_UPSERT\thttps://sub.domain.com/webhook/messages-
upsert\t\nMESSAGES_UPDATE
\thttps://sub.domain.com/webhook/messages-update\t
\nMESSAGES_DELETE\thttps://sub.domain.com/webhook/messages-
delete\t\nSEND_MESSAGE\thttps://sub.domain.com/webhook/send-
message\t\nCONTACTS_SET
\thttps://sub.domain.com/webhook/contacts-set\t
\nCONTACTS_UPSERT\thttps://sub.domain.com/webhook/contacts-
upsert\t\nCONTACTS_UPDATE
\thttps://sub.domain.com/webhook/contacts-update\t
\nPRESENCE_UPDATE\thttps://sub.domain.com/webhook/presence-
update\t\nCHATS_SET\thttps://sub.domain.com/webhook/chats-set
\t\nCHATS_UPDATE\thttps://sub.domain.com/webhook/chats-update
\t\nCHATS_UPSERT\thttps://sub.domain.com/webhook/chats-upsert
\t\nCHATS_DELETE\thttps://sub.domain.com/webhook/chats-delete
\t\nGROUPS_UPSERT\thttps://sub.domain.com/webhook/groups-
upsert\t\nGROUPS_UPDATE
\thttps://sub.domain.com/webhook/groups-update\t
\nGROUP_PARTICIPANTS_UPDATE
\thttps://sub.domain.com/webhook/group-participants-update\t
\nNEW_TOKEN\thttps://sub.domain.com/webhook/new-jwt\t
\nLocalizando Webhook\nSe necessário, há uma opção para
localizar qualquer webhook ativo na instância especÃfica.
166
\nMétodoEndpoint\nGET\t[baseUrl]/webhook/find/[instance]\t
\nDados retornados da solicitação:\nChamando o endpoint
retornará todas as informações sobre o webhook que
está sendo usado pela instância.",
"markdown": "# Webhooks - Evolution API Documentation\n\nOs
Webhooks permitem integração em tempo real entre a Evolution
API e o WhatsApp™, permitindo sincronização e
compartilhamento automatizados de dados.\n\nÉ exatamente esse
recurso que possibilita a criação de bots de autoatendimento
e sistemas multi-serviço.\n\n## Ativando Webhooks\n\nExistem
duas maneiras de ativar o webhook:\n\n* No arquivo `.env`
com eventos globais\n* Chamando o endpoint
`/webhook/instance`\n\n### Eventos de webhook da instância\n
\nA maioria dos usuários preferirá a ativação por instâ
ncia, desta forma é mais fácil controlar os eventos
recebidos, no entanto em alguns casos é necessário um
webhook global, isso pode ser feito usando a variável de
webhook global.\n\nAqui está um exemplo com alguns eventos
comuns ouvidos:\n\n### Parâmetros\n\n| Parâmetro | Tipo |
Obrigatório | Descrição |\n| --- | --- | --- | --- |\n|
enabled | boolean | Sim | Insira “true†para criar ou
alterar dados do Webhook, ou “false†se quiser parar de
usá-lo. |\n| url | string | Sim | URL do Webhook para receber
dados do evento. |\n| webhook\\_by\\_events | boolean | Não |
Deseja gerar uma URL especÃfica do Webhook para cada um dos
seus eventos. |\n| events | array | Não | Lista de eventos a
serem processados. Se você não quiser usar alguns desses
eventos, apenas remova-os da lista. |\n\n### Eventos Globais
de Webhook\n\nCada URL e eventos de Webhook da instância serÃ
£o solicitados no momento em que forem criados Defina um
webhook global que ouvirá eventos habilitados de todas as
instâncias\n\n## Eventos Suportados\n\nEstes são os eventos
de webhook disponÃveis e suportados:\n\n| **Variável de
ambiente** | **URL** | **Descrição** |\n| --- | --- | --- |
\n| APPLICATION\\_STARTUP | /application-startup | Notifica
quando uma inicialização de aplicativo ocorre |\n| QRCODE
\\_UPDATED | /qrcode-updated | Envia o base64 do qrcode para
leitura |\n| CONNECTION\\_UPDATE | /connection-update |
Informa o status da conexão com o WhatsApp |\n| MESSAGES
\\_SET | /messages-set | Envia uma lista de todas as suas
mensagens carregadas no WhatsApp. Este evento ocorre apenas
uma vez |\n| MESSAGES\\_UPSERT | /messages-upsert | Notifica
quando uma mensagem é recebida |\n| MESSAGES\\_UPDATE |
/messages-update | Informa quando uma mensagem é atualizada |
\n| MESSAGES\\_DELETE | /messages-delete | Informa quando uma
mensagem é excluÃda |\n| SEND\\_MESSAGE | /send-message |
Notifica quando uma mensagem é enviada |\n| CONTACTS\\_SET |
/contacts-set | Realiza o carregamento inicial de todos os
contatos. Este evento ocorre apenas uma vez |\n| CONTACTS
\\_UPSERT | /contacts-upsert | Recarrega todos os contatos com
informações adicionais. Este evento ocorre apenas uma vez |
\n| CONTACTS\\_UPDATE | /contacts-update | Informa quando o
contato é atualizado |\n| PRESENCE\\_UPDATE | /presence-
update | Informa se o usuário está online, se ele
está realizando alguma ação como escrever ou gravar e seu
último visto: ‘indisponÃvel’, ‘disponÃvel’, â
€˜compondo’, ‘gravando’, ‘pausado’ |\n| CHATS\\_SET
167
| /chats-set | Envia uma lista de todos os chats carregados |
\n| CHATS\\_UPDATE | /chats-update | Informa quando o chat é
atualizado |\n| CHATS\\_UPSERT | /chats-upsert | Envia
qualquer nova informação de chat |\n| CHATS\\_DELETE |
/chats-delete | Notifica quando um chat é excluÃdo |\n|
GROUPS\\_UPSERT | /groups-upsert | Notifica quando um grupo é
criado |\n| GROUPS\\_UPDATE | /groups-update | Notifica quando
um grupo tem suas informações atualizadas |\n| GROUP
\\_PARTICIPANTS\\_UPDATE | /group-participants-update |
Notifica quando uma ação ocorre envolvendo um participante:
‘adicionar’, ‘remover’, ‘promover’, ‘rebaixar’
|\n| NEW\\_TOKEN | /new-jwt | Notifica quando o token (jwt) é
atualizado |\n\n## Webhook por eventos\n\nAo habilitar as
opções WEBHOOK\\_BY\\_EVENTS nos webhooks globais e locais,
os seguintes caminhos serão adicionados ao final do webhook.
\n\n### Exemplo\n\nSupondo que sua URL de webhook fosse
`https://sub.domain.com/webhook/`. A Evolution
adicionará automaticamente ao final da URL o nome do evento
quando `webhook_by_events` estiver definido como verdadeiro.\n
\n| **Evento** | **Nova URL de Webhook por Eventos** |\n| ---
| --- |\n| APPLICATION\\_STARTUP |
[https://sub.domain.com/webhook/application-startup]
(https://sub.domain.com/webhook/application-startup) |\n|
QRCODE\\_UPDATED | [https://sub.domain.com/webhook/qrcode-
updated](https://sub.domain.com/webhook/qrcode-updated) |\n|
CONNECTION\\_UPDATE |
[https://sub.domain.com/webhook/connection-update]
(https://sub.domain.com/webhook/connection-update) |\n|
MESSAGES\\_SET | [https://sub.domain.com/webhook/messages-set]
(https://sub.domain.com/webhook/messages-set) |\n| MESSAGES
\\_UPSERT | [https://sub.domain.com/webhook/messages-upsert]
(https://sub.domain.com/webhook/messages-upsert) |\n| MESSAGES
\\_UPDATE | [https://sub.domain.com/webhook/messages-update]
(https://sub.domain.com/webhook/messages-update) |\n| MESSAGES
\\_DELETE | [https://sub.domain.com/webhook/messages-delete]
(https://sub.domain.com/webhook/messages-delete) |\n| SEND
\\_MESSAGE | [https://sub.domain.com/webhook/send-message]
(https://sub.domain.com/webhook/send-message) |\n| CONTACTS
\\_SET | [https://sub.domain.com/webhook/contacts-set]
(https://sub.domain.com/webhook/contacts-set) |\n| CONTACTS
\\_UPSERT | [https://sub.domain.com/webhook/contacts-upsert]
(https://sub.domain.com/webhook/contacts-upsert) |\n| CONTACTS
\\_UPDATE | [https://sub.domain.com/webhook/contacts-update]
(https://sub.domain.com/webhook/contacts-update) |\n| PRESENCE
\\_UPDATE | [https://sub.domain.com/webhook/presence-update]
(https://sub.domain.com/webhook/presence-update) |\n| CHATS
\\_SET | [https://sub.domain.com/webhook/chats-set]
(https://sub.domain.com/webhook/chats-set) |\n| CHATS\\_UPDATE
| [https://sub.domain.com/webhook/chats-update]
(https://sub.domain.com/webhook/chats-update) |\n| CHATS
\\_UPSERT | [https://sub.domain.com/webhook/chats-upsert]
(https://sub.domain.com/webhook/chats-upsert) |\n| CHATS
\\_DELETE | [https://sub.domain.com/webhook/chats-delete]
(https://sub.domain.com/webhook/chats-delete) |\n| GROUPS
\\_UPSERT | [https://sub.domain.com/webhook/groups-upsert]
(https://sub.domain.com/webhook/groups-upsert) |\n| GROUPS
\\_UPDATE | [https://sub.domain.com/webhook/groups-update]
168
(https://sub.domain.com/webhook/groups-update) |\n| GROUP
\\_PARTICIPANTS\\_UPDATE |
[https://sub.domain.com/webhook/group-participants-update]
(https://sub.domain.com/webhook/group-participants-update) |
\n| NEW\\_TOKEN | [https://sub.domain.com/webhook/new-jwt]
(https://sub.domain.com/webhook/new-jwt) |\n\n## Localizando
Webhook\n\nSe necessário, há uma opção para localizar
qualquer webhook ativo na instância especÃfica.\n\n| Método
| Endpoint |\n| --- | --- |\n| GET | \\[baseUrl
\\]/webhook/find/\\[instance\\] |\n\n### Dados retornados da
solicitação:\n\nChamando o endpoint retornará todas as
informações sobre o webhook que está sendo usado pela
instância.",
"debug": {
"requestHandlerMode": "http"
}
},
{
"url": "https://doc.evolution-api.com/v1/en/updates",
"crawl": {
"loadedUrl": "https://doc.evolution-
api.com/v1/en/updates",
"loadedTime": "2025-03-05T23:48:21.073Z",
"referrerUrl": "https://doc.evolution-api.com/v1/en/get-
started/introduction",
"depth": 1
},
"metadata": {
"canonicalUrl": "https://doc.evolution-
api.com/v1/en/updates",
"title": "Updates - Evolution API Documentation",
"description": null,
"author": null,
"keywords": null,
"languageCode": "en",
"openGraph": [
{
"property": "og:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Updates&logoLight=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover.png&logoDark=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover-white.png&primaryColor=%2349BC94
&lightColor=%2349BC94&darkColor=%2349BC94"
},
{
"property": "og:image:width",
"content": "1200"
},
{
"property": "og:image:height",
"content": "630"
},
{
"property": "twitter:image",
"content": "https://mintlify.com/docs/api/og?
169
division=Documentation&title=Updates&logoLight=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover.png&logoDark=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover-white.png&primaryColor=%2349BC94
&lightColor=%2349BC94&darkColor=%2349BC94"
},
{
"property": "twitter:image:width",
"content": "1200"
},
{
"property": "twitter:image:height",
"content": "630"
}
],
"jsonLd": null,
"headers": {
"age": "607",
"cache-control": "public, max-age=0, must-revalidate",
"content-encoding": "br",
"content-type": "text/html; charset=utf-8",
"date": "Wed, 05 Mar 2025 23:38:13 GMT",
"etag": "W/\"g0an8c1tqz4xnk\"",
"server": "Vercel",
"strict-transport-security": "max-age=63072000",
"x-frame-options": "DENY",
"x-matched-path": "/_sites/[subdomain]/[[...slug]]",
"x-powered-by": "Next.js",
"x-vercel-cache": "HIT",
"x-vercel-id":
"iad1::iad1::57hb2-1741218500948-8176189add55",
"transfer-encoding": "chunked"
}
},
"screenshotUrl": null,
"text": "Updates - Evolution API Documentation\nKeeping your
Evolution API instance up to date is crucial for security,
performance, and access to new features. The update method
depends on how you initially installed the API. This guide
covers the steps to update your Evolution API using Docker
Compose and NPM.\nUpdating with Docker\nIf you initially set
up your Evolution API using Docker, follow these steps to
update:\nUpdating with Docker CLI\nIf your Evolution API was
initially installed using Docker Compose via the command line
interface (CLI) and not through Portainer or any other
container management tool, follow these steps to update it:
\nNavigate to the Docker Compose Directory: Open a terminal
and go to the directory where your Docker Compose file
(docker-compose.yml) is located.\nPull the Latest Image:
Update the Evolution API image to the latest version by
running the following command:\nStop and Restart the
Containers: After pulling the latest image, stop the current
containers and restart them. This can be done using the
following command:\nUpdating with Portainer\nIf you are using
Portainer for container management, follow these steps to
update your Evolution API:\nAccess the Portainer Dashboard:
170
Open your Portainer dashboard in a web browser.\nNavigate to
Your Containers: Go to the ‘Stacks’ section where your
Evolution API container is listed.\nUpdate the Compose File:
\nLocate the image field in your Docker Compose configuration.
\nUpdate the value to atendai/evolution-api:latest for the
latest version, or use atendai/evolutionapi:v1.x.x for a
specific version.\nAfter making the changes, click the â
€˜Deploy’ button at the bottom of the compose editing
window.\nVerify the Update: After recreating the container,
verify that the Evolution API is running on the latest
version. This can usually be checked via the API version
endpoint or logs.\nUpdating with NPM\nUpdating your Evolution
API installation via NPM involves several steps to ensure a
smooth transition to the new version. Here is a step-by-step
guide:\nClean and Stop: Clean all PM2 logs, useful for
troubleshooting after the update, and temporarily stop the
Evolution API to apply updates safely.\nReset the Local
Repository and Pull the Latest Updates: Ensure your local
codebase is synchronized with the latest commit and pull the
latest updates from the repository. Optionally, switch to a
specific version if not using the latest. This is recommended
for production environments.\nClean Installation: Remove the
current node_modules directory to avoid potential conflicts
with new dependencies and install the required Node.js
dependencies for the updated version.",
"markdown": "# Updates - Evolution API Documentation\n
\nKeeping your Evolution API instance up to date is crucial
for security, performance, and access to new features. The
update method depends on how you initially installed the API.
This guide covers the steps to update your Evolution API using
Docker Compose and NPM.\n\n## Updating with Docker\n\nIf you
initially set up your Evolution API using Docker, follow these
steps to update:\n\n### Updating with Docker CLI\n\nIf your
Evolution API was initially installed using Docker Compose via
the command line interface (CLI) and not through Portainer or
any other container management tool, follow these steps to
update it:\n\n1. **Navigate to the Docker Compose
Directory**: Open a terminal and go to the directory where
your Docker Compose file (`docker-compose.yml`) is located.\n
\n2. **Pull the Latest Image**: Update the Evolution API
image to the latest version by running the following command:
\n \n\n3. **Stop and Restart the Containers**: After
pulling the latest image, stop the current containers and
restart them. This can be done using the following command:\n
\n### Updating with Portainer\n\nIf you are using Portainer
for container management, follow these steps to update your
Evolution API:\n\n1. **Access the Portainer Dashboard**: Open
your Portainer dashboard in a web browser.\n \n2.
**Navigate to Your Containers**: Go to the ‘Stacks’
section where your Evolution API container is listed.\n
\n3. **Update the Compose File**:\n \n * Locate the
`image` field in your Docker Compose configuration.\n\n*
Update the value to `atendai/evolution-api:latest` for the
latest version, or use `atendai/evolutionapi:v1.x.x` for a
specific version.\n* After making the changes, click the â
€˜Deploy’ button at the bottom of the compose editing
window.\n\n4. **Verify the Update**: After recreating the
171
container, verify that the Evolution API is running on the
latest version. This can usually be checked via the API
version endpoint or logs.\n\n## Updating with NPM\n\nUpdating
your Evolution API installation via NPM involves several steps
to ensure a smooth transition to the new version. Here is a
step-by-step guide:\n\n1. **Clean and Stop**: Clean all PM2
logs, useful for troubleshooting after the update, and
temporarily stop the Evolution API to apply updates safely.\n
\n2. **Reset the Local Repository and Pull the Latest
Updates**: Ensure your local codebase is synchronized with the
latest commit and pull the latest updates from the repository.
Optionally, switch to a specific version if not using the
latest. This is recommended for production environments.\n\n3.
**Clean Installation**: Remove the current `node_modules`
directory to avoid potential conflicts with new dependencies
and install the required Node.js dependencies for the updated
version.",
"debug": {
"requestHandlerMode": "http"
}
},
{
"url": "https://doc.evolution-api.com/v1/pt/install/nvm",
"crawl": {
"loadedUrl": "https://doc.evolution-
api.com/v1/pt/install/nvm",
"loadedTime": "2025-03-05T23:48:21.153Z"
},
"metadata": {
"canonicalUrl": "https://doc.evolution-
api.com/v1/pt/install/nvm",
"title": "NVM - Evolution API Documentation",
"description": null,
"author": null,
"keywords": null,
"languageCode": "en",
"openGraph": [
{
"property": "og:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=NVM&logoLight=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover.png&logoDark=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover-white.png&primaryColor=%2349BC94
&lightColor=%2349BC94&darkColor=%2349BC94"
},
{
"property": "og:image:width",
"content": "1200"
},
{
"property": "og:image:height",
"content": "630"
},
{
"property": "twitter:image",
172
 "content": "https://mintlify.com/docs/api/og?
division=Documentation&title=NVM&logoLight=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover.png&logoDark=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover-white.png&primaryColor=%2349BC94
&lightColor=%2349BC94&darkColor=%2349BC94"
},
{
"property": "twitter:image:width",
"content": "1200"
},
{
"property": "twitter:image:height",
"content": "630"
}
],
"jsonLd": null,
"headers": {
"age": "417",
"cache-control": "public, max-age=0, must-revalidate",
"content-encoding": "br",
"content-type": "text/html; charset=utf-8",
"date": "Wed, 05 Mar 2025 23:41:22 GMT",
"etag": "W/\"wfdrbxqzp7f06\"",
"server": "Vercel",
"strict-transport-security": "max-age=63072000",
"x-frame-options": "DENY",
"x-matched-path": "/_sites/[subdomain]/[[...slug]]",
"x-powered-by": "Next.js",
"x-vercel-cache": "HIT",
"x-vercel-id":
"iad1::iad1::6tqph-1741218500948-33ab8c1ad9ed",
"transfer-encoding": "chunked"
}
},
"screenshotUrl": null,
"text": "NVM - Evolution API Documentation\nEvolution API
pode ser facilmente instalado usando o Node Version Manager
(NVM). Siga estas etapas para configurar seu ambiente e
iniciar a Evolution API em seu servidor.\nInstalar NVM
\nPrimeiro, baixe e instale o Node.js. Você pode fazer isso
executando os seguintes comandos:\nAgora apenas aponte os
diretórios do NVM e instale o node:\nConfirme que o NVM foi
instalado com sucesso:\nClone o repositório oficial do Github
para seu servidor privado.\nEm seguida, acesse a pasta onde o
projeto está\nAgora vamos copiar o arquivo env.yml com as
configurações que você precisa editar.\nEste comando cria
uma cópia do arquivo de ambiente padrão.\nA seguir, abra o
arquivo env.yml em um editor de texto para inserir suas
configurações de configuração. Você pode usar o nano, um
editor de texto da linha de comando, para este propósito:\nNo
editor nano, navegue pelo arquivo e substitua os valores padrÃ
£o pelas suas configurações especÃficas. Isso pode incluir
strings de conexão de banco de dados, chaves de API, portas
do servidor, etc.\nPara iniciar a Evolution API, use o
seguinte comando:\nInstalar e Configurar o PM2\nUse o PM2 para
173
instalar o PM2 e iniciar o gerenciador para o processo da API:
\nSe você quiser ter certeza de que a API está em execuçÃ
£o, basta usar seu navegador para acessar
http://localhost:8080. Esta deve ser a resposta do seu
navegador:\nA EvolutionAPI possui uma documentação de ponto
de extremidade Swagger integrada, que você pode usar para ver
todos os pontos de extremidade possÃveis e testar as
solicitações acessando http://localhost:8080/docs.
\nConfiguração do Nginx\nPrimeiro, vamos instalar, iniciar,
habilitar e testar o serviço Nginx em seu servidor privado.
\nSe a informação “Ativo: ativo (em execução)â€
aparecer em verde, significa que o Nginx está em execução e
você pode prosseguir para a próxima etapa.\nRemover
Configuração Padrão do Nginx\nPrimeiro, remova o arquivo do
site padrão que vem habilitado com o Nginx:\nCriar um novo
arquivo de bloco do servidor no diretório\nEm seguida, cole a
configuração do Nginx no arquivo default.conf:
\n/etc/nginx/conf.d/default.conf\nApós fazer alterações nas
configurações do Nginx, é essencial recarregar o serviço
Nginx. Isso garante que quaisquer modificações que você fez
sejam aplicadas e se tornem eficazes.\nExecute o seguinte
comando no terminal para recarregar o Nginx:\nFaça o usuário
nginx ser o proprietário do diretório da web, por padrão,
ele é de propriedade do usuário root:\nAgora, crie um
Virtual Host apontando para seu subdomÃnio editando o arquivo
api:\nEm seguida, cole a configuração do Nginx no arquivo
api:\n/etc/nginx/sites-available/api\nCrie um link simbólico
entre os arquivos api e sites-enabled:\nEm seguida, valide a
configuração do Nginx para o subdomÃnio:\nRecarregue o Nginx
para que as alterações se tornem efetivas.\nInstalar o
Certbot para o Certificado SSL\nPara proteger sua Evolution
API com um certificado SSL, você pode usar o Certbot. Instale
o Certbot usando o seguinte comando:\nCertificar o subdomÃnio
da API\nSerá perguntado se você deseja inserir um email para
receber notificações quando o certificado gerado estiver
perto da data de expiração.",
"markdown": "# NVM - Evolution API Documentation\n
\nEvolution API pode ser facilmente instalado usando o Node
Version Manager (NVM). Siga estas etapas para configurar seu
ambiente e iniciar a Evolution API em seu servidor.\n\n##
Instalar NVM\n\nPrimeiro, baixe e instale o Node.js. Você
pode fazer isso executando os seguintes comandos:\n\nAgora
apenas aponte os diretórios do NVM e instale o node:\n
\nConfirme que o NVM foi instalado com sucesso:\n\nClone o
repositório oficial do Github para seu servidor privado.\n
\nEm seguida, acesse a pasta onde o projeto está\n\nAgora
vamos copiar o arquivo `env.yml` com as configurações que
você precisa editar.\n\nEste comando cria uma cópia do
arquivo de ambiente padrão.\n\nA seguir, abra o arquivo
env.yml em um editor de texto para inserir suas
configurações de configuração. Você pode usar o nano, um
editor de texto da linha de comando, para este propósito:\n
\nNo editor nano, navegue pelo arquivo e substitua os valores
padrão pelas suas configurações especÃficas. Isso pode
incluir strings de conexão de banco de dados, chaves de API,
portas do servidor, etc.\n\nPara iniciar a Evolution API, use
o seguinte comando:\n\n## Instalar e Configurar o PM2\n\nUse o
174
PM2 para instalar o PM2 e iniciar o gerenciador para o
processo da API:\n\nSe você quiser ter certeza de que a API
está em execução, basta usar seu navegador para acessar
[http://localhost:8080](http://localhost:8080/). Esta deve ser
a resposta do seu navegador:\n\nA EvolutionAPI possui uma
documentação de ponto de extremidade Swagger integrada, que
você pode usar para ver todos os pontos de extremidade possÃ-
veis e testar as solicitações acessando
`http://localhost:8080/docs`.\n\n## Configuração do Nginx\n
\nPrimeiro, vamos instalar, iniciar, habilitar e testar o
serviço Nginx em seu servidor privado.\n\nSe a informação â
€œAtivo: ativo (em execução)†aparecer em verde, significa
que o Nginx está em execução e você pode prosseguir para a
próxima etapa.\n\n### Remover Configuração Padrão do Nginx
\n\nPrimeiro, remova o arquivo do site padrão que vem
habilitado com o Nginx:\n\n### Criar um novo arquivo de bloco
do servidor no diretório\n\nEm seguida, cole a configuração
do Nginx no arquivo `default.conf`:\n
\n/etc/nginx/conf.d/default.conf\n\nApós fazer alterações
nas configurações do Nginx, é essencial recarregar o
serviço Nginx. Isso garante que quaisquer modificações que
você fez sejam aplicadas e se tornem eficazes.\n\nExecute o
seguinte comando no terminal para recarregar o Nginx:\n\nFaça
o usuário nginx ser o proprietário do diretório da web, por
padrão, ele é de propriedade do usuário root:\n\nAgora,
crie um Virtual Host apontando para seu subdomÃnio editando o
arquivo `api`:\n\nEm seguida, cole a configuração do Nginx
no arquivo `api`:\n\n/etc/nginx/sites-available/api\n\nCrie um
link simbólico entre os arquivos `api` e `sites-enabled`:\n
\nEm seguida, valide a configuração do Nginx para o subdomÃ-
nio:\n\nRecarregue o Nginx para que as alterações se tornem
efetivas.\n\n## Instalar o Certbot para o Certificado SSL\n
\nPara proteger sua Evolution API com um certificado SSL,
você pode usar o Certbot. Instale o Certbot usando o seguinte
comando:\n\n### Certificar o subdomÃnio da API\n
\nSerá perguntado se você deseja inserir um email para
receber notificações quando o certificado gerado estiver
perto da data de expiração.",
"debug": {
"requestHandlerMode": "http"
}
},
{
"url": "https://doc.evolution-api.com/v1/pt/optional-
resources/rabbitmq",
"crawl": {
"loadedUrl": "https://doc.evolution-
api.com/v1/pt/optional-resources/rabbitmq",
"loadedTime": "2025-03-05T23:48:21.345Z"
},
"metadata": {
"canonicalUrl": "https://doc.evolution-
api.com/v1/pt/optional-resources/rabbitmq",
"title": "RabbitMQ - Evolution API Documentation",
"description": null,
"author": null,
"keywords": null,
175
 "languageCode": "en",
"openGraph": [
{
"property": "og:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=RabbitMQ&logoLight=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover.png&logoDark=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover-white.png&primaryColor=%2349BC94
&lightColor=%2349BC94&darkColor=%2349BC94"
},
{
"property": "og:image:width",
"content": "1200"
},
{
"property": "og:image:height",
"content": "630"
},
{
"property": "twitter:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=RabbitMQ&logoLight=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover.png&logoDark=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover-white.png&primaryColor=%2349BC94
&lightColor=%2349BC94&darkColor=%2349BC94"
},
{
"property": "twitter:image:width",
"content": "1200"
},
{
"property": "twitter:image:height",
"content": "630"
}
],
"jsonLd": null,
"headers": {
"age": "585",
"cache-control": "public, max-age=0, must-revalidate",
"content-encoding": "br",
"content-type": "text/html; charset=utf-8",
"date": "Wed, 05 Mar 2025 23:38:35 GMT",
"etag": "W/\"q7k8e1tisy4nyx\"",
"server": "Vercel",
"strict-transport-security": "max-age=63072000",
"x-frame-options": "DENY",
"x-matched-path": "/_sites/[subdomain]/[[...slug]]",
"x-powered-by": "Next.js",
"x-vercel-cache": "HIT",
"x-vercel-id":
"iad1::iad1::6tqph-1741218501260-8383229e5906",
"transfer-encoding": "chunked"
}
176
 },
"screenshotUrl": null,
"text": "RabbitMQ - Evolution API Documentation\nAtivando
RabbitMQ\nPara utilizar efetivamente o RabbitMQ com a
Evolution API para gerenciar instâncias do WhatsApp, é
essencial ativar o RabbitMQ em cada instância individual do
WhatsApp. \nEsta ativação permite que cada instância comece
a receber e processar solicitações de fila AMQP (Advanced
Message Queuing Protocol) especÃficas para essa instância do
WhatsApp.\nEm outras palavras, para cada instância do
WhatsApp onde você deseja usar o RabbitMQ, você precisa
garantir que a integração com o RabbitMQ esteja habilitada.
Essa configuração permitirá que a instância se comunique
com o servidor RabbitMQ e gerencie sua fila de mensagens e
solicitações. Habilitar o RabbitMQ em cada instância é
crucial para a distribuição e gestão adequadas das tarefas
de mensagens entre as diferentes instâncias do WhatsApp no
seu sistema.\nConfiguração do RabbitMQ para uma instância
individual\nPara desenvolvedores que desejam usar o sistema de
mensagens AMQP em suas aplicações, você pode usar o
RabbitMQ para enfileirar as ações das suas instâncias.
\nPara configurar o RabbitMQ para instâncias individuais do
WhatsApp na Evolution API, você pode usar o seguinte
endpoint:\nEste endpoint permite habilitar o RabbitMQ e
especificar quais eventos cada instância do WhatsApp deve
assinar na fila AMQP. Abaixo está um exemplo do corpo JSON
para este endpoint:\nAo configurar a integração com o
RabbitMQ, ajuste o array de eventos no corpo JSON para incluir
apenas os eventos aos quais você deseja assinar. Descomente
qualquer evento que você deseja habilitar para notificações
do RabbitMQ.\nAgora você pode enviar mensagens para sua
aplicação e consumi-las no RabbitMQ.\nConfira as variáveis
de ambiente do RabbitMQ aqui",
"markdown": "# RabbitMQ - Evolution API Documentation\n\n##
Ativando RabbitMQ\n\nPara utilizar efetivamente o **RabbitMQ**
com a **Evolution API** para gerenciar instâncias do
WhatsApp, é essencial **ativar o RabbitMQ** em cada **instâ
ncia individual** do WhatsApp. \nEsta ativação permite que
cada instância comece a receber e processar solicitações de
fila AMQP (Advanced Message Queuing Protocol) especÃficas para
essa instância do WhatsApp.\n\nEm outras palavras, para cada
instância do WhatsApp onde você deseja usar o RabbitMQ,
você precisa garantir que a integração com o RabbitMQ
esteja habilitada. Essa configuração permitirá que a instâ
ncia se comunique com o servidor RabbitMQ e gerencie sua fila
de mensagens e solicitações. Habilitar o RabbitMQ em cada
instância é crucial para a distribuição e gestão
adequadas das tarefas de mensagens entre as diferentes instâ
ncias do WhatsApp no seu sistema.\n\n## Configuração do
RabbitMQ para uma instância individual\n\nPara
**desenvolvedores** que desejam usar o sistema de mensagens
AMQP em suas aplicações, você pode usar o RabbitMQ para
enfileirar as ações das suas instâncias.\n\nPara configurar
o RabbitMQ para instâncias individuais do WhatsApp na
Evolution API, você pode usar o seguinte endpoint:\n\nEste
endpoint permite habilitar o RabbitMQ e especificar quais
eventos cada instância do WhatsApp deve assinar na fila AMQP.
177
Abaixo está um exemplo do corpo JSON para este endpoint:\n
\nAo configurar a integração com o RabbitMQ, ajuste o array
de eventos no corpo JSON para incluir apenas os eventos aos
quais você deseja assinar. Descomente qualquer evento que
você deseja habilitar para notificações do RabbitMQ.\n
\nAgora você pode enviar mensagens para sua aplicação e
consumi-las no RabbitMQ.\n\nConfira as variáveis de ambiente
do RabbitMQ [aqui](https://doc.evolution-
api.com/pt/env#rabbitmq)",
"debug": {
"requestHandlerMode": "http"
}
},
{
"url": "https://doc.evolution-api.com/v1/en/optional-
resources/redis",
"crawl": {
"loadedUrl": "https://doc.evolution-
api.com/v1/en/optional-resources/redis",
"loadedTime": "2025-03-05T23:48:18.278Z",
"httpStatusCode": 200
},
"metadata": {
"canonicalUrl": "https://doc.evolution-
api.com/v1/en/optional-resources/redis",
"title": "Redis - Evolution API Documentation",
"description": null,
"author": null,
"keywords": null,
"languageCode": "en",
"openGraph": [
{
"property": "og:image:width",
"content": "1200"
},
{
"property": "og:image:height",
"content": "630"
},
{
"property": "twitter:image:width",
"content": "1200"
},
{
"property": "twitter:image:height",
"content": "630"
},
{
"property": "og:image",
"content": "https://doc.evolution-api.com/api/og?
division=Documentation&title=Redis&logoLight=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover.png&logoDark=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover-white.png&primaryColor=%2349BC94
&lightColor=%2349BC94&darkColor=%2349BC94"
},
178
 {
"property": "twitter:image",
"content": "https://doc.evolution-api.com/api/og?
division=Documentation&title=Redis&logoLight=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover.png&logoDark=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover-white.png&primaryColor=%2349BC94
&lightColor=%2349BC94&darkColor=%2349BC94"
}
],
"jsonLd": null,
"headers": {
"age": "598",
"cache-control": "public, max-age=0, must-revalidate",
"content-encoding": "br",
"content-type": "text/html; charset=utf-8",
"date": "Wed, 05 Mar 2025 23:38:18 GMT",
"etag": "W/\"5alas0q68v439q\"",
"server": "Vercel",
"strict-transport-security": "max-age=63072000",
"x-frame-options": "DENY",
"x-matched-path": "/_sites/[subdomain]/[[...slug]]",
"x-powered-by": "Next.js",
"x-vercel-cache": "HIT",
"x-vercel-id":
"iad1::iad1::ww4vm-1741218497180-8eee0f757efb",
"x-firefox-spdy": "h2"
}
},
"screenshotUrl": null,
"text": "Redis - Evolution API Documentation\nSetup\nRedis
is an in-memory data structure store, used as a database,
cache, and message broker. It supports data structures such as
strings, hashes, lists, sets, and more. Incorporating Redis
can significantly improve the performance of Evolution API by
enabling faster data access and efficient caching.\nSet the
Redis environment variables in the .env for Docker or the dev-
env.yml for NPM file as follows:\nCheckout more on Environment
Variables.",
"markdown": "# Redis - Evolution API Documentation\n\n##
Setup\n\nRedis is an in-memory data structure store, used as a
database, cache, and message broker. It supports data
structures such as strings, hashes, lists, sets, and more.
Incorporating Redis can significantly improve the performance
of Evolution API by enabling faster data access and efficient
caching.\n\nSet the Redis environment variables in the `.env`
for Docker or the `dev-env.yml` for NPM file as follows:\n
\nCheckout more on [Environment Variables]
(https://doc.evolution-api.com/en/env#redis).",
"debug": {
"requestHandlerMode": "browser"
}
},
{
"url": "https://doc.evolution-api.com/v1/en/env",
"crawl": {
179
 "loadedUrl": "https://doc.evolution-api.com/v1/en/env",
"loadedTime": "2025-03-05T23:48:22.449Z",
"referrerUrl": "https://doc.evolution-api.com/v1/en/get-
started/introduction",
"depth": 1,
"httpStatusCode": 200
},
"metadata": {
"canonicalUrl": "https://doc.evolution-api.com/v1/en/env",
"title": "Environment Variables - Evolution API
Documentation",
"description": null,
"author": null,
"keywords": null,
"languageCode": "en",
"openGraph": [
{
"property": "og:image:width",
"content": "1200"
},
{
"property": "og:image:height",
"content": "630"
},
{
"property": "twitter:image:width",
"content": "1200"
},
{
"property": "twitter:image:height",
"content": "630"
},
{
"property": "og:image",
"content": "https://doc.evolution-api.com/api/og?
division=Documentation&title=Environment+Variables&logoLight=h
ttps%3A%2F%2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-
eb1f2775%2Fimages%2Fbrand%2Fcover.png&logoDark=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover-white.png&primaryColor=%2349BC94
&lightColor=%2349BC94&darkColor=%2349BC94"
},
{
"property": "twitter:image",
"content": "https://doc.evolution-api.com/api/og?
division=Documentation&title=Environment+Variables&logoLight=h
ttps%3A%2F%2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-
eb1f2775%2Fimages%2Fbrand%2Fcover.png&logoDark=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover-white.png&primaryColor=%2349BC94
&lightColor=%2349BC94&darkColor=%2349BC94"
}
],
"jsonLd": null,
"headers": {
"age": "607",
"cache-control": "public, max-age=0, must-revalidate",
180
 "content-encoding": "br",
"content-type": "text/html; charset=utf-8",
"date": "Wed, 05 Mar 2025 23:38:13 GMT",
"etag": "W/\"bdv1bulvrb6fqz\"",
"server": "Vercel",
"strict-transport-security": "max-age=63072000",
"x-frame-options": "DENY",
"x-matched-path": "/_sites/[subdomain]/[[...slug]]",
"x-powered-by": "Next.js",
"x-vercel-cache": "HIT",
"x-vercel-id":
"iad1::iad1::vppzl-1741218500955-1ca8d15729a8",
"x-firefox-spdy": "h2"
}
},
"screenshotUrl": null,
"text": "Environment Variables - Evolution API Documentation
\nSee the example env file in the official repository.
\nVariableDescriptionExample\nSERVER_URL\tThe address for your
running server. This address is used to return internal
request data, such as webhook links.
\thttps://example.evolution-api.com\t\nWEBSOCKET_ENABLED
\tEnable or disable WebSocket\ttrue\t\nWEBSOCKET_GLOBAL_EVENTS
\tEnable Websocket globally\ttrue\t
\nCONFIG_SESSION_PHONE_CLIENT\tName that will be displayed on
smartphone connection\tEvolutionAPI\t
\nCONFIG_SESSION_PHONE_NAME\tBrowser name that will be
displayed on smartphone connection\tChrome\t\nLogs
\nVariableDescriptionExample\nLOG_LEVEL\tLogs to be shown:
ERROR, WARN, DEBUG, INFO, LOG, VERBOSE, DARK, WEBHOOKS
\tERROR,WARN,DEBUG,INFO,LOG,VERBOSE,DARK,WEBHOOKS\t\nLOG_COLOR
\tShow colors in Logs (true or false)\ttrue\t\nLOG_BAILEYS
\tWhich Baileys logs to show: “fatal†, “error†, â
€œwarn†, “info†, “debug†, and “trace†\terror\t
\nTemporary Storage\nTemporary data storage. Values are true
or false to store or not.\nVariableDescription\nSTORE_MESSAGES
\tStore messages\t\nSTORE_MESSAGE_UP\tStore message updates\t
\nSTORE_CONTACTS\tStore contacts\t\nSTORE_CHATS\tStore chats\t
\nTemporary Storage Cleaning\nCleaning temporary storage.
\nVariableDescription\nCLEAN_STORE_CLEANING_INTERVAL\tCleaning
interval in seconds\t\nCLEAN_STORE_MESSAGES\tWhether to delete
messages (true or false)\t\nCLEAN_STORE_MESSAGE_UP\tWhether to
delete message updates (true or false)\t\nCLEAN_STORE_CONTACTS
\tWhether to delete contacts (true or false)\t
\nCLEAN_STORE_CHATS\tWhether to delete chats (true or false)\t
\nPersistent Storage\nConnection configurations:
\nVariableDescriptionExample\nDATABASE_ENABLED\tWhether
persistent storage is enabled\ttrue\t\nDATABASE_CONNECTION_URI
\tMongoDB connection URI
\tmongodb://username:password@host:port/database\t
\nDATABASE_CONNECTION_DB_PREFIX_NAME\tPrefix name for database
connection logs\terror\t\nWhich data to save (true or false):
\nVariableDescription\nDATABASE_SAVE_DATA_INSTANCE\tSave
instance data\t\nDATABASE_SAVE_DATA_NEW_MESSAGE\tSave new
messages\t\nDATABASE_SAVE_MESSAGE_UPDATE\tSave message updates
\t\nDATABASE_SAVE_DATA_CONTACTS\tSave contacts\t
\nDATABASE_SAVE_DATA_CHATS\tSave chats\t\nRedis
181
\nVariableDescriptionExample\nCACHE_REDIS_ENABLED\tWhether
Redis is enabled (true or false)\ttrue\t\nCACHE_REDIS_URI
\tRedis connection URI\tredis://redis:6379\t
\nCACHE_REDIS_PREFIX_KEY\tKey name prefix\tevolution\t
\nCACHE_REDIS_TTL\tTime to keep cached data in Redis\t604800\t
\nCACHE_REDIS_SAVE_INSTANCES\tSave WhatsApp connection
credentials on Redis\tfalse\t\nCACHE_LOCAL_ENABLED\tCache data
in memory (an alternative for Redis)\tfalse\t\nCACHE_LOCAL_TTL
\tTime to keep cached data in memory\t604800\t\nRabbitMQ
\nVariableDescriptionExample\nRABBITMQ_ENABLED\tEnables
RabbitMQ (true or false)\ttrue\t\nRABBITMQ_GLOBAL_ENABLED
\tEnables RabbitMQ globally (true or false)\tfalse\t
\nRABBITMQ_URI\tRabbitMQ connection URI
\tamqp://guest:guest@rabbitmq:5672\t\nRABBITMQ_EXCHANGE_NAME
\tExchange name\tevolution_exchange\t
\nRABBITMQ_EVENTS_APPLICATION_STARTUP\tSends an event on app
startup\tfalse\t\nRABBITMQ_EVENTS_QRCODE_UPDATED\tSends QR
Code Update events\ttrue\t\nRABBITMQ_EVENTS_MESSAGES_SET
\tSends Message Creation events (message retrieval)\ttrue\t
\nRABBITMQ_EVENTS_MESSAGES_UPSERT\tSends Message Receipt
events\ttrue\t\nRABBITMQ_EVENTS_MESSAGES_UPDATE\tSends Message
Update events\ttrue\t\nRABBITMQ_EVENTS_MESSAGES_DELETE\tSends
Message Deletion events\ttrue\t\nRABBITMQ_EVENTS_SEND_MESSAGE
\tSends Message Sending events\ttrue\t
\nRABBITMQ_EVENTS_CONTACTS_SET\tSends Contact Creation events
\ttrue\t\nRABBITMQ_EVENTS_CONTACTS_UPSERT\tSends Contact
Creation events (contact retrieval)\ttrue\t
\nRABBITMQ_EVENTS_CONTACTS_UPDATE\tSends Contact Update events
\ttrue\t\nRABBITMQ_EVENTS_PRESENCE_UPDATE\tSends Presence
Update events (“typing…†or “recording…“)\ttrue\t
\nRABBITMQ_EVENTS_CHATS_SET\tSends Chat Creation events (chat
retrieval)\ttrue\t\nRABBITMQ_EVENTS_CHATS_UPSERT\tSends Chat
Creation events (message receipt or sending in new
chats)\ttrue\t\nRABBITMQ_EVENTS_CHATS_UPDATE\tSends Chat
Update events\ttrue\t\nRABBITMQ_EVENTS_CHATS_DELETE\tSends
Chat Deletion events\ttrue\t\nRABBITMQ_EVENTS_GROUPS_UPSERT
\tSends Group Creation events\ttrue\t
\nRABBITMQ_EVENTS_GROUPS_UPDATE\tSends Group Update events
\ttrue\t\nRABBITMQ_EVENTS_GROUP_PARTICIPANTS_UPDATE\tSends
Group Participant Update events\ttrue\t
\nRABBITMQ_EVENTS_CONNECTION_UPDATE\tSends Connection Update
events\ttrue\t\nRABBITMQ_EVENTS_LABELS_EDIT\tSends Label Edit
events\ttrue\t\nRABBITMQ_EVENTS_LABELS_ASSOCIATION\tSends
Label Association events\ttrue\t\nRABBITMQ_EVENTS_CALL\tSends
Call events\ttrue\t\nRABBITMQ_EVENTS_TYPEBOT_START\tSends
Typebot flow start events\tfalse\t
\nRABBITMQ_EVENTS_TYPEBOT_CHANGE_STATUS\tSends Typebot status
update events\tfalse\t\nSQS\nVariableDescription\nSQS_ENABLED
\tWhether SQS is enabled (true or false)\t\nSQS_ACCESS_KEY_ID
\tSQS access key ID\t\nSQS_SECRET_ACCESS_KEY\tSQS access key\t
\nSQS_ACCOUNT_ID\tAccount ID\t\nSQS_REGION\tSQS region\t
\nInstances\nVariableDescriptionExample\nDEL_INSTANCE\tIn how
many minutes an instance will be deleted if not connected. Use
“false†to never delete.\t5\t\nDEL_TEMP_INSTANCES\tDelete
closed instances on startup\ttrue\t\nCORS
\nVariableDescriptionExample\nCORS_ORIGIN\tAllowed origins for
the API, separated by commas (use †*†to accept requests
182
from any origin).\thttps://my-frontend.com,https://my-other-
frontend.com\t\nCORS_METHODS\tAllowed HTTP methods, separated
by commas.\tPOST,GET,PUT,DELETE\t\nCORS_CREDENTIALS\tAllow
cookies in requests (true or false).\ttrue\t\nWebhook
\nVariableDescription\nWEBHOOK_GLOBAL_URL\tURL to receive
webhook requests\t\nWEBHOOK_GLOBAL_ENABLED\tWhether webhooks
are enabled (true or false)\t
\nWEBHOOK_GLOBAL_WEBHOOK_BY_EVENTS\tEnable specific webhook
events\t\nWebhook events with true or false values:\nVariable
\nWEBHOOK_EVENTS_APPLICATION_STARTUP\t
\nWEBHOOK_EVENTS_QRCODE_UPDATED\t\nWEBHOOK_EVENTS_MESSAGES_SET
\t\nWEBHOOK_EVENTS_MESSAGES_UPSERT\t
\nWEBHOOK_EVENTS_MESSAGES_UPDATE\t
\nWEBHOOK_EVENTS_MESSAGES_DELETE\t
\nWEBHOOK_EVENTS_SEND_MESSAGE\t\nWEBHOOK_EVENTS_CONTACTS_SET\t
\nWEBHOOK_EVENTS_CONTACTS_UPSERT\t
\nWEBHOOK_EVENTS_CONTACTS_UPDATE\t
\nWEBHOOK_EVENTS_PRESENCE_UPDATE\t\nWEBHOOK_EVENTS_CHATS_SET\t
\nWEBHOOK_EVENTS_CHATS_UPSERT\t\nWEBHOOK_EVENTS_CHATS_UPDATE\t
\nWEBHOOK_EVENTS_CHATS_DELETE\t\nWEBHOOK_EVENTS_GROUPS_UPSERT
\t\nWEBHOOK_EVENTS_GROUPS_UPDATE\t
\nWEBHOOK_EVENTS_GROUP_PARTICIPANTS_UPDATE\t
\nWEBHOOK_EVENTS_CONNECTION_UPDATE\t
\nWEBHOOK_EVENTS_LABELS_EDIT\t
\nWEBHOOK_EVENTS_LABELS_ASSOCIATION\t\nWEBHOOK_EVENTS_CALL\t
\nWEBHOOK_EVENTS_NEW_JWT_TOKEN\t\nWEBHOOK_EVENTS_TYPEBOT_START
\t\nWEBHOOK_EVENTS_TYPEBOT_CHANGE_STATUS\t
\nWEBHOOK_EVENTS_CHAMA_AI_ACTION\t\nWEBHOOK_EVENTS_ERRORS\t
\nWEBHOOK_EVENTS_ERRORS_WEBHOOK\t\nQR Code
\nVariableDescription\nQRCODE_LIMIT\tDuration for which the QR
code will last\t\nQRCODE_COLOR\tColor of the generated QR code
\t\nTypebot\nVariableDescription\nTYPEBOT_API_VERSION\tAPI
version (fixed version or latest)\t\nTYPEBOT_KEEP_OPEN\tKeep
Typebot open (true or false)\t\nAuthentication
\nVariableDescription\nAUTHENTICATION_TYPE\tAuthentication
type (jwt or apikey)\t\nAUTHENTICATION_API_KEY\tAPI key to be
used for authentication\t
\nAUTHENTICATION_EXPOSE_IN_FETCH_INSTANCES\t\t
\nAUTHENTICATION_JWT_EXPIRIN_IN\tJWT token expiration time\t
\nAUTHENTICATION_JWT_SECRET\tSecret used to generate the JWT",
"markdown": "# Environment Variables - Evolution API
Documentation\n\nSee the example env file in the [official
repository](https://github.com/EvolutionAPI/evolution-
api/blob/main/Docker/.env.example).\n\n| Variable |
Description | Example |\n| --- | --- | --- |\n| `SERVER_URL` |
The address for your running server. This address is used to
return internal request data, such as webhook links. |
[https://example.evolution-api.com](https://example.evolution-
api.com/) |\n| `WEBSOCKET_ENABLED` | Enable or disable
WebSocket | true |\n| `WEBSOCKET_GLOBAL_EVENTS` | Enable
Websocket globally | true |\n| `CONFIG_SESSION_PHONE_CLIENT` |
Name that will be displayed on smartphone connection |
EvolutionAPI |\n| `CONFIG_SESSION_PHONE_NAME` | Browser name
that will be displayed on smartphone connection | Chrome |\n
\n## Logs\n\n| Variable | Description | Example |\n| --- | ---
| --- |\n| `LOG_LEVEL` | Logs to be shown: ERROR, WARN, DEBUG,
INFO, LOG, VERBOSE, DARK, WEBHOOKS |
183
ERROR,WARN,DEBUG,INFO,LOG,VERBOSE,DARK,WEBHOOKS |\n|
`LOG_COLOR` | Show colors in Logs (true or false) | true |\n|
`LOG_BAILEYS` | Which Baileys logs to show: “fatal†, â
€œerror†, “warn†, “info†, “debug†, and “traceâ
€ | error |\n\n## Temporary Storage\n\nTemporary data
storage. Values are `true` or `false` to store or not.\n\n|
Variable | Description |\n| --- | --- |\n| `STORE_MESSAGES` |
Store messages |\n| `STORE_MESSAGE_UP` | Store message updates
|\n| `STORE_CONTACTS` | Store contacts |\n| `STORE_CHATS` |
Store chats |\n\n## Temporary Storage Cleaning\n\nCleaning
temporary storage.\n\n| Variable | Description |\n| --- | ---
|\n| `CLEAN_STORE_CLEANING_INTERVAL` | Cleaning interval in
seconds |\n| `CLEAN_STORE_MESSAGES` | Whether to delete
messages (true or false) |\n| `CLEAN_STORE_MESSAGE_UP` |
Whether to delete message updates (true or false) |\n|
`CLEAN_STORE_CONTACTS` | Whether to delete contacts (true or
false) |\n| `CLEAN_STORE_CHATS` | Whether to delete chats
(true or false) |\n\n## Persistent Storage\n\nConnection
configurations:\n\n| Variable | Description | Example |\n| ---
| --- | --- |\n| `DATABASE_ENABLED` | Whether persistent
storage is enabled | true |\n| `DATABASE_CONNECTION_URI` |
MongoDB connection URI |
mongodb://username:password@host:port/database |\n|
`DATABASE_CONNECTION_DB_PREFIX_NAME` | Prefix name for
database connection logs | error |\n\nWhich data to save (true
or false):\n\n| Variable | Description |\n| --- | --- |\n|
`DATABASE_SAVE_DATA_INSTANCE` | Save instance data |\n|
`DATABASE_SAVE_DATA_NEW_MESSAGE` | Save new messages |\n|
`DATABASE_SAVE_MESSAGE_UPDATE` | Save message updates |\n|
`DATABASE_SAVE_DATA_CONTACTS` | Save contacts |\n|
`DATABASE_SAVE_DATA_CHATS` | Save chats |\n\n## Redis\n\n|
Variable | Description | Example |\n| --- | --- | --- |\n|
`CACHE_REDIS_ENABLED` | Whether Redis is enabled (true or
false) | true |\n| `CACHE_REDIS_URI` | Redis connection URI |
redis://redis:6379 |\n| `CACHE_REDIS_PREFIX_KEY` | Key name
prefix | evolution |\n| `CACHE_REDIS_TTL` | Time to keep
cached data in Redis | 604800 |\n|
`CACHE_REDIS_SAVE_INSTANCES` | Save WhatsApp connection
credentials on Redis | false |\n| `CACHE_LOCAL_ENABLED` |
Cache data in memory (an alternative for Redis) | false |\n|
`CACHE_LOCAL_TTL` | Time to keep cached data in memory |
604800 |\n\n## RabbitMQ\n\n| Variable | Description | Example
|\n| --- | --- | --- |\n| `RABBITMQ_ENABLED` | Enables
RabbitMQ (true or false) | true |\n| `RABBITMQ_GLOBAL_ENABLED`
| Enables RabbitMQ globally (true or false) | false |\n|
`RABBITMQ_URI` | RabbitMQ connection URI |
amqp://guest:guest@rabbitmq:5672 |\n| `RABBITMQ_EXCHANGE_NAME`
| Exchange name | evolution\\_exchange |\n|
`RABBITMQ_EVENTS_APPLICATION_STARTUP` | Sends an event on app
startup | false |\n| `RABBITMQ_EVENTS_QRCODE_UPDATED` | Sends
QR Code Update events | true |\n|
`RABBITMQ_EVENTS_MESSAGES_SET` | Sends Message Creation events
(message retrieval) | true |\n|
`RABBITMQ_EVENTS_MESSAGES_UPSERT` | Sends Message Receipt
events | true |\n| `RABBITMQ_EVENTS_MESSAGES_UPDATE` | Sends
Message Update events | true |\n|
`RABBITMQ_EVENTS_MESSAGES_DELETE` | Sends Message Deletion
184
events | true |\n| `RABBITMQ_EVENTS_SEND_MESSAGE` | Sends
Message Sending events | true |\n|
`RABBITMQ_EVENTS_CONTACTS_SET` | Sends Contact Creation events
| true |\n| `RABBITMQ_EVENTS_CONTACTS_UPSERT` | Sends Contact
Creation events (contact retrieval) | true |\n|
`RABBITMQ_EVENTS_CONTACTS_UPDATE` | Sends Contact Update
events | true |\n| `RABBITMQ_EVENTS_PRESENCE_UPDATE` | Sends
Presence Update events (“typing…†or “recording…“)
| true |\n| `RABBITMQ_EVENTS_CHATS_SET` | Sends Chat Creation
events (chat retrieval) | true |\n|
`RABBITMQ_EVENTS_CHATS_UPSERT` | Sends Chat Creation events
(message receipt or sending in new chats) | true |\n|
`RABBITMQ_EVENTS_CHATS_UPDATE` | Sends Chat Update events |
true |\n| `RABBITMQ_EVENTS_CHATS_DELETE` | Sends Chat Deletion
events | true |\n| `RABBITMQ_EVENTS_GROUPS_UPSERT` | Sends
Group Creation events | true |\n|
`RABBITMQ_EVENTS_GROUPS_UPDATE` | Sends Group Update events |
true |\n| `RABBITMQ_EVENTS_GROUP_PARTICIPANTS_UPDATE` | Sends
Group Participant Update events | true |\n|
`RABBITMQ_EVENTS_CONNECTION_UPDATE` | Sends Connection Update
events | true |\n| `RABBITMQ_EVENTS_LABELS_EDIT` | Sends Label
Edit events | true |\n| `RABBITMQ_EVENTS_LABELS_ASSOCIATION` |
Sends Label Association events | true |\n|
`RABBITMQ_EVENTS_CALL` | Sends Call events | true |\n|
`RABBITMQ_EVENTS_TYPEBOT_START` | Sends Typebot flow start
events | false |\n| `RABBITMQ_EVENTS_TYPEBOT_CHANGE_STATUS` |
Sends Typebot status update events | false |\n\n## SQS\n\n|
Variable | Description |\n| --- | --- |\n| `SQS_ENABLED` |
Whether SQS is enabled (true or false) |\n|
`SQS_ACCESS_KEY_ID` | SQS access key ID |\n|
`SQS_SECRET_ACCESS_KEY` | SQS access key |\n| `SQS_ACCOUNT_ID`
| Account ID |\n| `SQS_REGION` | SQS region |\n\n## Instances
\n\n| Variable | Description | Example |\n| --- | --- | --- |
\n| `DEL_INSTANCE` | In how many minutes an instance will be
deleted if not connected. Use “false†to never delete. | 5
|\n| `DEL_TEMP_INSTANCES` | Delete closed instances on startup
| true |\n\n## CORS\n\n| Variable | Description | Example |
\n| --- | --- | --- |\n| `CORS_ORIGIN` | Allowed origins for
the API, separated by commas (use †\\*†to accept requests
from any origin). | [https://my-frontend.com,https://my-other-
frontend.com](https://my-frontend.com,https//my-other-
frontend.com) |\n| `CORS_METHODS` | Allowed HTTP methods,
separated by commas. | POST,GET,PUT,DELETE |\n|
`CORS_CREDENTIALS` | Allow cookies in requests (true or
false). | true |\n\n## Webhook\n\n| Variable | Description |
\n| --- | --- |\n| `WEBHOOK_GLOBAL_URL` | URL to receive
webhook requests |\n| `WEBHOOK_GLOBAL_ENABLED` | Whether
webhooks are enabled (true or false) |\n|
`WEBHOOK_GLOBAL_WEBHOOK_BY_EVENTS` | Enable specific webhook
events |\n\nWebhook events with true or false values:\n\n|
Variable |\n| --- |\n| `WEBHOOK_EVENTS_APPLICATION_STARTUP` |
\n| `WEBHOOK_EVENTS_QRCODE_UPDATED` |\n|
`WEBHOOK_EVENTS_MESSAGES_SET` |\n|
`WEBHOOK_EVENTS_MESSAGES_UPSERT` |\n|
`WEBHOOK_EVENTS_MESSAGES_UPDATE` |\n|
`WEBHOOK_EVENTS_MESSAGES_DELETE` |\n|
`WEBHOOK_EVENTS_SEND_MESSAGE` |\n|
185
`WEBHOOK_EVENTS_CONTACTS_SET` |\n|
`WEBHOOK_EVENTS_CONTACTS_UPSERT` |\n|
`WEBHOOK_EVENTS_CONTACTS_UPDATE` |\n|
`WEBHOOK_EVENTS_PRESENCE_UPDATE` |\n|
`WEBHOOK_EVENTS_CHATS_SET` |\n| `WEBHOOK_EVENTS_CHATS_UPSERT`
|\n| `WEBHOOK_EVENTS_CHATS_UPDATE` |\n|
`WEBHOOK_EVENTS_CHATS_DELETE` |\n|
`WEBHOOK_EVENTS_GROUPS_UPSERT` |\n|
`WEBHOOK_EVENTS_GROUPS_UPDATE` |\n|
`WEBHOOK_EVENTS_GROUP_PARTICIPANTS_UPDATE` |\n|
`WEBHOOK_EVENTS_CONNECTION_UPDATE` |\n|
`WEBHOOK_EVENTS_LABELS_EDIT` |\n|
`WEBHOOK_EVENTS_LABELS_ASSOCIATION` |\n| `WEBHOOK_EVENTS_CALL`
|\n| `WEBHOOK_EVENTS_NEW_JWT_TOKEN` |\n|
`WEBHOOK_EVENTS_TYPEBOT_START` |\n|
`WEBHOOK_EVENTS_TYPEBOT_CHANGE_STATUS` |\n|
`WEBHOOK_EVENTS_CHAMA_AI_ACTION` |\n| `WEBHOOK_EVENTS_ERRORS`
|\n| `WEBHOOK_EVENTS_ERRORS_WEBHOOK` |\n\n## QR Code\n\n|
Variable | Description |\n| --- | --- |\n| `QRCODE_LIMIT` |
Duration for which the QR code will last |\n| `QRCODE_COLOR` |
Color of the generated QR code |\n\n## Typebot\n\n| Variable |
Description |\n| --- | --- |\n| `TYPEBOT_API_VERSION` | API
version (fixed version or latest) |\n| `TYPEBOT_KEEP_OPEN` |
Keep Typebot open (true or false) |\n\n## Authentication\n\n|
Variable | Description |\n| --- | --- |\n|
`AUTHENTICATION_TYPE` | Authentication type (`jwt` or
`apikey`) |\n| `AUTHENTICATION_API_KEY` | API key to be used
for authentication |\n|
`AUTHENTICATION_EXPOSE_IN_FETCH_INSTANCES` | |\n|
`AUTHENTICATION_JWT_EXPIRIN_IN` | JWT token expiration time |
\n| `AUTHENTICATION_JWT_SECRET` | Secret used to generate the
JWT |",
"debug": {
"requestHandlerMode": "browser"
}
},
{
"url": "https://doc.evolution-api.com/v1/pt/optional-
resources/mongo-db",
"crawl": {
"loadedUrl": "https://doc.evolution-
api.com/v1/pt/optional-resources/mongo-db",
"loadedTime": "2025-03-05T23:48:26.303Z"
},
"metadata": {
"canonicalUrl": "https://doc.evolution-
api.com/v1/pt/optional-resources/mongo-db",
"title": "MongoDB - Evolution API Documentation",
"description": null,
"author": null,
"keywords": null,
"languageCode": "en",
"openGraph": [
{
"property": "og:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=MongoDB&logoLight=https%3A%2F%
186
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover.png&logoDark=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover-white.png&primaryColor=%2349BC94
&lightColor=%2349BC94&darkColor=%2349BC94"
},
{
"property": "og:image:width",
"content": "1200"
},
{
"property": "og:image:height",
"content": "630"
},
{
"property": "twitter:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=MongoDB&logoLight=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover.png&logoDark=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover-white.png&primaryColor=%2349BC94
&lightColor=%2349BC94&darkColor=%2349BC94"
},
{
"property": "twitter:image:width",
"content": "1200"
},
{
"property": "twitter:image:height",
"content": "630"
}
],
"jsonLd": null,
"headers": {
"age": "590",
"cache-control": "public, max-age=0, must-revalidate",
"content-encoding": "br",
"content-type": "text/html; charset=utf-8",
"date": "Wed, 05 Mar 2025 23:38:35 GMT",
"etag": "W/\"p6p7q88tun4k17\"",
"server": "Vercel",
"strict-transport-security": "max-age=63072000",
"x-frame-options": "DENY",
"x-matched-path": "/_sites/[subdomain]/[[...slug]]",
"x-powered-by": "Next.js",
"x-vercel-cache": "HIT",
"x-vercel-id":
"iad1::iad1::c44p5-1741218506256-623c3be893eb",
"transfer-encoding": "chunked"
}
},
"screenshotUrl": null,
"text": "MongoDB - Evolution API Documentation\nSetup
\nMongoDB, um banco de dados NoSQL, é conhecido por seu alto
desempenho e escalabilidade. Ele é ideal para lidar com altos
volumes de dados na EvolutionAPI.\nDefina as variáveis de
187
ambiente do MongoDB no arquivo .env para Docker ou o dev-
env.yml para NPM da seguinte forma:\nMigração de dados
\nAlternar entre o armazenamento local para o MongoDB não
transfere automaticamente suas instâncias do WhatsApp que
estão atualmente sincronizadas com o local storage original.
\nClaro, aqui está a tradução da documentação para o
português:\nMigre seus dados no NPM ou NVM\nPare a execução
do PM2:\nFlush e Stop: Limpa todos os logs do PM2, útil para
solução de problemas após a atualização e para parar
temporariamente a Evolution API para aplicar atualizações
com segurança.\nDiretório da Evolution API: acesse o
diretório de instalação com o seguinte comando:\nComando de
migração: Execute o comando de migração no diretório de
instalação:\nSiga os passos do script e migre instâncias
especÃficas do WhatsApp ou todas as suas instâncias.",
"markdown": "# MongoDB - Evolution API Documentation\n\n##
Setup\n\nMongoDB, um banco de dados NoSQL, é conhecido por
seu alto desempenho e escalabilidade. Ele é ideal para lidar
com altos volumes de dados na EvolutionAPI.\n\nDefina as
variáveis de ambiente do MongoDB no arquivo `.env` para
Docker ou o `dev-env.yml` para NPM da seguinte forma:\n\n##
Migração de dados\n\nAlternar entre o armazenamento local
para o MongoDB não transfere automaticamente suas instâncias
do WhatsApp que estão atualmente sincronizadas com o local
storage original.\n\nClaro, aqui está a tradução da
documentação para o português:\n\n## Migre seus dados no
NPM ou NVM\n\nPare a execução do PM2:\n\n**Flush e Stop**:
Limpa todos os logs do PM2, útil para solução de problemas
após a atualização e para parar temporariamente a Evolution
API para aplicar atualizações com segurança.\n
\n**Diretório da Evolution API**: acesse o diretório de
instalação com o seguinte comando:\n\n**Comando de migraçÃ
£o**: Execute o comando de migração no diretório de
instalação:\n\nSiga os passos do script e migre instâncias
especÃficas do WhatsApp ou todas as suas instâncias.",
"debug": {
"requestHandlerMode": "http"
}
},
{
"url": "https://doc.evolution-api.com/v2/api-reference/chat-
controller/archive-chat",
"crawl": {
"loadedUrl": "https://doc.evolution-api.com/v2/api-
reference/chat-controller/archive-chat",
"loadedTime": "2025-03-05T23:48:26.754Z"
},
"metadata": {
"canonicalUrl": "https://doc.evolution-api.com/v2/api-
reference/chat-controller/archive-chat",
"title": "Archive Chat - Evolution API Documentation",
"description": null,
"author": null,
"keywords": null,
"languageCode": "en",
"openGraph": [
{
188
 "property": "og:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Archive+Chat&logoLight=https%3A%
2F%2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover.png&logoDark=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover-white.png&primaryColor=%2349BC94
&lightColor=%2349BC94&darkColor=%2349BC94"
},
{
"property": "og:image:width",
"content": "1200"
},
{
"property": "og:image:height",
"content": "630"
},
{
"property": "twitter:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Archive+Chat&logoLight=https%3A%
2F%2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover.png&logoDark=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover-white.png&primaryColor=%2349BC94
&lightColor=%2349BC94&darkColor=%2349BC94"
},
{
"property": "twitter:image:width",
"content": "1200"
},
{
"property": "twitter:image:height",
"content": "630"
}
],
"jsonLd": null,
"headers": {
"age": "400",
"cache-control": "public, max-age=0, must-revalidate",
"content-encoding": "br",
"content-type": "text/html; charset=utf-8",
"date": "Wed, 05 Mar 2025 23:41:45 GMT",
"etag": "W/\"strtcaozon5j9u\"",
"server": "Vercel",
"strict-transport-security": "max-age=63072000",
"x-frame-options": "DENY",
"x-matched-path": "/_sites/[subdomain]/[[...slug]]",
"x-powered-by": "Next.js",
"x-vercel-cache": "HIT",
"x-vercel-id":
"iad1::iad1::c44p5-1741218506391-35a1630812a7",
"transfer-encoding": "chunked"
}
},
"screenshotUrl": null,
"text": "Archive Chat - Evolution API Documentation\nInÃcio
189
\nGET\nGet Information\nInstances\nPOST\nCreate Instance\nGET
\nFetch Instances\nGET\nInstance Connect\nPUT\nRestart
Instance\nGET\nConnection State\nDEL\nLogout Instance\nDEL
\nDelete Instance\nPOST\nSet Presence\nWebhook\nPOST\nSet
Webhook\nGET\nFind Webhook\nSettings\nPOST\nSet Settings\nGET
\nFind Settings\nSend Message\nPOST\nSend Plain Text\nPOST
\nSend Status\nPOST\nSend Media\nPOST\nSend WhatsApp Audio
\nPOST\nSend Sticker\nPOST\nSend Location\nPOST\nSend Contact
\nPOST\nSend Reaction\nPOST\nSend Poll\nPOST\nSend List\nPOST
\nSend Buttons\nChat Controller\nPOST\nCheck is WhatsApp\nPOST
\nMark Message As Read\nPOST\nMark Message As Unread\nPOST
\nArchive Chat\nDEL\nDelete Message for Everyone\nPOST\nUpdate
Message\nPOST\nSend Presence\nPOST\nUpdate Block Status\nPOST
\nFetch Profile Picture URL\nPOST\nGet Base64\nPOST\nFind
Contacts\nPOST\nFind Messages\nPOST\nFind Status Message\nPOST
\nFind Chats\nProfile Settings\nPOST\nFetch Business Profile
\nPOST\nFetch Profile\nPOST\nUpdate Profile Name\nPOST\nUpdate
Profile Status\nPOST\nUpdate Profile Picture\nDEL\nRemove
Profile Picture\nGET\nFetch Privacy Settings\nPOST\nUpdate
Privacy Settings\nGroup Controller\nPOST\nCreate Group\nPOST
\nUpdate Group Picture\nPOST\nUpdate Group Subject\nPOST
\nUpdate Group Description\nGET\nFetch Invite Code\nPOST
\nRevoke Invite Code\nPOST\nSend Group Invite\nGET\nFind Group
by Invite Code\nGET\nFind Group by JID\nGET\nFetch All Groups
\nGET\nFind Group Members\nPOST\nUpdate Group Members\nPOST
\nUpdate Group Setting\nPOST\nToggle Ephemeral\nDEL\nLeave
Group\nTypebot\nPOST\nCreate Typebot\nPOST\nStart Typebot\nGET
\nFind Typebot\nGET\nFetch Typebot\nPOST\nUpdate Typebot\nDEL
\nDelete Typebot\nPOST\nChange Session Status\nGET\nFetch
Session Typebot\nPOST\nSettings Typebot\nGET\nFetch Typebot
Settings\nOpenAI\nPOST\nCreate OpenIA Bot\nGET\nFind OpenIA
Bot\nGET\nFind OpenIA Bots\nPUT\nUpdate Bot\nDEL\nDelete
OpenIA Bot\nGET\nFind OpenIA Creds\nPOST\nCreds config OpenAI
\nDEL\nDelete OpenIA Bot\nPOST\nSettigns config OpenAI\nGET
\nFind settings OpenAI\nPOST\nChange status OpenAI\nGET\nFind
sessions OpenAI\nEvolution Bot\nPOST\nCreate Evolution Bot
\nGET\nFind Evolution Bots\nGET\nFetch Evolution Bot\nPUT
\nUpdate Evolution Bot\nDEL\nDelete Evolution Bot\nPOST\nSet
Settings Bot\nGET\nFind Settings Bot\nPOST\nChange Evolution
Bot status\nGET\nFetch Evolution Bot Session\nDify\nPOST
\nCreate Dify Bot\nGET\nFind Dify Bots\nGET\nFind Dify Bot
\nPUT\nUpdate Dify Bot\nPOST\nSet Dify Settings\nGET\nFind
Dify Settings\nPOST\nChange Status Bot\nGET\nFind Status Bot
\nFlowise\nPOST\nCreate Flowise Bot\nGET\nFind Flowise Bots
\nGET\nFind Flowise Bot\nPOST\nUpdate Flowise Bot\nDEL\nDelete
Flowise Bot\nPOST\nSet Settings Flowise Bots\nGET\nFind
Flowise settings\nPOST\nChange Status Session\nGET\nFind
Sessions Flowise\nChatwoot\nPOST\nSet Chatwoot\nGET\nFind
Chatwoot\nWebsocket\nPOST\nSet Websocket\nGET\nFind Websocket
\nSQS\nPOST\nSet SQS\nGET\nFind SQS\nRabbitMQ\nPOST\nSet
RabbitMQ\nGET\nFind RabbitMQ",
"markdown": "# Archive Chat - Evolution API Documentation\n
\n##### InÃcio\n\n* [GET\n \n Get Information\n \n
\n \n ](https://doc.evolution-api.com/v2/api-
reference/get-information)\n\n##### Instances\n\n* [POST\n
\n Create Instance\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-reference/instance-
190
controller/create-instance-basic)\n* [GET\n \n Fetch
Instances\n \n \n \n ](https://doc.evolution-
api.com/v2/api-reference/instance-controller/fetch-
instances)\n* [GET\n \n Instance Connect\n \n \n
\n ](https://doc.evolution-api.com/v2/api-
reference/instance-controller/instance-connect)\n* [PUT\n
\n Restart Instance\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-reference/instance-
controller/restart-instance)\n* [GET\n \n Connection
State\n \n \n \n ](https://doc.evolution-
api.com/v2/api-reference/instance-controller/connection-
state)\n* [DEL\n \n Logout Instance\n \n \n
\n ](https://doc.evolution-api.com/v2/api-
reference/instance-controller/logout-instance)\n* [DEL\n
\n Delete Instance\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-reference/instance-
controller/delete-instance)\n* [POST\n \n Set Presence
\n \n \n \n ](https://doc.evolution-
api.com/v2/api-reference/instance-controller/set-presence)\n
\n##### Webhook\n\n* [POST\n \n Set Webhook\n \n
\n \n ](https://doc.evolution-api.com/v2/api-
reference/webhook/set)\n* [GET\n \n Find Webhook\n
\n \n \n ](https://doc.evolution-api.com/v2/api-
reference/webhook/get)\n\n##### Settings\n\n* [POST\n \n
Set Settings\n \n \n \n ](https://doc.evolution-
api.com/v2/api-reference/settings/set)\n* [GET\n \n
Find Settings\n \n \n \n ](https://doc.evolution-
api.com/v2/api-reference/settings/get)\n\n##### Send Message\n
\n* [POST\n \n Send Plain Text\n \n \n
\n ](https://doc.evolution-api.com/v2/api-
reference/message-controller/send-text)\n* [POST\n \n
Send Status\n \n \n \n ](https://doc.evolution-
api.com/v2/api-reference/message-controller/send-status)\n*
[POST\n \n Send Media\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-reference/message-
controller/send-media)\n* [POST\n \n Send WhatsApp
Audio\n \n \n \n ](https://doc.evolution-
api.com/v2/api-reference/message-controller/send-audio)\n*
[POST\n \n Send Sticker\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-reference/message-
controller/send-sticker)\n* [POST\n \n Send Location\n
\n \n \n ](https://doc.evolution-api.com/v2/api-
reference/message-controller/send-location)\n* [POST\n \n
Send Contact\n \n \n \n ](https://doc.evolution-
api.com/v2/api-reference/message-controller/send-contact)\n*
[POST\n \n Send Reaction\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-reference/message-
controller/send-reaction)\n* [POST\n \n Send Poll\n
\n \n \n ](https://doc.evolution-api.com/v2/api-
reference/message-controller/send-poll)\n* [POST\n \n
Send List\n \n \n \n ](https://doc.evolution-
api.com/v2/api-reference/message-controller/send-list)\n*
[POST\n \n Send Buttons\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-reference/message-
controller/send-button)\n\n##### Chat Controller\n\n* [POST
\n \n Check is WhatsApp\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-reference/chat-
191
controller/check-is-whatsapp)\n* [POST\n \n Mark
Message As Read\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-reference/chat-
controller/mark-as-read)\n* [POST\n \n Mark Message As
Unread\n \n \n \n ](https://doc.evolution-
api.com/v2/api-reference/chat-controller/mark-as-unread)\n*
[POST\n \n Archive Chat\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-reference/chat-
controller/archive-chat)\n* [DEL\n \n Delete Message
for Everyone\n \n \n \n ](https://doc.evolution-
api.com/v2/api-reference/chat-controller/delete-message-for-
everyone)\n* [POST\n \n Update Message\n \n \n
\n ](https://doc.evolution-api.com/v2/api-reference/chat-
controller/update-message)\n* [POST\n \n Send Presence
\n \n \n \n ](https://doc.evolution-
api.com/v2/api-reference/chat-controller/send-presence)\n*
[POST\n \n Update Block Status\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-reference/chat-
controller/updateBlockStatus)\n* [POST\n \n Fetch
Profile Picture URL\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-reference/chat-
controller/fetch-profilepic-url)\n* [POST\n \n Get
Base64\n \n \n \n ](https://doc.evolution-
api.com/v2/api-reference/chat-controller/get-base64)\n*
[POST\n \n Find Contacts\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-reference/chat-
controller/find-contacts)\n* [POST\n \n Find Messages
\n \n \n \n ](https://doc.evolution-
api.com/v2/api-reference/chat-controller/find-messages)\n*
[POST\n \n Find Status Message\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-reference/chat-
controller/find-status-message)\n* [POST\n \n Find
Chats\n \n \n \n ](https://doc.evolution-
api.com/v2/api-reference/chat-controller/find-chats)\n\n#####
Profile Settings\n\n* [POST\n \n Fetch Business
Profile\n \n \n \n ](https://doc.evolution-
api.com/v2/api-reference/profile-settings/fetch-business-
profile)\n* [POST\n \n Fetch Profile\n \n \n
\n ](https://doc.evolution-api.com/v2/api-
reference/profile-settings/fetch-profile)\n* [POST\n \n
Update Profile Name\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-reference/profile-
settings/update-profile-name)\n* [POST\n \n Update
Profile Status\n \n \n \n ](https://doc.evolution-
api.com/v2/api-reference/profile-settings/update-profile-
status)\n* [POST\n \n Update Profile Picture\n \n
\n \n ](https://doc.evolution-api.com/v2/api-
reference/profile-settings/update-profile-picture)\n* [DEL\n
\n Remove Profile Picture\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-reference/profile-
settings/remove-profile-picture)\n* [GET\n \n Fetch
Privacy Settings\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-reference/profile-
settings/fetch-privacy-settings)\n* [POST\n \n Update
Privacy Settings\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-reference/profile-
settings/update-privacy-settings)\n\n##### Group Controller\n
192
\n* [POST\n \n Create Group\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-reference/group-
controller/group-create)\n* [POST\n \n Update Group
Picture\n \n \n \n ](https://doc.evolution-
api.com/v2/api-reference/group-controller/update-group-
picture)\n* [POST\n \n Update Group Subject\n \n
\n \n ](https://doc.evolution-api.com/v2/api-
reference/group-controller/update-group-subject)\n* [POST\n
\n Update Group Description\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-reference/group-
controller/update-group-description)\n* [GET\n \n
Fetch Invite Code\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-reference/group-
controller/fetch-invite-code)\n* [POST\n \n Revoke
Invite Code\n \n \n \n ](https://doc.evolution-
api.com/v2/api-reference/group-controller/revoke-invite-
code)\n* [POST\n \n Send Group Invite\n \n \n
\n ](https://doc.evolution-api.com/v2/api-reference/group-
controller/send-invite-url)\n* [GET\n \n Find Group by
Invite Code\n \n \n \n ](https://doc.evolution-
api.com/v2/api-reference/group-controller/find-group-by-
invite-code)\n* [GET\n \n Find Group by JID\n \n
\n \n ](https://doc.evolution-api.com/v2/api-
reference/group-controller/find-group-by-jid)\n* [GET\n
\n Fetch All Groups\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-reference/group-
controller/fetch-all-groups)\n* [GET\n \n Find Group
Members\n \n \n \n ](https://doc.evolution-
api.com/v2/api-reference/group-controller/find-
participants)\n* [POST\n \n Update Group Members\n
\n \n \n ](https://doc.evolution-api.com/v2/api-
reference/group-controller/update-participant)\n* [POST\n
\n Update Group Setting\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-reference/group-
controller/update-setting)\n* [POST\n \n Toggle
Ephemeral\n \n \n \n ](https://doc.evolution-
api.com/v2/api-reference/group-controller/toggle-ephemeral)\n*
[DEL\n \n Leave Group\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-reference/group-
controller/leave-group)\n\n##### Typebot\n\n* [POST\n \n
Create Typebot\n \n \n \n ](https://doc.evolution-
api.com/v2/api-reference/integrations/typebot/set-typebot)\n*
[POST\n \n Start Typebot\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-
reference/integrations/typebot/start-typebot)\n* [GET\n
\n Find Typebot\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-
reference/integrations/typebot/find-typebot)\n* [GET\n \n
Fetch Typebot\n \n \n \n ](https://doc.evolution-
api.com/v2/api-reference/integrations/typebot/fetch-
typebot)\n* [POST\n \n Update Typebot\n \n \n
\n ](https://doc.evolution-api.com/v2/api-
reference/integrations/typebot/update-typebot)\n* [DEL\n
\n Delete Typebot\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-
reference/integrations/typebot/delete-typebot)\n* [POST\n
\n Change Session Status\n \n \n \n ]
193
(https://doc.evolution-api.com/v2/api-
reference/integrations/typebot/change-session-status)\n*
[GET\n \n Fetch Session Typebot\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-
reference/integrations/typebot/fetch-session)\n* [POST\n
\n Settings Typebot\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-
reference/integrations/typebot/settings-typebot)\n* [GET\n
\n Fetch Typebot Settings\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-
reference/integrations/typebot/find-settings-typebot)\n\n#####
OpenAI\n\n* [POST\n \n Create OpenIA Bot\n \n \n
\n ](https://doc.evolution-api.com/v2/api-
reference/integrations/openai/create-bot)\n* [GET\n \n
Find OpenIA Bot\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-
reference/integrations/openai/find-bot)\n* [GET\n \n
Find OpenIA Bots\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-
reference/integrations/openai/find-bots)\n* [PUT\n \n
Update Bot\n \n \n \n ](https://doc.evolution-
api.com/v2/api-reference/integrations/openai/update-bot)\n*
[DEL\n \n Delete OpenIA Bot\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-
reference/integrations/openai/delete-bot)\n* [GET\n \n
Find OpenIA Creds\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-
reference/integrations/openai/find-creds-openai)\n* [POST\n
\n Creds config OpenAI\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-
reference/integrations/openai/set-creds)\n* [DEL\n \n
Delete OpenIA Bot\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-
reference/integrations/openai/delete-creds)\n* [POST\n \n
Settigns config OpenAI\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-
reference/integrations/openai/settings-openai)\n* [GET\n
\n Find settings OpenAI\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-
reference/integrations/openai/find-settings)\n* [POST\n
\n Change status OpenAI\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-
reference/integrations/openai/change-status)\n* [GET\n \n
Find sessions OpenAI\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-
reference/integrations/openai/find-session)\n\n##### Evolution
Bot\n\n* [POST\n \n Create Evolution Bot\n \n \n
\n ](https://doc.evolution-api.com/v2/api-
reference/integrations/evolution/create-bot)\n* [GET\n \n
Find Evolution Bots\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-
reference/integrations/evolution/find-bot)\n* [GET\n \n
Fetch Evolution Bot\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-
reference/integrations/evolution/fetch-bots)\n* [PUT\n \n
Update Evolution Bot\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-
194
reference/integrations/evolution/update)\n* [DEL\n \n
Delete Evolution Bot\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-
reference/integrations/evolution/delete-bot)\n* [POST\n
\n Set Settings Bot\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-
reference/integrations/evolution/set-settings)\n* [GET\n
\n Find Settings Bot\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-
reference/integrations/evolution/find-settings)\n* [POST\n
\n Change Evolution Bot status\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-
reference/integrations/evolution/change-status-session)\n*
[GET\n \n Fetch Evolution Bot Session\n \n \n
\n ](https://doc.evolution-api.com/v2/api-
reference/integrations/evolution/fetch-session)\n\n##### Dify
\n\n* [POST\n \n Create Dify Bot\n \n \n
\n ](https://doc.evolution-api.com/v2/api-
reference/integrations/dify/create-dify)\n* [GET\n \n
Find Dify Bots\n \n \n \n ](https://doc.evolution-
api.com/v2/api-reference/integrations/dify/find-dify)\n*
[GET\n \n Find Dify Bot\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-
reference/integrations/dify/find-bot-dify)\n* [PUT\n \n
Update Dify Bot\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-
reference/integrations/dify/update-dify)\n* [POST\n \n
Set Dify Settings\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-
reference/integrations/dify/set-settings-dify)\n* [GET\n
\n Find Dify Settings\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-
reference/integrations/dify/find-settings)\n* [POST\n \n
Change Status Bot\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-
reference/integrations/dify/change-status)\n* [GET\n \n
Find Status Bot\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-
reference/integrations/dify/find-status)\n\n##### Flowise\n\n*
[POST\n \n Create Flowise Bot\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-
reference/integrations/flowise/create-bot)\n* [GET\n \n
Find Flowise Bots\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-
reference/integrations/flowise/find-flowise-bots)\n* [GET\n
\n Find Flowise Bot\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-
reference/integrations/flowise/find-flowise-bot)\n* [POST\n
\n Update Flowise Bot\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-
reference/integrations/flowise/update-flowise-bot)\n* [DEL\n
\n Delete Flowise Bot\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-
reference/integrations/flowise/delete-flowise-bot)\n* [POST
\n \n Set Settings Flowise Bots\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-
reference/integrations/flowise/set-settings)\n* [GET\n \n
195
Find Flowise settings\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-
reference/integrations/flowise/find-settings)\n* [POST\n
\n Change Status Session\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-
reference/integrations/flowise/change-session-status)\n*
[GET\n \n Find Sessions Flowise\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-
reference/integrations/flowise/find-sessions)\n\n#####
Chatwoot\n\n* [POST\n \n Set Chatwoot\n \n \n
\n ](https://doc.evolution-api.com/v2/api-
reference/integrations/chatwoot/set-chatwoot)\n* [GET\n
\n Find Chatwoot\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-
reference/integrations/chatwoot/find-chatwoot)\n\n#####
Websocket\n\n* [POST\n \n Set Websocket\n \n \n
\n ](https://doc.evolution-api.com/v2/api-
reference/integrations/websocket/set-websocket)\n* [GET\n
\n Find Websocket\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-
reference/integrations/websocket/find-websocket)\n\n##### SQS
\n\n* [POST\n \n Set SQS\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-
reference/integrations/sqs/set-sqs)\n* [GET\n \n Find
SQS\n \n \n \n ](https://doc.evolution-
api.com/v2/api-reference/integrations/sqs/find-sqs)\n\n#####
RabbitMQ\n\n* [POST\n \n Set RabbitMQ\n \n \n
\n ](https://doc.evolution-api.com/v2/api-
reference/integrations/rabbitmq/set-rabbitmq)\n* [GET\n
\n Find RabbitMQ\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-
reference/integrations/rabbitmq/find-rabbitmq)",
"debug": {
"requestHandlerMode": "http"
}
},
{
"url": "https://doc.evolution-api.com/v2/api-reference/chat-
controller/check-is-whatsapp",
"crawl": {
"loadedUrl": "https://doc.evolution-api.com/v2/api-
reference/chat-controller/check-is-whatsapp",
"loadedTime": "2025-03-05T23:48:27.279Z"
},
"metadata": {
"canonicalUrl": "https://doc.evolution-api.com/v2/api-
reference/chat-controller/check-is-whatsapp",
"title": "Check is WhatsApp - Evolution API
Documentation",
"description": null,
"author": null,
"keywords": null,
"languageCode": "en",
"openGraph": [
{
"property": "og:image",
"content": "https://mintlify.com/docs/api/og?
196
division=Documentation&title=Check+is+WhatsApp&logoLight=https
%3A%2F%2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-
eb1f2775%2Fimages%2Fbrand%2Fcover.png&logoDark=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover-white.png&primaryColor=%2349BC94
&lightColor=%2349BC94&darkColor=%2349BC94"
},
{
"property": "og:image:width",
"content": "1200"
},
{
"property": "og:image:height",
"content": "630"
},
{
"property": "twitter:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Check+is+WhatsApp&logoLight=https
%3A%2F%2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-
eb1f2775%2Fimages%2Fbrand%2Fcover.png&logoDark=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover-white.png&primaryColor=%2349BC94
&lightColor=%2349BC94&darkColor=%2349BC94"
},
{
"property": "twitter:image:width",
"content": "1200"
},
{
"property": "twitter:image:height",
"content": "630"
}
],
"jsonLd": null,
"headers": {
"age": "584",
"cache-control": "public, max-age=0, must-revalidate",
"content-encoding": "br",
"content-type": "text/html; charset=utf-8",
"date": "Wed, 05 Mar 2025 23:38:42 GMT",
"etag": "W/\"a3g86b3trj69pj\"",
"server": "Vercel",
"strict-transport-security": "max-age=63072000",
"x-frame-options": "DENY",
"x-matched-path": "/_sites/[subdomain]/[[...slug]]",
"x-powered-by": "Next.js",
"x-vercel-cache": "HIT",
"x-vercel-id":
"iad1::iad1::ckhcf-1741218507130-9a395e812e0c",
"transfer-encoding": "chunked"
}
},
"screenshotUrl": null,
"text": "Check is WhatsApp - Evolution API Documentation
\nAuthorizations\nYour authorization key header\nPath
Parameters\nID of the instance to connect\nBody\nPhone numbers
197
(with country code) to be checked\nIndicates whether the
WhatsApp account exists.\nThe JID of the WhatsApp account.
\nThe phone number associated with the WhatsApp account.",
"markdown": "# Check is WhatsApp - Evolution API
Documentation\n\n#### Authorizations\n\nYour authorization key
header\n\n#### Path Parameters\n\nID of the instance to
connect\n\n#### Body\n\nPhone numbers (with country code) to
be checked\n\nIndicates whether the WhatsApp account exists.\n
\nThe JID of the WhatsApp account.\n\nThe phone number
associated with the WhatsApp account.",
"debug": {
"requestHandlerMode": "http"
}
},
{
"url": "https://doc.evolution-api.com/v1/en/install/docker",
"crawl": {
"loadedUrl": "https://doc.evolution-
api.com/v1/en/install/docker",
"loadedTime": "2025-03-05T23:48:28.196Z",
"referrerUrl": "https://doc.evolution-api.com/v1/en/get-
started/introduction",
"depth": 1
},
"metadata": {
"canonicalUrl": "https://doc.evolution-
api.com/v1/en/install/docker",
"title": "Docker - Evolution API Documentation",
"description": null,
"author": null,
"keywords": null,
"languageCode": "en",
"openGraph": [
{
"property": "og:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Docker&logoLight=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover.png&logoDark=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover-white.png&primaryColor=%2349BC94
&lightColor=%2349BC94&darkColor=%2349BC94"
},
{
"property": "og:image:width",
"content": "1200"
},
{
"property": "og:image:height",
"content": "630"
},
{
"property": "twitter:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Docker&logoLight=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover.png&logoDark=https%3A%2F%
198
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover-white.png&primaryColor=%2349BC94
&lightColor=%2349BC94&darkColor=%2349BC94"
},
{
"property": "twitter:image:width",
"content": "1200"
},
{
"property": "twitter:image:height",
"content": "630"
}
],
"jsonLd": null,
"headers": {
"age": "145",
"cache-control": "public, max-age=0, must-revalidate",
"content-encoding": "br",
"content-type": "text/html; charset=utf-8",
"date": "Wed, 05 Mar 2025 23:46:02 GMT",
"etag": "W/\"vsv3tcg6b55rb\"",
"server": "Vercel",
"strict-transport-security": "max-age=63072000",
"x-frame-options": "DENY",
"x-matched-path": "/_sites/[subdomain]/[[...slug]]",
"x-powered-by": "Next.js",
"x-vercel-cache": "HIT",
"x-vercel-id":
"iad1::iad1::twv7w-1741218508129-5cfa9a52a39f",
"transfer-encoding": "chunked"
}
},
"screenshotUrl": null,
"text": "Docker - Evolution API Documentation\nEvolutionAPI
is Docker-ready and can be easily deployed with Docker in both
standalone and swarm modes. The official EvolutionAPI
repository contains all the necessary compose files to install
the API.\nDocker Run\nQuick Start\nThe fastest way to deploy
EvolutionAPI with Docker is by using docker run on the command
line interface.\nThis will run a Docker container exposing the
application on port 8080, and you can start testing and
requesting the WhatsApp QR code using the authentication
variable content with the apikey header set.\nQuick Start with
Volumes\nYou can also deploy using Docker volumes to keep your
EvolutionAPI’s persistent data and all WhatsApp instances on
your local machine, avoiding issues with container restarts by
using docker run on the command line interface.\nRun the
following command to deploy EvolutionAPI with the necessary
volumes. This command maps the evolution_store and
evolution_instances volumes to their respective directories
inside the container.\nDocker Compose\nDeploying EvolutionAPI
using Docker Compose simplifies the setup and management of
your Docker containers. It allows you to define your Docker
environment in a docker-compose.yaml file and then use a
single command to start everything.\nThis is a Docker Compose
example for standalone environments, i.e., a single running
server. For synchronization of two servers in parallel, use
199
Swarm. This is for more advanced Docker users.\nStandalone
\nDocker standalone is suitable when your Evolution API will
be running on just one machine, and you don’t need
scalability or other Docker Swarm features for now. It’s the
most convenient way to use Docker for most people.\nCreate a
docker-compose.yml file with this content:\nCreate a .env file
in the same directory with the following:\nNavigate to the
directory containing your docker-compose.yml file and run:
services defined in the file\nThis command will download the
necessary Docker images, create the defined services,
networks, and volumes, and start the EvolutionAPI service.
\nAfter running the docker-compose up command, you should see
logs indicating that the services are running.\nTo stop the
service, use:\nOpen your browser and go to
http://localhost:8080 to check if the EvolutionAPI is
operational.",
"markdown": "# Docker - Evolution API Documentation\n
\nEvolutionAPI is Docker-ready and can be easily deployed with
Docker in both standalone and swarm modes. The official
EvolutionAPI repository contains all the necessary compose
files to install the API.\n\n## Docker Run\n\n### Quick Start
\n\nThe fastest way to deploy EvolutionAPI with Docker is by
using `docker run` on the command line interface.\n\nThis will
run a Docker container exposing the application on port 8080,
and you can start testing and requesting the WhatsApp QR code
using the authentication variable content with the `apikey`
header set.\n\n### Quick Start with Volumes\n\nYou can also
deploy using Docker volumes to keep your EvolutionAPI’s
persistent data and all WhatsApp instances on your local
machine, avoiding issues with container restarts by using
`docker run` on the command line interface.\n\nRun the
following command to deploy EvolutionAPI with the necessary
volumes. This command maps the `evolution_store` and
`evolution_instances` volumes to their respective directories
inside the container.\n\n## Docker Compose\n\nDeploying
EvolutionAPI using Docker Compose simplifies the setup and
management of your Docker containers. It allows you to define
your Docker environment in a `docker-compose.yaml` file and
then use a single command to start everything.\n\nThis is a
Docker Compose example for standalone environments, i.e., a
single running server. For synchronization of two servers in
parallel, use Swarm. This is for more advanced Docker users.\n
\n### Standalone\n\nDocker standalone is suitable when your
Evolution API will be running on just one machine, and you
don’t need scalability or other Docker Swarm features for
now. It’s the most convenient way to use Docker for most
people.\n\nCreate a `docker-compose.yml` file with this
content:\n\nCreate a `.env` file in the same directory with
the following:\n\nNavigate to the directory containing your
docker-compose.yml file and run: services defined in the file
\n\nThis command will download the necessary Docker images,
create the defined services, networks, and volumes, and start
the EvolutionAPI service.\n\nAfter running the docker-compose
up command, you should see logs indicating that the services
are running.\n\nTo stop the service, use:\n\nOpen your browser
and go to [http://localhost:8080](http://localhost:8080/) to
check if the EvolutionAPI is operational.",
200
 "debug": {
"requestHandlerMode": "http"
}
},
{
"url": "https://doc.evolution-api.com/v2/api-reference/chat-
controller/fetch-profilepic-url",
"crawl": {
"loadedUrl": "https://doc.evolution-api.com/v2/api-
reference/chat-controller/fetch-profilepic-url",
"loadedTime": "2025-03-05T23:48:28.254Z"
},
"metadata": {
"canonicalUrl": "https://doc.evolution-api.com/v2/api-
reference/chat-controller/fetch-profilepic-url",
"title": "Fetch Profile Picture URL - Evolution API
Documentation",
"description": null,
"author": null,
"keywords": null,
"languageCode": "en",
"openGraph": [
{
"property": "og:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Fetch+Profile+Picture+URL&logoLig
ht=https%3A%2F%2Fmintlify.s3.us-west-1.amazonaws.com%
2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover.png&logoDark=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover-white.png&primaryColor=%2349BC94&lightColor=%2349BC94
&darkColor=%2349BC94"
},
{
"property": "og:image:width",
"content": "1200"
},
{
"property": "og:image:height",
"content": "630"
},
{
"property": "twitter:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Fetch+Profile+Picture+URL&logoLig
ht=https%3A%2F%2Fmintlify.s3.us-west-1.amazonaws.com%
2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover.png&logoDark=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover-white.png&primaryColor=%2349BC94&lightColor=%2349BC94
&darkColor=%2349BC94"
},
{
"property": "twitter:image:width",
"content": "1200"
},
{
201
 "property": "twitter:image:height",
"content": "630"
}
],
"jsonLd": null,
"headers": {
"age": "401",
"cache-control": "public, max-age=0, must-revalidate",
"content-encoding": "br",
"content-type": "text/html; charset=utf-8",
"date": "Wed, 05 Mar 2025 23:41:45 GMT",
"etag": "W/\"xitk2tgs7767wo\"",
"server": "Vercel",
"strict-transport-security": "max-age=63072000",
"x-frame-options": "DENY",
"x-matched-path": "/_sites/[subdomain]/[[...slug]]",
"x-powered-by": "Next.js",
"x-vercel-cache": "HIT",
"x-vercel-id":
"iad1::iad1::cm929-1741218508150-0ca1b71822ee",
"transfer-encoding": "chunked"
}
},
"screenshotUrl": null,
"text": "Fetch Profile Picture URL - Evolution API
Documentation\nAuthorizations\nYour authorization key header
\nPath Parameters\nID of the instance to connect\nBody\nNumber
to fetch profile picture URL\nThe WhatsApp User ID (WUID).
\nURL of the user's profile picture.",
"markdown": "# Fetch Profile Picture URL - Evolution API
Documentation\n\n#### Authorizations\n\nYour authorization key
header\n\n#### Path Parameters\n\nID of the instance to
connect\n\n#### Body\n\nNumber to fetch profile picture URL\n
\nThe WhatsApp User ID (WUID).\n\nURL of the user's profile
picture.",
"debug": {
"requestHandlerMode": "http"
}
},
{
"url": "https://doc.evolution-api.com/v2/api-reference/chat-
controller/delete-message-for-everyone",
"crawl": {
"loadedUrl": "https://doc.evolution-api.com/v2/api-
reference/chat-controller/delete-message-for-everyone",
"loadedTime": "2025-03-05T23:48:28.303Z"
},
"metadata": {
"canonicalUrl": "https://doc.evolution-api.com/v2/api-
reference/chat-controller/delete-message-for-everyone",
"title": "Delete Message for Everyone - Evolution API
Documentation",
"description": null,
"author": null,
"keywords": null,
"languageCode": "en",
"openGraph": [
202
 {
"property": "og:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Delete+Message+for+Everyone&logoL
ight=https%3A%2F%2Fmintlify.s3.us-west-1.amazonaws.com%
2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover.png&logoDark=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover-white.png&primaryColor=%2349BC94&lightColor=%2349BC94
&darkColor=%2349BC94"
},
{
"property": "og:image:width",
"content": "1200"
},
{
"property": "og:image:height",
"content": "630"
},
{
"property": "twitter:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Delete+Message+for+Everyone&logoL
ight=https%3A%2F%2Fmintlify.s3.us-west-1.amazonaws.com%
2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover.png&logoDark=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover-white.png&primaryColor=%2349BC94&lightColor=%2349BC94
&darkColor=%2349BC94"
},
{
"property": "twitter:image:width",
"content": "1200"
},
{
"property": "twitter:image:height",
"content": "630"
}
],
"jsonLd": null,
"headers": {
"age": "402",
"cache-control": "public, max-age=0, must-revalidate",
"content-encoding": "br",
"content-type": "text/html; charset=utf-8",
"date": "Wed, 05 Mar 2025 23:41:45 GMT",
"etag": "W/\"a0u513npv470ke\"",
"server": "Vercel",
"strict-transport-security": "max-age=63072000",
"x-frame-options": "DENY",
"x-matched-path": "/_sites/[subdomain]/[[...slug]]",
"x-powered-by": "Next.js",
"x-vercel-cache": "HIT",
"x-vercel-id": "iad1::iad1::twv7w-1741218508210-
b01662273a0e",
"transfer-encoding": "chunked"
}
203
 },
"screenshotUrl": null,
"text": "Delete Message for Everyone - Evolution API
Documentation\nAuthorizations\nYour authorization key header
\nPath Parameters\nID of the instance to connect\nBody\nChat
contact or group remote JID\nIf the message was sent by the
instance owner or the contact\nParticipant for group messages
only TODO\nSchema representing a WhatsApp protocol message,
including the key, message content, timestamp, and status.
\nThe key that identifies the message in the chat.\nThe remote
JID (Jabber ID) of the WhatsApp account.\nIndicates whether
the message was sent by the user.\nThe content of the message.
\nDetails of the protocol message.
\nmessage.protocolMessage.key\nThe key that identifies the
referenced message.\nmessage.protocolMessage.key.remoteJid
\nThe remote JID (Jabber ID) of the WhatsApp account in the
referenced message.\nmessage.protocolMessage.key.fromMe
\nIndicates whether the referenced message was sent by the
user.\nmessage.protocolMessage.key.id\nThe ID of the
referenced message.\nmessage.protocolMessage.type\nThe type of
protocol message, e.g., 'REVOKE'.\nThe timestamp of the
message, represented as a string.\nThe status of the message,
such as sent, received, or pending.",
"markdown": "# Delete Message for Everyone - Evolution API
Documentation\n\n#### Authorizations\n\nYour authorization key
header\n\n#### Path Parameters\n\nID of the instance to
connect\n\n#### Body\n\nChat contact or group remote JID\n\nIf
the message was sent by the instance owner or the contact\n
\nParticipant for group messages only TODO\n\nSchema
representing a WhatsApp protocol message, including the key,
message content, timestamp, and status.\n\nThe key that
identifies the message in the chat.\n\nThe remote JID (Jabber
ID) of the WhatsApp account.\n\nIndicates whether the message
was sent by the user.\n\nThe content of the message.\n
\nDetails of the protocol message.\n
\nmessage.protocolMessage.key\n\nThe key that identifies the
referenced message.\n\nmessage.protocolMessage.key.remoteJid\n
\nThe remote JID (Jabber ID) of the WhatsApp account in the
referenced message.\n\nmessage.protocolMessage.key.fromMe\n
\nIndicates whether the referenced message was sent by the
user.\n\nmessage.protocolMessage.key.id\n\nThe ID of the
referenced message.\n\nmessage.protocolMessage.type\n\nThe
type of protocol message, e.g., 'REVOKE'.\n\nThe timestamp of
the message, represented as a string.\n\nThe status of the
message, such as sent, received, or pending.",
"debug": {
"requestHandlerMode": "http"
}
},
{
"url": "https://doc.evolution-api.com/v2/api-reference/chat-
controller/find-contacts",
"crawl": {
"loadedUrl": "https://doc.evolution-api.com/v2/api-
reference/chat-controller/find-contacts",
"loadedTime": "2025-03-05T23:48:28.419Z"
},
204
 "metadata": {
"canonicalUrl": "https://doc.evolution-api.com/v2/api-
reference/chat-controller/find-contacts",
"title": "Find Contacts - Evolution API Documentation",
"description": null,
"author": null,
"keywords": null,
"languageCode": "en",
"openGraph": [
{
"property": "og:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Find+Contacts&logoLight=https%3A%
2F%2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover.png&logoDark=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover-white.png&primaryColor=%2349BC94
&lightColor=%2349BC94&darkColor=%2349BC94"
},
{
"property": "og:image:width",
"content": "1200"
},
{
"property": "og:image:height",
"content": "630"
},
{
"property": "twitter:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Find+Contacts&logoLight=https%3A%
2F%2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover.png&logoDark=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover-white.png&primaryColor=%2349BC94
&lightColor=%2349BC94&darkColor=%2349BC94"
},
{
"property": "twitter:image:width",
"content": "1200"
},
{
"property": "twitter:image:height",
"content": "630"
}
],
"jsonLd": null,
"headers": {
"age": "402",
"cache-control": "public, max-age=0, must-revalidate",
"content-encoding": "br",
"content-type": "text/html; charset=utf-8",
"date": "Wed, 05 Mar 2025 23:41:45 GMT",
"etag": "W/\"ipg3py2qky62gp\"",
"server": "Vercel",
"strict-transport-security": "max-age=63072000",
"x-frame-options": "DENY",
205
 "x-matched-path": "/_sites/[subdomain]/[[...slug]]",
"x-powered-by": "Next.js",
"x-vercel-cache": "HIT",
"x-vercel-id":
"iad1::iad1::twv7w-1741218508306-5ae7a584a568",
"transfer-encoding": "chunked"
}
},
"screenshotUrl": null,
"text": "Find Contacts - Evolution API Documentation\nPOST
\n/\nchat\n/\nfindContacts\n/\n{instance}\ncurl --request POST
\\ --url https://{server-url}/chat/findContacts/{instance}
\\ --header 'Content-Type: application/json' \\ --header
'apikey: <api-key>' \\ --data '{ \"where\": { \"id\":
\"<string>\" } }'\nAuthorizations\nYour authorization key
header\nPath Parameters\nID of the instance to connect\nBody
\ncurl --request POST \\ --url https://{server-
url}/chat/findContacts/{instance} \\ --header 'Content-Type:
application/json' \\ --header 'apikey: <api-key>' \\ --data
'{ \"where\": { \"id\": \"<string>\" } }'",
"markdown": "# Find Contacts - Evolution API Documentation\n
\nPOST\n\n/\n\nchat\n\n/\n\nfindContacts\n\n/\n\n{instance}\n
\n```\ncurl --request POST \\\n --url https://{server-
url}/chat/findContacts/{instance} \\\n --header 'Content-
Type: application/json' \\\n --header 'apikey: <api-key>'
\\\n --data '{\n \"where\": {\n \"id\":
\"<string>\"\n }\n}'\n```\n\n#### Authorizations\n\nYour
authorization key header\n\n#### Path Parameters\n\nID of the
instance to connect\n\n#### Body\n\n```\ncurl --request POST
\\\n --url https://{server-url}/chat/findContacts/{instance}
\\\n --header 'Content-Type: application/json' \\\n --header
'apikey: <api-key>' \\\n --data '{\n \"where\": {\n \"id
\": \"<string>\"\n }\n}'\n```",
"debug": {
"requestHandlerMode": "http"
}
},
{
"url": "https://doc.evolution-api.com/v1/api-
reference/group-controller/leave-group",
"crawl": {
"loadedUrl": "https://doc.evolution-api.com/v1/api-
reference/group-controller/leave-group",
"loadedTime": "2025-03-05T23:48:29.101Z",
"referrerUrl": "https://doc.evolution-api.com/v1/api-
reference/chat-controller/check-is-whatsapp",
"depth": null
},
"metadata": {
"canonicalUrl": "https://doc.evolution-api.com/v1/api-
reference/group-controller/leave-group",
"title": "Leave Group - Evolution API Documentation",
"description": "Leave group",
"author": null,
"keywords": null,
"languageCode": "en",
"openGraph": [
206
 {
"property": "og:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Leave+Group&description=Leave+gro
up&logoLight=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover.png&logoDark=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover-white.png&primaryColor=%2349BC94&lightColor=%2349BC94
&darkColor=%2349BC94"
},
{
"property": "og:image:width",
"content": "1200"
},
{
"property": "og:image:height",
"content": "630"
},
{
"property": "twitter:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Leave+Group&description=Leave+gro
up&logoLight=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover.png&logoDark=https%3A%2F%2Fmintlify.s3.us-
west-1.amazonaws.com%2Fatendai-eb1f2775%2Fimages%2Fbrand%
2Fcover-white.png&primaryColor=%2349BC94&lightColor=%2349BC94
&darkColor=%2349BC94"
},
{
"property": "twitter:image:width",
"content": "1200"
},
{
"property": "twitter:image:height",
"content": "630"
}
],
"jsonLd": null,
"headers": {
"age": "292",
"cache-control": "public, max-age=0, must-revalidate",
"content-encoding": "br",
"content-type": "text/html; charset=utf-8",
"date": "Wed, 05 Mar 2025 23:43:35 GMT",
"etag": "W/\"oe1zlfom2i5984\"",
"server": "Vercel",
"strict-transport-security": "max-age=63072000",
"x-frame-options": "DENY",
"x-matched-path": "/_sites/[subdomain]/[[...slug]]",
"x-powered-by": "Next.js",
"x-vercel-cache": "HIT",
"x-vercel-id": "iad1::iad1::ckhcf-1741218509038-
ab95613ead36",
"transfer-encoding": "chunked"
}
207
 },
"screenshotUrl": null,
"text": "Leave Group - Evolution API Documentation
\nAuthorizations\nYour authorization key header\nPath
Parameters\nID of the instance to connect\nQuery Parameters",
"markdown": "# Leave Group - Evolution API Documentation\n
\n#### Authorizations\n\nYour authorization key header\n\n####
Path Parameters\n\nID of the instance to connect\n\n#### Query
Parameters",
"debug": {
"requestHandlerMode": "http"
}
},
{
"url": "https://doc.evolution-api.com/v2/api-reference/chat-
controller/find-chats",
"crawl": {
"loadedUrl": "https://doc.evolution-api.com/v2/api-
reference/chat-controller/find-chats",
"loadedTime": "2025-03-05T23:48:29.048Z"
},
"metadata": {
"canonicalUrl": "https://doc.evolution-api.com/v2/api-
reference/chat-controller/find-chats",
"title": "Find Chats - Evolution API Documentation",
"description": null,
"author": null,
"keywords": null,
"languageCode": "en",
"openGraph": [
{
"property": "og:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Find+Chats&logoLight=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover.png&logoDark=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover-white.png&primaryColor=%2349BC94
&lightColor=%2349BC94&darkColor=%2349BC94"
},
{
"property": "og:image:width",
"content": "1200"
},
{
"property": "og:image:height",
"content": "630"
},
{
"property": "twitter:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Find+Chats&logoLight=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover.png&logoDark=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover-white.png&primaryColor=%2349BC94
&lightColor=%2349BC94&darkColor=%2349BC94"
208
 },
{
"property": "twitter:image:width",
"content": "1200"
},
{
"property": "twitter:image:height",
"content": "630"
}
],
"jsonLd": null,
"headers": {
"age": "402",
"cache-control": "public, max-age=0, must-revalidate",
"content-encoding": "br",
"content-type": "text/html; charset=utf-8",
"date": "Wed, 05 Mar 2025 23:41:45 GMT",
"etag": "W/\"14bp19zyjnh5j8l\"",
"server": "Vercel",
"strict-transport-security": "max-age=63072000",
"x-frame-options": "DENY",
"x-matched-path": "/_sites/[subdomain]/[[...slug]]",
"x-powered-by": "Next.js",
"x-vercel-cache": "HIT",
"x-vercel-id":
"iad1::iad1::ckhcf-1741218508987-4ddf32bde0e2",
"transfer-encoding": "chunked"
}
},
"screenshotUrl": null,
"text": "Find Chats - Evolution API Documentation\nInÃcio
\nGET\nGet Information\nInstances\nPOST\nCreate Instance\nGET
\nFetch Instances\nGET\nInstance Connect\nPUT\nRestart
Instance\nGET\nConnection State\nDEL\nLogout Instance\nDEL
\nDelete Instance\nPOST\nSet Presence\nWebhook\nPOST\nSet
Webhook\nGET\nFind Webhook\nSettings\nPOST\nSet Settings\nGET
\nFind Settings\nSend Message\nPOST\nSend Plain Text\nPOST
\nSend Status\nPOST\nSend Media\nPOST\nSend WhatsApp Audio
\nPOST\nSend Sticker\nPOST\nSend Location\nPOST\nSend Contact
\nPOST\nSend Reaction\nPOST\nSend Poll\nPOST\nSend List\nPOST
\nSend Buttons\nChat Controller\nPOST\nCheck is WhatsApp\nPOST
\nMark Message As Read\nPOST\nMark Message As Unread\nPOST
\nArchive Chat\nDEL\nDelete Message for Everyone\nPOST\nUpdate
Message\nPOST\nSend Presence\nPOST\nUpdate Block Status\nPOST
\nFetch Profile Picture URL\nPOST\nGet Base64\nPOST\nFind
Contacts\nPOST\nFind Messages\nPOST\nFind Status Message\nPOST
\nFind Chats\nProfile Settings\nPOST\nFetch Business Profile
\nPOST\nFetch Profile\nPOST\nUpdate Profile Name\nPOST\nUpdate
Profile Status\nPOST\nUpdate Profile Picture\nDEL\nRemove
Profile Picture\nGET\nFetch Privacy Settings\nPOST\nUpdate
Privacy Settings\nGroup Controller\nPOST\nCreate Group\nPOST
\nUpdate Group Picture\nPOST\nUpdate Group Subject\nPOST
\nUpdate Group Description\nGET\nFetch Invite Code\nPOST
\nRevoke Invite Code\nPOST\nSend Group Invite\nGET\nFind Group
by Invite Code\nGET\nFind Group by JID\nGET\nFetch All Groups
\nGET\nFind Group Members\nPOST\nUpdate Group Members\nPOST
\nUpdate Group Setting\nPOST\nToggle Ephemeral\nDEL\nLeave
209
Group\nTypebot\nPOST\nCreate Typebot\nPOST\nStart Typebot\nGET
\nFind Typebot\nGET\nFetch Typebot\nPOST\nUpdate Typebot\nDEL
\nDelete Typebot\nPOST\nChange Session Status\nGET\nFetch
Session Typebot\nPOST\nSettings Typebot\nGET\nFetch Typebot
Settings\nOpenAI\nPOST\nCreate OpenIA Bot\nGET\nFind OpenIA
Bot\nGET\nFind OpenIA Bots\nPUT\nUpdate Bot\nDEL\nDelete
OpenIA Bot\nGET\nFind OpenIA Creds\nPOST\nCreds config OpenAI
\nDEL\nDelete OpenIA Bot\nPOST\nSettigns config OpenAI\nGET
\nFind settings OpenAI\nPOST\nChange status OpenAI\nGET\nFind
sessions OpenAI\nEvolution Bot\nPOST\nCreate Evolution Bot
\nGET\nFind Evolution Bots\nGET\nFetch Evolution Bot\nPUT
\nUpdate Evolution Bot\nDEL\nDelete Evolution Bot\nPOST\nSet
Settings Bot\nGET\nFind Settings Bot\nPOST\nChange Evolution
Bot status\nGET\nFetch Evolution Bot Session\nDify\nPOST
\nCreate Dify Bot\nGET\nFind Dify Bots\nGET\nFind Dify Bot
\nPUT\nUpdate Dify Bot\nPOST\nSet Dify Settings\nGET\nFind
Dify Settings\nPOST\nChange Status Bot\nGET\nFind Status Bot
\nFlowise\nPOST\nCreate Flowise Bot\nGET\nFind Flowise Bots
\nGET\nFind Flowise Bot\nPOST\nUpdate Flowise Bot\nDEL\nDelete
Flowise Bot\nPOST\nSet Settings Flowise Bots\nGET\nFind
Flowise settings\nPOST\nChange Status Session\nGET\nFind
Sessions Flowise\nChatwoot\nPOST\nSet Chatwoot\nGET\nFind
Chatwoot\nWebsocket\nPOST\nSet Websocket\nGET\nFind Websocket
\nSQS\nPOST\nSet SQS\nGET\nFind SQS\nRabbitMQ\nPOST\nSet
RabbitMQ\nGET\nFind RabbitMQ",
"markdown": "# Find Chats - Evolution API Documentation\n
\n##### InÃcio\n\n* [GET\n \n Get Information\n \n
\n \n ](https://doc.evolution-api.com/v2/api-
reference/get-information)\n\n##### Instances\n\n* [POST\n
\n Create Instance\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-reference/instance-
controller/create-instance-basic)\n* [GET\n \n Fetch
Instances\n \n \n \n ](https://doc.evolution-
api.com/v2/api-reference/instance-controller/fetch-
instances)\n* [GET\n \n Instance Connect\n \n \n
\n ](https://doc.evolution-api.com/v2/api-
reference/instance-controller/instance-connect)\n* [PUT\n
\n Restart Instance\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-reference/instance-
controller/restart-instance)\n* [GET\n \n Connection
State\n \n \n \n ](https://doc.evolution-
api.com/v2/api-reference/instance-controller/connection-
state)\n* [DEL\n \n Logout Instance\n \n \n
\n ](https://doc.evolution-api.com/v2/api-
reference/instance-controller/logout-instance)\n* [DEL\n
\n Delete Instance\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-reference/instance-
controller/delete-instance)\n* [POST\n \n Set Presence
\n \n \n \n ](https://doc.evolution-
api.com/v2/api-reference/instance-controller/set-presence)\n
\n##### Webhook\n\n* [POST\n \n Set Webhook\n \n
\n \n ](https://doc.evolution-api.com/v2/api-
reference/webhook/set)\n* [GET\n \n Find Webhook\n
\n \n \n ](https://doc.evolution-api.com/v2/api-
reference/webhook/get)\n\n##### Settings\n\n* [POST\n \n
Set Settings\n \n \n \n ](https://doc.evolution-
api.com/v2/api-reference/settings/set)\n* [GET\n \n
210
Find Settings\n \n \n \n ](https://doc.evolution-
api.com/v2/api-reference/settings/get)\n\n##### Send Message\n
\n* [POST\n \n Send Plain Text\n \n \n
\n ](https://doc.evolution-api.com/v2/api-
reference/message-controller/send-text)\n* [POST\n \n
Send Status\n \n \n \n ](https://doc.evolution-
api.com/v2/api-reference/message-controller/send-status)\n*
[POST\n \n Send Media\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-reference/message-
controller/send-media)\n* [POST\n \n Send WhatsApp
Audio\n \n \n \n ](https://doc.evolution-
api.com/v2/api-reference/message-controller/send-audio)\n*
[POST\n \n Send Sticker\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-reference/message-
controller/send-sticker)\n* [POST\n \n Send Location\n
\n \n \n ](https://doc.evolution-api.com/v2/api-
reference/message-controller/send-location)\n* [POST\n \n
Send Contact\n \n \n \n ](https://doc.evolution-
api.com/v2/api-reference/message-controller/send-contact)\n*
[POST\n \n Send Reaction\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-reference/message-
controller/send-reaction)\n* [POST\n \n Send Poll\n
\n \n \n ](https://doc.evolution-api.com/v2/api-
reference/message-controller/send-poll)\n* [POST\n \n
Send List\n \n \n \n ](https://doc.evolution-
api.com/v2/api-reference/message-controller/send-list)\n*
[POST\n \n Send Buttons\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-reference/message-
controller/send-button)\n\n##### Chat Controller\n\n* [POST
\n \n Check is WhatsApp\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-reference/chat-
controller/check-is-whatsapp)\n* [POST\n \n Mark
Message As Read\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-reference/chat-
controller/mark-as-read)\n* [POST\n \n Mark Message As
Unread\n \n \n \n ](https://doc.evolution-
api.com/v2/api-reference/chat-controller/mark-as-unread)\n*
[POST\n \n Archive Chat\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-reference/chat-
controller/archive-chat)\n* [DEL\n \n Delete Message
for Everyone\n \n \n \n ](https://doc.evolution-
api.com/v2/api-reference/chat-controller/delete-message-for-
everyone)\n* [POST\n \n Update Message\n \n \n
\n ](https://doc.evolution-api.com/v2/api-reference/chat-
controller/update-message)\n* [POST\n \n Send Presence
\n \n \n \n ](https://doc.evolution-
api.com/v2/api-reference/chat-controller/send-presence)\n*
[POST\n \n Update Block Status\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-reference/chat-
controller/updateBlockStatus)\n* [POST\n \n Fetch
Profile Picture URL\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-reference/chat-
controller/fetch-profilepic-url)\n* [POST\n \n Get
Base64\n \n \n \n ](https://doc.evolution-
api.com/v2/api-reference/chat-controller/get-base64)\n*
[POST\n \n Find Contacts\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-reference/chat-
211
controller/find-contacts)\n* [POST\n \n Find Messages
\n \n \n \n ](https://doc.evolution-
api.com/v2/api-reference/chat-controller/find-messages)\n*
[POST\n \n Find Status Message\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-reference/chat-
controller/find-status-message)\n* [POST\n \n Find
Chats\n \n \n \n ](https://doc.evolution-
api.com/v2/api-reference/chat-controller/find-chats)\n\n#####
Profile Settings\n\n* [POST\n \n Fetch Business
Profile\n \n \n \n ](https://doc.evolution-
api.com/v2/api-reference/profile-settings/fetch-business-
profile)\n* [POST\n \n Fetch Profile\n \n \n
\n ](https://doc.evolution-api.com/v2/api-
reference/profile-settings/fetch-profile)\n* [POST\n \n
Update Profile Name\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-reference/profile-
settings/update-profile-name)\n* [POST\n \n Update
Profile Status\n \n \n \n ](https://doc.evolution-
api.com/v2/api-reference/profile-settings/update-profile-
status)\n* [POST\n \n Update Profile Picture\n \n
\n \n ](https://doc.evolution-api.com/v2/api-
reference/profile-settings/update-profile-picture)\n* [DEL\n
\n Remove Profile Picture\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-reference/profile-
settings/remove-profile-picture)\n* [GET\n \n Fetch
Privacy Settings\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-reference/profile-
settings/fetch-privacy-settings)\n* [POST\n \n Update
Privacy Settings\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-reference/profile-
settings/update-privacy-settings)\n\n##### Group Controller\n
\n* [POST\n \n Create Group\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-reference/group-
controller/group-create)\n* [POST\n \n Update Group
Picture\n \n \n \n ](https://doc.evolution-
api.com/v2/api-reference/group-controller/update-group-
picture)\n* [POST\n \n Update Group Subject\n \n
\n \n ](https://doc.evolution-api.com/v2/api-
reference/group-controller/update-group-subject)\n* [POST\n
\n Update Group Description\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-reference/group-
controller/update-group-description)\n* [GET\n \n
Fetch Invite Code\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-reference/group-
controller/fetch-invite-code)\n* [POST\n \n Revoke
Invite Code\n \n \n \n ](https://doc.evolution-
api.com/v2/api-reference/group-controller/revoke-invite-
code)\n* [POST\n \n Send Group Invite\n \n \n
\n ](https://doc.evolution-api.com/v2/api-reference/group-
controller/send-invite-url)\n* [GET\n \n Find Group by
Invite Code\n \n \n \n ](https://doc.evolution-
api.com/v2/api-reference/group-controller/find-group-by-
invite-code)\n* [GET\n \n Find Group by JID\n \n
\n \n ](https://doc.evolution-api.com/v2/api-
reference/group-controller/find-group-by-jid)\n* [GET\n
\n Fetch All Groups\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-reference/group-
212
controller/fetch-all-groups)\n* [GET\n \n Find Group
Members\n \n \n \n ](https://doc.evolution-
api.com/v2/api-reference/group-controller/find-
participants)\n* [POST\n \n Update Group Members\n
\n \n \n ](https://doc.evolution-api.com/v2/api-
reference/group-controller/update-participant)\n* [POST\n
\n Update Group Setting\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-reference/group-
controller/update-setting)\n* [POST\n \n Toggle
Ephemeral\n \n \n \n ](https://doc.evolution-
api.com/v2/api-reference/group-controller/toggle-ephemeral)\n*
[DEL\n \n Leave Group\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-reference/group-
controller/leave-group)\n\n##### Typebot\n\n* [POST\n \n
Create Typebot\n \n \n \n ](https://doc.evolution-
api.com/v2/api-reference/integrations/typebot/set-typebot)\n*
[POST\n \n Start Typebot\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-
reference/integrations/typebot/start-typebot)\n* [GET\n
\n Find Typebot\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-
reference/integrations/typebot/find-typebot)\n* [GET\n \n
Fetch Typebot\n \n \n \n ](https://doc.evolution-
api.com/v2/api-reference/integrations/typebot/fetch-
typebot)\n* [POST\n \n Update Typebot\n \n \n
\n ](https://doc.evolution-api.com/v2/api-
reference/integrations/typebot/update-typebot)\n* [DEL\n
\n Delete Typebot\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-
reference/integrations/typebot/delete-typebot)\n* [POST\n
\n Change Session Status\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-
reference/integrations/typebot/change-session-status)\n*
[GET\n \n Fetch Session Typebot\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-
reference/integrations/typebot/fetch-session)\n* [POST\n
\n Settings Typebot\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-
reference/integrations/typebot/settings-typebot)\n* [GET\n
\n Fetch Typebot Settings\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-
reference/integrations/typebot/find-settings-typebot)\n\n#####
OpenAI\n\n* [POST\n \n Create OpenIA Bot\n \n \n
\n ](https://doc.evolution-api.com/v2/api-
reference/integrations/openai/create-bot)\n* [GET\n \n
Find OpenIA Bot\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-
reference/integrations/openai/find-bot)\n* [GET\n \n
Find OpenIA Bots\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-
reference/integrations/openai/find-bots)\n* [PUT\n \n
Update Bot\n \n \n \n ](https://doc.evolution-
api.com/v2/api-reference/integrations/openai/update-bot)\n*
[DEL\n \n Delete OpenIA Bot\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-
reference/integrations/openai/delete-bot)\n* [GET\n \n
Find OpenIA Creds\n \n \n \n ]
213
(https://doc.evolution-api.com/v2/api-
reference/integrations/openai/find-creds-openai)\n* [POST\n
\n Creds config OpenAI\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-
reference/integrations/openai/set-creds)\n* [DEL\n \n
Delete OpenIA Bot\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-
reference/integrations/openai/delete-creds)\n* [POST\n \n
Settigns config OpenAI\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-
reference/integrations/openai/settings-openai)\n* [GET\n
\n Find settings OpenAI\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-
reference/integrations/openai/find-settings)\n* [POST\n
\n Change status OpenAI\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-
reference/integrations/openai/change-status)\n* [GET\n \n
Find sessions OpenAI\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-
reference/integrations/openai/find-session)\n\n##### Evolution
Bot\n\n* [POST\n \n Create Evolution Bot\n \n \n
\n ](https://doc.evolution-api.com/v2/api-
reference/integrations/evolution/create-bot)\n* [GET\n \n
Find Evolution Bots\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-
reference/integrations/evolution/find-bot)\n* [GET\n \n
Fetch Evolution Bot\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-
reference/integrations/evolution/fetch-bots)\n* [PUT\n \n
Update Evolution Bot\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-
reference/integrations/evolution/update)\n* [DEL\n \n
Delete Evolution Bot\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-
reference/integrations/evolution/delete-bot)\n* [POST\n
\n Set Settings Bot\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-
reference/integrations/evolution/set-settings)\n* [GET\n
\n Find Settings Bot\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-
reference/integrations/evolution/find-settings)\n* [POST\n
\n Change Evolution Bot status\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-
reference/integrations/evolution/change-status-session)\n*
[GET\n \n Fetch Evolution Bot Session\n \n \n
\n ](https://doc.evolution-api.com/v2/api-
reference/integrations/evolution/fetch-session)\n\n##### Dify
\n\n* [POST\n \n Create Dify Bot\n \n \n
\n ](https://doc.evolution-api.com/v2/api-
reference/integrations/dify/create-dify)\n* [GET\n \n
Find Dify Bots\n \n \n \n ](https://doc.evolution-
api.com/v2/api-reference/integrations/dify/find-dify)\n*
[GET\n \n Find Dify Bot\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-
reference/integrations/dify/find-bot-dify)\n* [PUT\n \n
Update Dify Bot\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-
214
reference/integrations/dify/update-dify)\n* [POST\n \n
Set Dify Settings\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-
reference/integrations/dify/set-settings-dify)\n* [GET\n
\n Find Dify Settings\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-
reference/integrations/dify/find-settings)\n* [POST\n \n
Change Status Bot\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-
reference/integrations/dify/change-status)\n* [GET\n \n
Find Status Bot\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-
reference/integrations/dify/find-status)\n\n##### Flowise\n\n*
[POST\n \n Create Flowise Bot\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-
reference/integrations/flowise/create-bot)\n* [GET\n \n
Find Flowise Bots\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-
reference/integrations/flowise/find-flowise-bots)\n* [GET\n
\n Find Flowise Bot\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-
reference/integrations/flowise/find-flowise-bot)\n* [POST\n
\n Update Flowise Bot\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-
reference/integrations/flowise/update-flowise-bot)\n* [DEL\n
\n Delete Flowise Bot\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-
reference/integrations/flowise/delete-flowise-bot)\n* [POST
\n \n Set Settings Flowise Bots\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-
reference/integrations/flowise/set-settings)\n* [GET\n \n
Find Flowise settings\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-
reference/integrations/flowise/find-settings)\n* [POST\n
\n Change Status Session\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-
reference/integrations/flowise/change-session-status)\n*
[GET\n \n Find Sessions Flowise\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-
reference/integrations/flowise/find-sessions)\n\n#####
Chatwoot\n\n* [POST\n \n Set Chatwoot\n \n \n
\n ](https://doc.evolution-api.com/v2/api-
reference/integrations/chatwoot/set-chatwoot)\n* [GET\n
\n Find Chatwoot\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-
reference/integrations/chatwoot/find-chatwoot)\n\n#####
Websocket\n\n* [POST\n \n Set Websocket\n \n \n
\n ](https://doc.evolution-api.com/v2/api-
reference/integrations/websocket/set-websocket)\n* [GET\n
\n Find Websocket\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-
reference/integrations/websocket/find-websocket)\n\n##### SQS
\n\n* [POST\n \n Set SQS\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-
reference/integrations/sqs/set-sqs)\n* [GET\n \n Find
SQS\n \n \n \n ](https://doc.evolution-
api.com/v2/api-reference/integrations/sqs/find-sqs)\n\n#####
215
RabbitMQ\n\n* [POST\n \n Set RabbitMQ\n \n \n
\n ](https://doc.evolution-api.com/v2/api-
reference/integrations/rabbitmq/set-rabbitmq)\n* [GET\n
\n Find RabbitMQ\n \n \n \n ]
(https://doc.evolution-api.com/v2/api-
reference/integrations/rabbitmq/find-rabbitmq)",
"debug": {
"requestHandlerMode": "http"
}
},
{
"url": "https://doc.evolution-api.com/v1/pt/install/docker",
"crawl": {
"loadedUrl": "https://doc.evolution-
api.com/v1/pt/install/docker",
"loadedTime": "2025-03-05T23:48:29.960Z",
"referrerUrl": "https://doc.evolution-api.com/",
"depth": 1
},
"metadata": {
"canonicalUrl": "https://doc.evolution-
api.com/v1/pt/install/docker",
"title": "Docker - Evolution API Documentation",
"description": null,
"author": null,
"keywords": null,
"languageCode": "en",
"openGraph": [
{
"property": "og:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Docker&logoLight=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover.png&logoDark=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover-white.png&primaryColor=%2349BC94
&lightColor=%2349BC94&darkColor=%2349BC94"
},
{
"property": "og:image:width",
"content": "1200"
},
{
"property": "og:image:height",
"content": "630"
},
{
"property": "twitter:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Docker&logoLight=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover.png&logoDark=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover-white.png&primaryColor=%2349BC94
&lightColor=%2349BC94&darkColor=%2349BC94"
},
{
216
 "property": "twitter:image:width",
"content": "1200"
},
{
"property": "twitter:image:height",
"content": "630"
}
],
"jsonLd": null,
"headers": {
"age": "607",
"cache-control": "public, max-age=0, must-revalidate",
"content-encoding": "br",
"content-type": "text/html; charset=utf-8",
"date": "Wed, 05 Mar 2025 23:38:22 GMT",
"etag": "W/\"16nsicub2t756f7\"",
"server": "Vercel",
"strict-transport-security": "max-age=63072000",
"x-frame-options": "DENY",
"x-matched-path": "/_sites/[subdomain]/[[...slug]]",
"x-powered-by": "Next.js",
"x-vercel-cache": "HIT",
"x-vercel-id": "iad1::iad1::cz8vr-1741218509906-
f8ab2379e7f0",
"transfer-encoding": "chunked"
}
},
"screenshotUrl": null,
"text": "Docker - Evolution API Documentation\nO
EvolutionAPI está pronto para o Docker e pode ser facilmente
implantado com o Docker no modo standalone e swarm. O
repositório oficial do EvolutionAPI possui todos os arquivos
de composição necessários para instalar a API.\nDocker Run
\nInÃcio Rápido\nA maneira mais rápida de fazer deploy da
EvolutionAPI com o Docker é usando docker run na interface de
linha de comando.\nIsso executará um contêiner do Docker
expondo a aplicação na porta 8080 e você poderá começar a
testar e solicitar o código QR do WhatsApp usando o conteúdo
da variável de autenticação com o cabeçalho apikey
definido.\nInÃcio Rápido com Volumes\nVocê também pode
fazer deploy usando volumes docker para manter os dados
persistentes da sua EvolutionAPI e todas as instâncias do
WhatsApp em sua máquina local, evitando problemas com a
reinicialização do contêiner usando o docker run na
interface de linha de comando.\nExecute o comando a seguir
para implementar o EvolutionAPI com os volumes necessários.
Este comando mapeia os volumes evolution_store e
evolution_instances para os respectivos diretórios dentro do
contêiner.\nDocker Compose\nFazer deploy da EvolutionAPI
usando o Docker Compose simplifica a configuração e o
gerenciamento de seus contêineres Docker. Ele permite que
você defina seu ambiente Docker em um arquivo docker-
compose.yaml e, em seguida, use um único comando para iniciar
tudo.\nEste é um exemplo do Docker Compose para ambientes
standalone, ou seja, um único servidor em execução. Para a
sincronização de dois servidores em paralelo, use o Swarm.
Isso é para usuários Docker mais avançados.\nStandalone\nO
217
Docker standalone é adequado quando sua API de evolução
será executada apenas em uma máquina e você não
precisará de escalabilidade ou outros recursos do Docker
Swarm por enquanto. É a maneira mais conveniente de usar o
Docker para a maioria das pessoas.\nCrie um arquivo docker-
compose.yml com este conteúdo:\nCrie um arquivo .env no mesmo
diretório com o seguinte:\nNavegue até o diretório que
contém seu arquivo docker-compose.yml e execute: serviços
definidos no arquivo\nEste comando baixará as imagens Docker
necessárias, criará os serviços, redes e volumes definidos
e iniciará o serviço da EvolutionAPI.\nApós executar o
comando docker-compose up, você deve ver os logs indicando
que os serviços estão em execução.\nPara parar o serviço,
utilize:\nAbra seu navegador e acesse http://localhost:8080
para verificar se o EvolutionAPI está operacional.",
"markdown": "# Docker - Evolution API Documentation\n\nO
EvolutionAPI está pronto para o Docker e pode ser facilmente
implantado com o Docker no modo standalone e swarm. O
repositório oficial do EvolutionAPI possui todos os arquivos
de composição necessários para instalar a API.\n\n## Docker
Run\n\n### InÃcio Rápido\n\nA maneira mais rápida de fazer
deploy da EvolutionAPI com o Docker é usando `docker run` na
interface de linha de comando.\n\nIsso executará um
contêiner do Docker expondo a aplicação na porta 8080 e
você poderá começar a testar e solicitar o código QR do
WhatsApp usando o conteúdo da variável de autenticação com
o cabeçalho `apikey` definido.\n\n### InÃcio Rápido com
Volumes\n\nVocê também pode fazer deploy usando volumes
docker para manter os dados persistentes da sua EvolutionAPI e
todas as instâncias do WhatsApp em sua máquina local,
evitando problemas com a reinicialização do contêiner
usando o `docker run` na interface de linha de comando.\n
\nExecute o comando a seguir para implementar o EvolutionAPI
com os volumes necessários. Este comando mapeia os volumes
`evolution_store` e `evolution_instances` para os respectivos
diretórios dentro do contêiner.\n\n## Docker Compose\n
\nFazer deploy da EvolutionAPI usando o Docker Compose
simplifica a configuração e o gerenciamento de seus
contêineres Docker. Ele permite que você defina seu ambiente
Docker em um arquivo `docker-compose.yaml` e, em seguida, use
um único comando para iniciar tudo.\n\nEste é um exemplo do
Docker Compose para ambientes standalone, ou seja, um único
servidor em execução. Para a sincronização de dois
servidores em paralelo, use o Swarm. Isso é para usuários
Docker mais avançados.\n\n### Standalone\n\nO Docker
standalone é adequado quando sua API de evolução
será executada apenas em uma máquina e você não
precisará de escalabilidade ou outros recursos do Docker
Swarm por enquanto. É a maneira mais conveniente de usar o
Docker para a maioria das pessoas.\n\nCrie um arquivo `docker-
compose.yml` com este conteúdo:\n\nCrie um arquivo `.env` no
mesmo diretório com o seguinte:\n\nNavegue até o diretório
que contém seu arquivo docker-compose.yml e execute:
serviços definidos no arquivo\n\nEste comando baixará as
imagens Docker necessárias, criará os serviços, redes e
volumes definidos e iniciará o serviço da EvolutionAPI.\n
\nApós executar o comando docker-compose up, você deve ver
218
os logs indicando que os serviços estão em execução.\n
\nPara parar o serviço, utilize:\n\nAbra seu navegador e
acesse [http://localhost:8080](http://localhost:8080/) para
verificar se o EvolutionAPI está operacional.",
"debug": {
"requestHandlerMode": "http"
}
},
{
"url": "https://doc.evolution-api.com/v1/pt/optional-
resources/websocket",
"crawl": {
"loadedUrl": "https://doc.evolution-
api.com/v1/pt/optional-resources/websocket",
"loadedTime": "2025-03-05T23:48:30.143Z",
"referrerUrl": "https://doc.evolution-api.com/v1/pt/env",
"depth": 2
},
"metadata": {
"canonicalUrl": "https://doc.evolution-
api.com/v1/pt/optional-resources/websocket",
"title": "Websocket - Evolution API Documentation",
"description": null,
"author": null,
"keywords": null,
"languageCode": "en",
"openGraph": [
{
"property": "og:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Websocket&logoLight=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover.png&logoDark=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover-white.png&primaryColor=%2349BC94
&lightColor=%2349BC94&darkColor=%2349BC94"
},
{
"property": "og:image:width",
"content": "1200"
},
{
"property": "og:image:height",
"content": "630"
},
{
"property": "twitter:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Websocket&logoLight=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover.png&logoDark=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover-white.png&primaryColor=%2349BC94
&lightColor=%2349BC94&darkColor=%2349BC94"
},
{
"property": "twitter:image:width",
219
 "content": "1200"
},
{
"property": "twitter:image:height",
"content": "630"
}
],
"jsonLd": null,
"headers": {
"age": "594",
"cache-control": "public, max-age=0, must-revalidate",
"content-encoding": "br",
"content-type": "text/html; charset=utf-8",
"date": "Wed, 05 Mar 2025 23:38:35 GMT",
"etag": "W/\"kis6u3uv9i4z0q\"",
"server": "Vercel",
"strict-transport-security": "max-age=63072000",
"x-frame-options": "DENY",
"x-matched-path": "/_sites/[subdomain]/[[...slug]]",
"x-powered-by": "Next.js",
"x-vercel-cache": "HIT",
"x-vercel-id": "iad1::iad1::cz8vr-1741218510091-
eacf469929d1",
"transfer-encoding": "chunked"
}
},
"screenshotUrl": null,
"text": "Websocket - Evolution API Documentation\nEvolution
API utiliza o socket.io para emitir eventos, aproveitando a
tecnologia WebSocket. Isso torna o desenvolvimento de
integrações mais eficiente e direto para os desenvolvedores.
WebSocket fornece um canal de comunicação full-duplex sobre
uma única conexão duradoura, permitindo o fluxo de dados em
tempo real entre o cliente e o servidor.\nConexão ao
WebSocket\nPara se conectar ao servidor WebSocket na Evolution
API, você pode usar o seguinte formato de URL:\nSubstitua
api.seusite.com pelo domÃnio real da sua API e nome_instancia
pelo nome da sua instância especÃfica.\nExemplo de
Estabelecimento de Conexão WebSocket Aqui está um exemplo
básico de como estabelecer uma conexão WebSocket usando
JavaScript:\nNeste exemplo, substitua nome_evento pelo evento
especÃfico que você deseja escutar.\nManipulando Eventos\nUma
vez conectado, você pode escutar vários eventos emitidos
pelo servidor. Cada evento pode carregar dados relevantes para
o contexto do evento. Por exemplo, se estiver ouvindo
atualizações de mensagens, você pode receber dados contendo
o conteúdo da mensagem atualizada e metadados.\nEnviando
Mensagens\nVocê também pode enviar mensagens para o servidor
usando o método emit:\nFechando a Conexão\nPara fechar a
conexão WebSocket, use o método disconnect:\nLembre-se de
manipular a conexão de forma responsável, desconectando
quando sua aplicação ou componente for desmontado para
evitar vazamentos de memória e garantir o uso eficiente de
recursos.\nAo aproveitar os WebSockets, a Evolution API
oferece uma maneira poderosa de interagir com o sistema em
tempo real, proporcionando uma experiência contÃnua tanto
para desenvolvedores quanto para usuários finais.",
220
 "markdown": "# Websocket - Evolution API Documentation\n
\nEvolution API utiliza o socket.io para emitir eventos,
aproveitando a tecnologia WebSocket. Isso torna o
desenvolvimento de integrações mais eficiente e direto para
os desenvolvedores. WebSocket fornece um canal de comunicaçÃ
£o full-duplex sobre uma única conexão duradoura, permitindo
o fluxo de dados em tempo real entre o cliente e o servidor.\n
\n## Conexão ao WebSocket\n\nPara se conectar ao servidor
WebSocket na Evolution API, você pode usar o seguinte formato
de URL:\n\nSubstitua api.seusite.com pelo domÃnio real da sua
API e nome\\_instancia pelo nome da sua instância especÃfica.
\n\nExemplo de Estabelecimento de Conexão WebSocket Aqui
está um exemplo básico de como estabelecer uma conexão
WebSocket usando JavaScript:\n\nNeste exemplo, substitua
`nome_evento` pelo evento especÃfico que você deseja escutar.
\n\n## Manipulando Eventos\n\nUma vez conectado, você pode
escutar vários eventos emitidos pelo servidor. Cada evento
pode carregar dados relevantes para o contexto do evento. Por
exemplo, se estiver ouvindo atualizações de mensagens, você
pode receber dados contendo o conteúdo da mensagem atualizada
e metadados.\n\n## Enviando Mensagens\n\nVocê também pode
enviar mensagens para o servidor usando o método emit:\n\n##
Fechando a Conexão\n\nPara fechar a conexão WebSocket, use o
método disconnect:\n\nLembre-se de manipular a conexão de
forma responsável, desconectando quando sua aplicação ou
componente for desmontado para evitar vazamentos de memória e
garantir o uso eficiente de recursos.\n\nAo aproveitar os
WebSockets, a Evolution API oferece uma maneira poderosa de
interagir com o sistema em tempo real, proporcionando uma
experiência contÃnua tanto para desenvolvedores quanto para
usuários finais.",
"debug": {
"requestHandlerMode": "http"
}
},
{
"url": "https://doc.evolution-api.com/v1/pt/optional-
resources/redis",
"crawl": {
"loadedUrl": "https://doc.evolution-
api.com/v1/pt/optional-resources/redis",
"loadedTime": "2025-03-05T23:48:30.303Z",
"referrerUrl": "https://doc.evolution-
api.com/v1/pt/optional-resources/rabbitmq",
"depth": null
},
"metadata": {
"canonicalUrl": "https://doc.evolution-
api.com/v1/pt/optional-resources/redis",
"title": "Redis - Evolution API Documentation",
"description": null,
"author": null,
"keywords": null,
"languageCode": "en",
"openGraph": [
{
"property": "og:image",
221
 "content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Redis&logoLight=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover.png&logoDark=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover-white.png&primaryColor=%2349BC94
&lightColor=%2349BC94&darkColor=%2349BC94"
},
{
"property": "og:image:width",
"content": "1200"
},
{
"property": "og:image:height",
"content": "630"
},
{
"property": "twitter:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Redis&logoLight=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover.png&logoDark=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover-white.png&primaryColor=%2349BC94
&lightColor=%2349BC94&darkColor=%2349BC94"
},
{
"property": "twitter:image:width",
"content": "1200"
},
{
"property": "twitter:image:height",
"content": "630"
}
],
"jsonLd": null,
"headers": {
"age": "594",
"cache-control": "public, max-age=0, must-revalidate",
"content-encoding": "br",
"content-type": "text/html; charset=utf-8",
"date": "Wed, 05 Mar 2025 23:38:35 GMT",
"etag": "W/\"16q5d2p7yza43nu\"",
"server": "Vercel",
"strict-transport-security": "max-age=63072000",
"x-frame-options": "DENY",
"x-matched-path": "/_sites/[subdomain]/[[...slug]]",
"x-powered-by": "Next.js",
"x-vercel-cache": "HIT",
"x-vercel-id":
"iad1::iad1::zq2pq-1741218510262-3bb084491a78",
"transfer-encoding": "chunked"
}
},
"screenshotUrl": null,
"text": "Redis - Evolution API Documentation\nConfiguração
\nO Redis é um armazenamento de estrutura de dados em
222
memória, usado como banco de dados, cache e corretor de
mensagens. Ele suporta estruturas de dados como strings,
hashes, listas, conjuntos e muito mais. Incorporar o Redis
pode melhorar significativamente o desempenho da Evolution
API, permitindo acesso mais rápido aos dados e cache
eficiente.\nDefina as variáveis de ambiente do Redis no
arquivo .env para Docker ou no arquivo dev-env.yml para NPM da
seguinte forma:\nVeja mais em Variáveis de ambiente.",
"markdown": "# Redis - Evolution API Documentation\n\n##
Configuração\n\nO Redis é um armazenamento de estrutura de
dados em memória, usado como banco de dados, cache e corretor
de mensagens. Ele suporta estruturas de dados como strings,
hashes, listas, conjuntos e muito mais. Incorporar o Redis
pode melhorar significativamente o desempenho da Evolution
API, permitindo acesso mais rápido aos dados e cache
eficiente.\n\nDefina as variáveis de ambiente do Redis no
arquivo `.env` para Docker ou no arquivo `dev-env.yml` para
NPM da seguinte forma:\n\nVeja mais em [Variáveis de
ambiente](https://doc.evolution-api.com/pt/env#redis).",
"debug": {
"requestHandlerMode": "http"
}
},
{
"url": "https://doc.evolution-api.com/v2/api-
reference/integrations/flowise/delete-flowise-bot",
"crawl": {
"loadedUrl": "https://doc.evolution-api.com/v2/api-
reference/integrations/flowise/delete-flowise-bot",
"loadedTime": "2025-03-05T23:48:31.242Z",
"referrerUrl": "https://doc.evolution-api.com/v2/api-
reference/chat-controller/archive-chat",
"depth": null
},
"metadata": {
"canonicalUrl": "https://doc.evolution-api.com/v2/api-
reference/integrations/flowise/delete-flowise-bot",
"title": "Delete Flowise Bot - Evolution API
Documentation",
"description": null,
"author": null,
"keywords": null,
"languageCode": "en",
"openGraph": [
{
"property": "og:image",
"content": "https://mintlify.com/docs/api/og?
division=Documentation&title=Delete+Flowise+Bot&logoLight=http
s%3A%2F%2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-
eb1f2775%2Fimages%2Fbrand%2Fcover.png&logoDark=https%3A%2F%
2Fmintlify.s3.us-west-1.amazonaws.com%2Fatendai-eb1f2775%
2Fimages%2Fbrand%2Fcover-white.png&primaryColor=%2349BC94
&lightColor=%2349BC94&darkColor=%2349BC94"
},
{
"property": "og:image:width",
"content": "1200"
223
 },
{
"property": "og:image:height",
"content": "630"
},
{
"property": "twitter:image",
"content": "https://appwritefunc.yet-an