Sign in

v1

latestOpenAPI 3.0.02026-07-1355113123.3 KB
Application

Update-Application-Settings

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.

patch/settings/application

Request body

callback_backoff_delay_msstring

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_msstring

Maximum delay for a failed callback in milliseconds

callback_persistboolean

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

on_call_pagerstring

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

pass_throughboolean

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.

sent_statusboolean

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.

unhealthy_intervalinteger

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.

heartbeat_intervalinteger

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

Example request

{
  "callback_backoff_delay_ms": 3000,
  "max_callback_backoff_delay_ms": 900000,
  "callback_persist": true,
  "media": {
    "auto_download": [
      "image",
      "document",
      "audio"
    ]
  },
  "webhooks": {
    "url": "<Webhook URL, https>",
    "max_concurrent_requests": 12
  },
  "on_call_pager": "<WA_ID of valid WhatsApp contact>",
  "pass_through": false,
  "sent_status": false
}

Response

Example response

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