Update channel settings

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

If a field is not present in the request, no change is made to that setting. For example, if 'proxy' is not sent with the request, the existing configuration for 'proxy' is unchanged.

Body Params

New settings

callback_backoff_delay_ms

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.

max_callback_backoff_delay_ms

number

600000 to 3600000

Maximum delay for a failed callback in milliseconds

callback_persist

boolean

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

media

object

webhooks

array of objects

Webhooks

proxy

string

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

mobile_proxy

string

Service proxy for mobile authorization.

offline_mode

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.

full_history

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.

Responses

Response body

object

before_update

object

required

callback_backoff_delay_ms

number

3000 to 15000

max_callback_backoff_delay_ms

number

600000 to 3600000

Maximum delay for a failed callback in milliseconds

callback_persist

boolean

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

media

object

webhooks

array of objects

Webhooks

object

headers

object

Additional headers for webhook. Max 5 headers.
Example:
"Authorization - Bearer token"
"Content-Type - application/json"
"X-Header - value"

Has additional fields

url

string

required

Inbound and outbound notifications are routed to this URL.

mode

string

Defaults to body

Request method for sending hook.

body path method

events

array of objects

Defaults to [object Object]

Tracked events.
"messages" - got new message/got offline messages/edit message/delete message;
"statuses" - got message status/got offline message status;
"chats" - got chat/chat update/chat remove;
"contacts" - contact update;
"presences" - got presences
"groups" - new group/participants update/group update;
"calls" - got call events
labels" - new label/remove label
"users" - login user/logout user
"channel" - instance status changed/QR-code update
"service" - special notifications

"message", "ack", "chat", "status" - is deprecated, use "messages", "statuses", "chats", "channel" instead.

events

object

type

string

messages statuses chats contacts groups presences calls channel users labels service

method

string

post put delete patch

proxy

string

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

mobile_proxy

string

Service proxy for mobile authorization.

offline_mode

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.

full_history

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.

after_update

object

required

callback_backoff_delay_ms

number

3000 to 15000

max_callback_backoff_delay_ms

number

600000 to 3600000

Maximum delay for a failed callback in milliseconds

callback_persist

boolean

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

media

object

webhooks

array of objects

Webhooks

object

headers

object

Additional headers for webhook. Max 5 headers.
Example:
"Authorization - Bearer token"
"Content-Type - application/json"
"X-Header - value"

Has additional fields

url

string

required

Inbound and outbound notifications are routed to this URL.

mode

string

Defaults to body

Request method for sending hook.

body path method

events

array of objects

Defaults to [object Object]

events

object

type

string

messages statuses chats contacts groups presences calls channel users labels service

method

string

post put delete patch

proxy

string

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

mobile_proxy

string

Service proxy for mobile authorization.

offline_mode

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.

full_history

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.

changes

array of strings

required

changes*

Callback

Language

Credentials

URL


xxxxxxxxxx
10
1
curl --request PATCH \
2
     --url https://gate.whapi.cloud/settings \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "offline_mode": false,
8
  "full_history": false
9
}
10
'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK

400Wrong settings format

500Internal Error