📌 WhatsApp API without the hassle and nerves! 🤘

Update channel settings

PATCH

/settings

Maintainer:Not configured

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.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

Example

{
    "callback_backoff_delay_ms": 3000,
    "max_callback_backoff_delay_ms": 900000,
    "callback_persist": true,
    "media": {
        "auto_download": [
            "image",
            "document",
            "audio"
        ],
        "init_avatars": true
    },
    "webhooks": [
        {
            "url": "<Webhook URL, http or https>",
            "events": [
                {
                    "type": "ack",
                    "method": "put"
                },
                {
                    "type": "chat",
                    "method": "put"
                }
            ],
            "mode": "method"
        }
    ],
    "on_call_pager": "<WA_ID of valid WhatsApp contact>",
    "pass_through": false,
    "sent_status": false
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PATCH '/settings' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "callback_backoff_delay_ms": 3000,
    "max_callback_backoff_delay_ms": 900000,
    "callback_persist": true,
    "media": {
        "auto_download": [
            "image",
            "document",
            "audio"
        ],
        "init_avatars": true
    },
    "webhooks": [
        {
            "url": "<Webhook URL, http or https>",
            "events": [
                {
                    "type": "ack",
                    "method": "put"
                },
                {
                    "type": "chat",
                    "method": "put"
                }
            ],
            "mode": "method"
        }
    ],
    "on_call_pager": "<WA_ID of valid WhatsApp contact>",
    "pass_through": false,
    "sent_status": false
}'

Responses

🟢200OK

application/json

Body

Example

{
    "before_update": {
        "callback_backoff_delay_ms": 3000,
        "max_callback_backoff_delay_ms": 600000,
        "callback_persist": true,
        "media": {
            "auto_download": [
                "image"
            ],
            "init_avatars": true
        },
        "webhooks": [
            {
                "headers": {
                    "property1": "string",
                    "property2": "string"
                },
                "url": "string",
                "mode": "body",
                "events": [
                    {
                        "type": "message",
                        "method": "put"
                    }
                ]
            }
        ],
        "proxy": "string",
        "mobile_proxy": "string",
        "offline_mode": false,
        "full_history": false
    },
    "after_update": {
        "callback_backoff_delay_ms": 3000,
        "max_callback_backoff_delay_ms": 600000,
        "callback_persist": true,
        "media": {
            "auto_download": [
                "image"
            ],
            "init_avatars": true
        },
        "webhooks": [
            {
                "headers": {
                    "property1": "string",
                    "property2": "string"
                },
                "url": "string",
                "mode": "body",
                "events": [
                    {
                        "type": "message",
                        "method": "put"
                    }
                ]
            }
        ],
        "proxy": "string",
        "mobile_proxy": "string",
        "offline_mode": false,
        "full_history": false
    },
    "changes": [
        "callback_backoff_delay_ms"
    ]
}

🟠400Bad Request

🔴500Server Error

Modified at 2025-03-19 10:29:02

Reset channel settings

Get allowed events