Update-Application-Settings

http://whatsapp.local

PATCH

/settings/application

Application

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

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PATCH 'http://whatsapp.local/settings/application' \
--header 'Content-Type: application/json' \
--data-raw '{
    "webhooks": {
        "url": "<Webhook URL, https>"
    }
}'

Response Example

{
  "errors": [
    {
      "code": 1234,
      "details": "optional-detailed-error-message",
      "title": "error-code-title"
    }
  ],
  "meta": {
    "api_status": "deprecated",
    "version": "whatsapp-business-api-client-version"
  }
}

Request

Body Params application/json

callback_backoff_delay_ms

string

optional

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.

Default:

3000

callback_persist

boolean

optional

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

Default:

true

heartbeat_interval

integer

optional

Multiconnect: Interval of the Master node monitoring of Coreapp nodes in seconds

Default:

max_callback_backoff_delay_ms

string

optional

Maximum delay for a failed callback in milliseconds

Default:

900000

media

object (Media)

optional

Example:

{"auto_download":["image","document","audio"]}

auto_download

array[string]

required

An array specifying which types of media to automatically download.

Allowed values:

audiodocumentvoicevideoimage.

on_call_pager

string

optional

Set to valid WhatsApp Group with users who wish to see alerts for critical errors and messages.

pass_through

boolean

optional

When true, removes messages from the local database after they are delivered to or read by the recipient. When false, saves all messages on local storage until they are explicitly deleted.
When messages are sent, they are stored in a local database. This database is used as the application's history. Since the business keeps its own history, you can specify whether you want message pass_through or not. Restart required.

Default:

true

sent_status

boolean

optional

Receive a notification that a message is sent to server. When true, you will receive a message indicating that a message has been sent. If false (default), you will not receive notification.

Default:

false

unhealthy_interval

integer

optional

Multiconnect: Maximum amount of seconds a Master node waits for a Coreapp node to respond to a heartbeat before considering it unhealthy and starting the failover process.

Default:

webhooks

object (Webhooks)

optional

Example:

{"max_concurrent_requests":12,"url":"<Webhook URL, https>"}

max_concurrent_requests

enum<integer> <int32>

optional

Configures the maximum number of inflight callback requests that are sent out. Can be set to 6 (default), 12, 18, or 24.

Allowed values:

6121824

Default:

url

string

optional

Inbound and outbound notifications are routed to this URL. A HTTPS-based endpoint is required; HTTP will not work.

Examples

Responses

🟢200Success

application/json

Body

errors

array[object (Error) {4}]

optional

Only returned with a failed request. Contains an array of error objects that are present when there is an error.

code

integer <int32>

optional

See the https://developers.facebook.com/docs/whatsapp/api/errors for more information.

details

string

optional

error detail

href

string

optional

location for error detail

title

string

optional

error title