Use the /PHONE_NUMBER_ID/whatsapp_business_profile
endpoint to retrieve and update your business profile. Customers can view your business profile by clicking your business's name or number in a conversation thread.
Endpoint | Authentication |
---|---|
(See Get Phone Number ID ) |
Developers can authenticate their API calls with the access token generated in the App Dashboard > WhatsApp > API Setup . Solution Partners must authenticate themselves with an access token with the |
Within the business profile request, you can specify what you want to know from your business. You have the following options:
about
The business's Abouttext. This text appears in the business's profile, beneath its profile image, phone number, and contact buttons.
address
Address of the business. Character limit 256.
description
Description of the business. Character limit 512.
email
The contact email address (in valid email format) of the business. Character limit 128.
messaging_product
The messaging service used for the request. This value will always be whatsapp
.
profile_picture_url
URL of the profile picture that was uploaded to Meta. Use the profile_picture_handle
parameter to update this value.
vertical
Optional.
Industry of the business. This can be either an empty string or one of the accepted values.
Supported Values
UNDEFINED
OTHER
AUTO
BEAUTY
APPAREL
EDU
ENTERTAIN
EVENT_PLAN
FINANCE
GROCERY
GOVT
HOTEL
HEALTH
NONPROFIT
PROF_SERVICES
RETAIL
TRAVEL
RESTAURANT
NOT_A_BIZ
websites
Optional.
The URLs associated with the business. For instance, a website, Facebook Page, or Instagram. You must include the http://
or https://
portion of the URL.
There is a maximum of 2 websites with a maximum of 256 characters each.
Sample request:
curl \
'https://graph.facebook.com/ v20.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", }] }
All API calls require authentication with access tokens.
Developers can authenticate their API calls with the access token generated in the App Dashboard > WhatsApp > API Setup .
Solution Partners must authenticate themselves with an access token with the whatsapp_business_messaging
and whatsapp_business_management
permissions. See System User Access Tokens
for information.
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.
about
Optional.
The business's Abouttext. This text appears in the business's profile, beneath its profile image, phone number, and contact buttons.
address
Optional.
Address of the business. Character limit 256.
description
Optional.
Description of the business. Character limit 512.
email
Optional.
The contact email address (in valid email format) of the business. Character limit 128.
messaging_product
Required.
The messaging service used for the request. Always set it to "whatsapp" if you are using the WhatsApp Business API.
profile_picture_handle
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 .
vertical
Optional.
Industry of the business. This can be either an empty string or one of the accepted values.
Supported Values
UNDEFINED
OTHER
AUTO
BEAUTY
APPAREL
EDU
ENTERTAIN
EVENT_PLAN
FINANCE
GROCERY
GOVT
HOTEL
HEALTH
NONPROFIT
PROF_SERVICES
RETAIL
TRAVEL
RESTAURANT
NOT_A_BIZ
websites
Optional.
The URLs associated with the business. For instance, a website, Facebook Page, or Instagram. You must include the http://
or https://
portion of the URL.
There is a maximum of 2 websites with a maximum of 256 characters each.
Sample request:
curl -X POST \
'https://graph.facebook.com/ v20.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 .