POST
/
v2
/
sessions
Create or link a WAHA session and start auth
curl --request POST \
  --url https://api-v2.watchcollect.com/v2/sessions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'
{
  "session_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "waha_session_name": "<string>",
  "session_status": "<string>",
  "created": true,
  "started": true,
  "webhook_configured": true,
  "sync_requested": true,
  "request_id": "<string>",
  "event_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "label": "<string>",
  "qr": {
    "value": "<string>",
    "request_id": "<string>"
  },
  "otp": {
    "phone_number": "<string>",
    "method": "<string>",
    "code": "<string>",
    "request_id": "<string>"
  },
  "sync_request_event_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
role
enum<string>
required
Available options:
receiving,
sending
​
engine
enum<string>

Optional WAHA engine. Receiving sessions default to WEBJS; set GOWS only for explicit no-browser receiving tests. Sending sessions must use NOWEB.

Available options:
WEBJS,
NOWEB,
GOWS
​
auth_method
enum<string>

Required when creating a new WAHA session. Optional when linking an existing WAHA session; omitted existing-session links default to qr only if the session still needs pairing.

Available options:
qr,
otp
​
waha_session_name
string

Existing WAHA session name to link. Omit to create a new server-named session.

Example:

"user-user_35eh25qkkIVwab803vgofO1uSsl-receiving"

​
phone_number
string
Example:

"31612345678"

​
otp_method
string

Optional WAHA OTP delivery method. Omit or send an empty string for Web pairing; WAHA also accepts sms or voice for registration OTP delivery.

Example:

""

​
label
string
Example:

"Main receiving session"

Response

Session created or linked and auth started.

​
status
enum<string>
required
Available options:
accepted,
rejected
​
session_id
string<uuid>
required
​
waha_session_name
string
required
​
role
enum<string>
required
Available options:
receiving,
sending
​
engine
enum<string>
required
Available options:
WEBJS,
NOWEB,
GOWS
​
session_status
string
required
​
created
boolean
required
​
started
boolean
required
​
auth_method
enum<string>
required
Available options:
qr,
otp
​
webhook_configured
boolean
required
​
sync_requested
boolean
required
​
request_id
string
required
​
event_ids
string<uuid>[]
​
label
string
​
qr
object
​
otp
object
​
sync_request_event_ids
string<uuid>[]