API Reference
  1. WhatsApp API
  2. Channel

Update channel settings

patch
https://gate.whapi.cloud/settings

Omitted settings are reset to their default values, if defined. Settings without defaults remain unchanged.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

New settings

boolean
Defaults to true

It is recommended to disable it for iOS.

number
3000 to 15000

Backoff delay for a failed callback in milliseconds This setting is used to configure the amount of time the backoff delays before retrying a failed callback. The backoff delay increases linearly by this value each time a callback fails to get a HTTPS 200 OK response. The backoff delay is capped by the max_callback_backoff_delay_ms setting.

number
600000 to 3600000

Maximum delay for a failed callback in milliseconds

boolean

Stores callbacks on disk until they are successfully acknowledged by the Webhook or not. Restart required.

media
object
webhooks
array of objects
Webhooks
string
^socks5h?:\/\/(\S+):(\S+)@(((?:[0-9]{1,3}\.){3}[0-9]{1,3})|[a-zA-Z0-9.-]+):([0-9]{1,5})$|^$

Use your Socks5 proxy if your account activity arouses suspicion from WhatsApp. This can help maintain anonymity and ensure smooth operation.

boolean

Helps custom proxies connect to WhatsApp on networks filtered by Netspark/Rimon or NetFree by accepting these providers' certificates. Disabled by default. Contact us if you need support for another provider.

string

Service proxy for mobile authorization. Beta-only parameter; ignored in the production version.

boolean
Defaults to false

When true, API will not send online status to the server on connection. This will allow you to receive push notifications to devices connected to the number. Working after reconnect.

boolean
Defaults to false

When true, all messages will be cached after the connection. If false, old messages will selectively not be cached, allowing large accounts to run faster. Working after reconnect.

boolean
Defaults to false

When enabled, all incoming messages are automatically marked as read as soon as they are received by the API channel. You do not need to mark each message as read manually through the API.

string

Preferred language settings for the channel. Some endpoints may use this value. If left empty, the phone's primary language is used when WhatsApp settings are synced.

string

Fixed 8-character pairing code for link-code authorization. When omitted or empty, a random code is generated for every request.

ignored_presences
array of objects

List of presences to ignore.

ignored_presences
string
enum

Data presentation mode

Allowed:
Responses

Callback

Updated 4 months ago

Did this page help you?
Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 months ago

Did this page help you?