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.
Settings
/v1/settings
Use the settings node to configure the WhatsApp Business API Client, your business profile, your profile, groups, your account, and to backup and restore data. Configurable settings include: application settings, profile settings, business profile settings, backup and restore, and two-step verification
Edges
The following edges are connected to this node:
| Edge | Description |
|---|---|
Used to update, retrieve, or reset the application settings of the WhatsApp Business API client. | |
Used to update or retrieve your profile settings. | |
Used to configure the following business profile settings: business address, business description, email for business contact, business industry, and business website. | |
Used to provide and retrieve a business' e-commerce compliance information. | |
Use these to backup and restore information including app settings and registration. | |
Use two-step verification to add an extra layer of security to the WhatsApp Business API Client. |
Before You Start
You must use the admin account to access any settings.
API Calls
| Call | Used To | Returns |
|---|---|---|
Update multiple application settings. | No | |
Get all application settings. | An | |
Reset all application settings. | No | |
Update business profile. | No business | |
Get business profile settings. | Business | |
Update text of business profile (about). | No profile | |
Get text of profile | Profile | |
Update profile photo. | No payload object. | |
Get profile photo. | Binary image content. | |
Enable two-step verification. | No payload object. | |
Disable two-step verification. | No payload object. | |
Export or backup data. | A | |
Import or restore data. | No payload object. | |
Retrieve a business' e-commerce compliance information. | No payload object. | |
Provide e-commerce compliance information for a business. | A |