Skip to main content
POST
Set Proxy

Authorizations

apikey
string
header
required

API Key for authentication (global or instance-specific)

Path Parameters

instanceName
string
required

WhatsApp instance name

Example:

"my-instance"

Body

application/json
enabled
boolean
proxyHost
string
proxyPort
string
proxyProtocol
enum<string>
Available options:
http,
https,
socks4,
socks5
proxyUsername
string
proxyPassword
string

Response

Proxy configured successfully

success
boolean
Example:

true

message
string