Skip to main content
POST
/
api
/
sessions
/
{session}
/
logout
Fazer logout da sessão
curl --request POST \
  --url https://{host}/api/sessions/{session}/logout \
  --header 'apikey: <api-key>'
{
  "success": true,
  "message": "Logout realizado com sucesso",
  "session": "my-session"
}

​
Descrição

Este endpoint desconecta a sessão do WhatsApp, removendo a autenticação no dispositivo móvel. Após o logout, será necessário escanear o QR Code novamente para reconectar. A sessão permanece registrada no sistema, mas sem autenticação.

​
Parâmetros de URL

​
session
string
required
ID único da sessão a ser desconectada
{
  "success": true,
  "message": "Logout realizado com sucesso",
  "session": "my-session"
}

​
Códigos de Status

  • 200 - Logout realizado com sucesso
  • 400 - Parâmetros inválidos
  • 404 - Sessão não encontrada
  • 409 - Sessão não está autenticada

​
Exemplo de Uso

curl -X POST https://api.wappfy.com.br/api/sessions/my-session/logout

Authorizations

​
apikey
string
header
required

Sua chave de API do Wappfy (obtenha em dash.wappfy.com.br)

Path Parameters

​
session
string
required

O nome da sessão (instanceName) da qual você deseja fazer logout

Response

201 - application/json
​
name
string
required

Nome da sessão (instanceName)

Example:

"my-session"

​
status
enum<string>
required
Available options:
STOPPED,
STARTING,
SCAN_QR_CODE,
WORKING,
FAILED
​
config
object
⌘I