Skip to main content
PUT
Update session

Authorizations

Authorization
string
header
required

Scoped API key created via POST /api/account/keys.

Path Parameters

session
string
required

Session name

Body

application/json

Fields to update

config
object

Updated session configuration as JSON

Response

OK

config
object

Session configuration as JSON

createdAt
string

When the session was created

name
string

Session identifier (e.g. "default")

proxy
string

HTTP/HTTPS proxy URL for WhatsApp connections

runnerId
string

Runner pod currently managing this session

status
string

Current status: CONNECTING, CONNECTED, or DISCONNECTED

statusReason
string

Reason for the current status (e.g. SCAN_QR, FAILED, LOGGED_OUT)

tenantId
string

Tenant that owns this session

updatedAt
string

When the session was last updated