Skip to main content
POST
/
api
/
sessions
/
{session}
/
stop
Stop the session
curl --request POST \
  --url https://{host}/api/sessions/{session}/stop \
  --header 'apikey: <api-key>'
{
  "success": true,
  "message": "Session paused successfully",
  "session": "my-session"
}

​
Description

This endpoint pauses an active WhatsApp session. The session will not be disconnected from WhatsApp, only temporarily paused. To disconnect completely, use the logout endpoint.

​
URL Parameters

​
session
string
required
Unique session ID to be paused
{
  "success": true,
  "message": "Session paused successfully",
  "session": "my-session"
}

​
Status Codes

  • 200 - Session paused successfully
  • 400 - Invalid parameters
  • 404 - Session not found
  • 409 - Session is already paused

​
Usage Example

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

Authorizations

​
apikey
string
header
required

Your Wappfy API key (get it at dash.wappfy.com.br)

Path Parameters

​
session
string
required

The session name (instanceName) you want to stop

Response

201 - application/json
​
name
string
required

Session name (instanceName)

Example:

"my-session"

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