We are sunsetting On-Premises API. Refer to our On-Premises API Sunset document for details, and to learn how to migrate to our next-generation Cloud API.
The application settings for your WhatsApp Business On-Premises client.
admin
account200 OK HTTPS
Get the current application settings for your WhatsApp Business On-Premises client
Send a GET
request to the /v1/settings/application
endpoint to get the current application settings.
GET /v1/settings/application
On success, the response contains 200 OK
and a JSON payload containing an application
object listing all the current application settings and their values.
{ "settings": { "application": { "callback_backoff_delay_ms": 3000, "callback_persist": true, "garbagecollector_enable": { "media": false, "messages": true }, "heartbeat_interval": 5, "max_callback_backoff_delay_ms": 900000, "media": { "auto_download": [ "image", "video", "voice", "sticker", "audio", "document" ] }, "notify_user_change_number": true, "show_security_notifications": true, "unhealthy_interval": 30, "wa_id": "16315551019", "webhooks": { "url": "<Webhook URL, https>", "max_concurrent_requests": max-concurrent-requests, "message": { // Available for v2.41.2 and above "sent": true, "delivered": true, "read": false }, }, "verbose_logging": false, "log_level" : "info" }, }, "meta": { "api_status": "stable", "version": "3.0.1" } }
Edge | Description |
---|---|
Use to manage a list of media providers for sending media links. |
To update your application settings, send a PATCH
request to the /v1/settings/application
endpoint with a JSON object containing the field names and values to be set.
For messaging campaigns involving a large volume of messages, it is recommended that you disable automatic garbage collection by setting garbagecollector_enable.messages
to false
, and reenabling it after the campaign ends by setting it back to true
.
You can verify if automatic garbage collection is disabled by sending a GET
request to /v1/settings/application
endpoint and reading the garbagecollector_enable
property.
PATCH /v1/settings/application { "callback_persist": true | false, "max_callback_backoff_delay_ms": max-delay-in-ms, "media": { "auto_download": ["audio", "document", "voice", "video", "image", "sticker"] } "callback_backoff_delay_ms": "delay-in-ms", "heartbeat_interval": heartbeat-interval-in-secs, "unhealthy_interval": unhealthy-interval-in-secs, "webhooks": { # See the Webhooks Parameters table below for more information "max_concurrent_requests": max-concurrent-requests, "url": "<Webhook URL, https>", "message": { // Available on v2.41.2 and above "sent": false, "delivered": true, "read": false }, }, "axolotl_context_striping_disabled": false | true, "notify_user_change_number": false | true, "show_security_notifications": false | true, # Available on v2.49.1 and above "garbagecollector_enable": { "messages": true | false, "media": true | false } "skip_referral_media_download": true | false, "webhook_payload_conversation_pricingmodel_disabled": false | true # Available on v2.51.1 and above "verbose_logging": false | true, "log_level" : log-level-str, }
On success, the response contains 200 OK
with a null
or a JSON object.
If you encounter any errors, see Error and Status Messages.
Some settings require that the Coreapp be restarted in order for the changes to go into effect. Those settings are callback_persist
, garbagecollector_enable
, verbose_logging
, log_level
and webhooks.max_concurrent_requests
.
Name | Description |
---|---|
type: Boolean | Affects database connection limits. Outbound and inbound performance improved with Values: Coreapp restart required. |
type: String | 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 Default: 3000 |
type: Boolean | Stores callbacks on disk until they are successfully acknowledged by the Webhook or not. Messages and callbacks are both stored in a local database to ensure that they are delivered successfully before being removed from the local database. This protects the callbacks in the event the WhatsApp Business API client or server goes down. Values: |
type: Boolean | This field has been deprecated with v2.49. Enables automatic garbage collection of the messages database to assist in database management. This parameter is Values: Coreapp restart required. |
type: Garbage collector Object | Enables automatic garbage collection of the messages and media. Messages and media garbage collection setting is recommended to ensure old/unused rows and files are removed. If disabled, garbage collector may be initiated using Coreapp restart required. |
type: Integer | Interval of the Master node monitoring of Coreapp nodes in seconds. Default: 5 |
type: String | Maximum delay for a failed callback in milliseconds. For more information, read the description for Default: 900000 |
type: Array | List of media to auto-download. See Auto-download Media Settings for more information. |
type: Boolean | Affects the Values: |
type: Boolean | Starting with v2.35, you can no longer re-enable the Allows for individual messages to be deleted or stored to a local database after they've been delivered or read. 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
We recommend you disable Values: Coreapp restart required. |
type: Boolean | If enabled, you will receive a Values: |
type: Boolean | If set to Default: |
type: Integer | 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: 30 |
type: Boolean | This field has been deprecated with v2.39. Controls inclusion of conversation and pricing information payloads in message status notifications. Values: Coreapp restart is not required. |
type: Webhooks Object | Required when you are using Webhooks. Provide the URL for your Webhook. If the Webhook URL is not set, then callbacks are dropped. See the Sample Testing App for a simple way to see and test your Webhooks. You can validate Webhook events by specifying a shared secret as a query parameter when you set the Webhook URL. Example: The Webhook URL. For example: If the Webhook URL is not set, callbacks are dropped. Callbacks are an important channel to deliver both timely notifications as well as out-of-band errors, and it is thus highly recommended you configure the Webhook URL endpoint. For details on the Webhook fields, see the Webhooks Parameters table below. |
`log_level`
type: Boolean | Enables verbose logging in coreapps. This logging level should be only used for testing because of the high output volume. If set to Values: |
type: Webhooks Object | Configures the logging level in coreapps. Each level gradually reduces the amount of logs output: Values: |
Name | Description |
---|---|
type: Integer | Configures the maximum number of inflight callback requests that are sent out. Values: |
type: String | Inbound and outbound notifications are routed to this URL. For more information, see the Webhooks documentation. An HTTPS-based endpoint is required; HTTP will not work. |
type: Messages Object Available in v2.41.2 and above | Nested within the The business can elect to receive these webhook notifications or not by setting the values to either |
Name | Description |
---|---|
type: Array | Specifies which types of media to automatically download. Values: |
Name | Description |
---|---|
type: Bool | Configures the messages garbage collection. Values: |
type: Bool | Configures the media garbage collection. Values: |
To reset all applications settings to their default values, send a DELETE
request to the /v1/settings/application
endpoint.
DELETE /v1/settings/application
On success, the response contains 200 OK
with null
or {}
.
If you encounter any errors, see Error and Status Messages.