Migrate Account

POST https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/register

To migrate your account, make a POST call to the /{{Phone-Number-ID}}/register endpoint and include the parameters listed below.

Your request may take as long as 15 seconds to finish. During this period, your on-premise deployment is automatically disconnected from WhatsApp server and shutdown; the business account will start up in the cloud-hosted service at the same time. After the request finishes successfully, you can send messages immediately.

Request Parameters

NameDescription
messaging_productRequired.
Messaging service used for the request. For account migration, always use "whatsapp".
pinRequired.
A 6-digit pin you have previously set up — See Set Two-Step Verification If you use the wrong pin, your on-premise deployment will be down and will be disconnected from the WhatsApp servers.
If you haven't set up or you have disabled two-step verification, provide a random 6-digit pin in the request, and this will be used to enable two-step verification in the WhatsApp Business Cloud-Based API.
backup.dataRequired.
The data value you get when you backup your on-premise deployment. This contains the account registration info and application settings.
For more information, see Backup and Restore to backup your on-premise implementation.
backup.passwordRequired.
The password you used in the backup API of your On-Premise deployment.

Request Body

{"messaging_product"=>"whatsapp", "pin"=>"6-digit-pin", "backup"=>{"data"=>"backup_data", "password"=>"password"}}

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring

RESPONSES

status: OK

{"success":"true"}