Actions27
- Contact Actions
- Group Actions
- Guardrail Actions
- Message Actions
- Session Actions
Session → Stop
AI-generatedSummary
Stop a WhatsApp session specified by its name or ID, effectively halting its operation within the WhatsApp Gateway.
Inputs
- Session (Name or ID) (required) — The name or ID of the WhatsApp session to stop.
Output shape
a JSON object representing the response from the stop session API call, typically containing confirmation details or status.
The operation sends a POST request to '/api/sessions/{session}/stop'. The exact response shape depends on the API but generally confirms the session has been stopped. This operation requires authentication via 'whatsappGatewayApi' credentials. Errors (other than certain quarantine states) will cause the node to fail.