Skip to main content
POST
Start the session

Description

This endpoint initializes a new WhatsApp session. After starting the session, you will need to authenticate it using the QR Code or pairing code. You can provide custom configurations for the session storage and logs.

URL Parameters

session
string
required
Unique session ID to be started

Body

Body Parameters

Status Codes

  • 200 - Session started successfully
  • 400 - Invalid parameters
  • 409 - Session already exists and is active

Usage Example

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 start

Body

application/json

The body is of type object.

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