Use the GET /<WHATSAPP_BUSINESS_PHONE_NUMBER_ID>/whatsapp_business_profile endpoint to get your business phone number's business profile. WhatsApp users can view your business profile by clicking your business's name or number in a WhatsApp message thread.
Sample request:
curl \
'https://graph.facebook.com/v22.0
/FROM_PHONE_NUMBER_ID/whatsapp_business_profile?fields=about,address,description,email,profile_picture_url,websites,vertical' \
-H 'Authorization: Bearer ACCESS_TOKEN'
Sample response:
{ "data": [{ "about": "ABOUT", "address": "ADDRESS", "description": "DESCRIPTION", "email": "EMAIL", "messaging_product": "whatsapp", "profile_picture_url": "https://URL", "websites": [ "https://WEBSITE-1", "https://WEBSITE-2" ], "vertical": "INDUSTRY", }] }
To update your profile, make a POST
call to /PHONE_NUMBER_ID/whatsapp_business_profile
. In your request, you can include the parameters listed below.
Name | Description (Click the arrow in the left column for supported values.) |
---|---|
| Optional. The business's About text. This text appears in the business's profile, beneath its profile image, phone number, and contact buttons.
|
| Optional. Address of the business. Character limit 256. |
| Optional. Description of the business. Character limit 512. |
| Optional. The contact email address (in valid email format) of the business. Character limit 128. |
| Required. The messaging service used for the request. Always set it to "whatsapp" if you are using the WhatsApp Business API. |
| Optional. Handle of the profile picture. This handle is generated when you upload the binary file for the profile picture to Meta using the Resumable Upload API. |
| Optional. Business category. This can be either an empty string or one of the accepted values below. These values map to the following strings, which are displayed in the business profile in the WhatsApp client. |
| Optional. The URLs associated with the business. For instance, a website, Facebook Page, or Instagram. You must include the There is a maximum of 2 websites with a maximum of 256 characters each. |
Sample request:
curl -X POST \
'https://graph.facebook.com/v22.0
/PHONE_NUMBER_ID/whatsapp_business_profile' \
-H 'Authorization: Bearer ACCESS_TOKEN' \
-H 'Content-Type: application/json' \
-d '{
"messaging_product": "whatsapp",
"about": "ABOUT",
"address": "ADDRESS",
"description": "DESCRIPTION",
"vertical": "INDUSTRY",
"email": "EMAIL",
"websites": [
"https://WEBSITE-1",
"https://WEBSITE-2"
],
"profile_picture_handle": "HANDLE_OF_PROFILE_PICTURE"
Sample response:
{ "success": true }
To delete your business profile, you must delete your phone number.