Restore Settings
POST {{URL}}/v1/settings/restore
Restore can be used to set up a new version of the WhatsApp Business API Client on a new machine or restore the application to a known working state on the same machine with the same encryption information and settings of a previous setup.
For setting up the application on a new machine, the Coreapp must be running, but not registered. Upon successful import, the Coreapp automatically initializes itself and starts serving requests. If the machine has an existing application and you do a restore, the application stops and you have to start it again with the
docker restart
command.
When restoring a multiconnect setup , you need to perform the restore on top of the same type of setup you are restoring from. For example, if you backed up a setup with two shards running, you must have two shards running for the restore.
To restore settings, use the
/v1/settings/restore
endpoint with the password and data fields.
Request Parameters
| Name | Description |
|---|---|
password
Type: String |
The password you used in the
/v1/settings/backup
(
Backup Settings
) API call to encrypt the backup data.
|
data
Type: String |
The data that was returned by the
/v1/settings/backup
(
Backup Settings
) API call.
|
A successful request returns the HTTP Status
Code 200 OK
and either
null
or
{}
. If you encounter any errors, see
Error and Status Messages
.
Request Body
{"password"=>"<Password for Backup>", "data"=>"<Data to Restore, from Backup API>"}
HEADERS
| Key | Datatype | Required | Description |
| Content-Type | string | | |
| Authorization | string | | |
RESPONSES
status: OK
{"meta":{"api_status":"stable","version":"v2.45.1"}}