Get Business Profile
GET https://graph.facebook.com/{{Version}}/{{Phone-Number-ID}}/whatsapp_business_profile
To get information about a business profile, make a GET call to the /{{Phone-Number-ID}}/whatsapp_business_profile
endpoint. Within the whatsapp_business_profile
request, you can specify what you want to know from the business.
Fields
Name | Description |
---|---|
messaging_product | Required. The messaging service used for the request. Always set the value to "whatsapp" if you are using WhatsApp for Business API. |
address | The address of the business. The maximum character limit for the string is 256. |
description | Description of the business. The maximum character limit for the string is 256. |
vertical | Optional. The industry type of the business. This can be either an empty string or one of the accepted values Values: UNDEFINED , OTHER , AUTO , BEAUTY , APPAREL , EDU , ENTERTAIN , EVENT_PLAN , FINANCE , GROCERY , GOVT , HOTEL , HEALTH , NONPROFIT , PROF_SERVICES , RETAIL , TRAVEL , RESTAURANT , or NOT_A_BIZ . |
about | Optional. The text to display in business profile's About section The max length for the string is 139 characters. The minimum length for the string is 1 character. Rendered emojis are supported however their unicode values are not. Emoji unicode values must be Java- or JavaScript-escape encoded. |
email | Optional. The contact email address (in valid email format) of the business. The maximum character limit for the string is 128 characters. |
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. |
profile_picture_handle | Optional. The handle of the profile picture generated from a call to the Resumable Upload API. |
RESPONSES
status: OK
{"data":[{"business_profile":{"messaging_product":"whatsapp","address":"business-address","description":"business-description","vertical":"business-industry","about":"profile-about-text","email":"business-email","websites":["https://website-1","https://website-2"],"profile_picture_url":"\u003cPROFILE_PICTURE_URL\u003e"}}]}