Graph API Version

Whats App Business Profile Sanitized

Reading

Get data on a WhatsApp business phone profile. Note that you cannot query this endpoint directly. Instead, use the GET /<WHATSAPP_BUSINESS_PHONE_NUMBER_ID>/whatsapp_business_profile endpoint get business profile data.

Example

Graph API Explorer
GET v25.0/...?fields={fieldname_of_type_WhatsAppBusinessProfileSanitized} HTTP/1.1
Host: graph.facebook.com
/* PHP SDK v5.0.0 */
/* make the API call */
try {
  // Returns a `Facebook\FacebookResponse` object
  $response = $fb->get(
    '...?fields={fieldname_of_type_WhatsAppBusinessProfileSanitized}',
    '{access-token}'
  );
} catch(Facebook\Exceptions\FacebookResponseException $e) {
  echo 'Graph returned an error: ' . $e->getMessage();
  exit;
} catch(Facebook\Exceptions\FacebookSDKException $e) {
  echo 'Facebook SDK returned an error: ' . $e->getMessage();
  exit;
}
$graphNode = $response->getGraphNode();
/* handle the result */
/* make the API call */
FB.api(
    "...?fields={fieldname_of_type_WhatsAppBusinessProfileSanitized}",
    function (response) {
      if (response && !response.error) {
        /* handle the result */
      }
    }
);
/* make the API call */
new GraphRequest(
    AccessToken.getCurrentAccessToken(),
    "...?fields={fieldname_of_type_WhatsAppBusinessProfileSanitized}",
    null,
    HttpMethod.GET,
    new GraphRequest.Callback() {
        public void onCompleted(GraphResponse response) {
            /* handle the result */
        }
    }
).executeAsync();
/* make the API call */
FBSDKGraphRequest *request = [[FBSDKGraphRequest alloc]
                               initWithGraphPath:@"...?fields={fieldname_of_type_WhatsAppBusinessProfileSanitized}"
                                      parameters:params
                                      HTTPMethod:@"GET"];
[request startWithCompletionHandler:^(FBSDKGraphRequestConnection *connection,
                                      id result,
                                      NSError *error) {
    // Handle the result
}];
If you want to learn how to use the Graph API, read our Using Graph API guide.

Parameters

This endpoint doesn't have any parameters.

Fields

FieldDescription
about
string

The business's About text.

address
string

Business address. Maximum 256 characters.

description
string

Business description.

email
string

Business email address. Must be in valid email format. Maximum 128 characters.

messaging_product
enum

Messaging product.

profile_picture_url
string

Profile picture URL.

vertical
enum

Business category. These values map to the following strings, which are displayed in the business profile in the WhatsApp client.

  • ALCOHOL = Alcoholic Beverages
  • APPAREL = Clothing and Apparel
  • AUTO = Automotive
  • BEAUTY = Beauty, Spa and Salon
  • EDU = Education
  • ENTERTAIN = Entertainment
  • EVENT_PLAN = Event Planning and Service
  • FINANCE = Finance and Banking
  • GOVT = Public Service
  • GROCERY = Food and Grocery
  • HEALTH = Medical and Health
  • HOTEL = Hotel and Lodging
  • NONPROFIT = Non-profit
  • ONLINE_GAMBLING = Online Gambling & Gaming
  • OTC_DRUGS = Over-the-Counter Drugs
  • OTHER = Other
  • PHYSICAL_GAMBLING = Non-Online Gambling & Gaming (E.g. Brick and mortar)
  • PROF_SERVICES = Professional Services
  • RESTAURANT = Restaurant
  • RETAIL = Shopping and Retail
  • TRAVEL = Travel and Transportation

websites
list<string>

URLs associated with the business, such as a website, Facebook Page, or Instagram profile.

Creating

You can't perform this operation on this endpoint.

Updating

You can update a WhatsAppBusinessProfileSanitized by making a POST request to /{whats_app_business_phone_number_id}/whatsapp_business_profile.

Parameters

ParameterDescription
about
string

The business's About text.

  • Rendered emojis are supported however their unicode values are not. Emoji unicode values must be Java- or JavaScript-escape encoded.
  • Hyperlinks can be included but will not render as clickable links.
  • Markdown is not supported.

Maximum 139 characters.

address
string

Business address. Maximum 256 characters.

description
string

Business description.

  • Rendered emojis are supported however their unicode values are not. Emoji unicode values must be Java- or JavaScript-escape encoded.
  • Hyperlinks can be included but will not render as clickable links. Markdown is not supported.

Maximum 512 characters.

email
string

Business email address. Must be in valid email format. Maximum 128 characters.

messaging_product
enum {WHATSAPP}

Set to whatsapp.

Required
profile_picture_handle
string

Profile picture media asset handle, generated via the Resumable Upload API.

vertical
enum {OTHER, AUTO, BEAUTY, APPAREL, EDU, ENTERTAIN, EVENT_PLAN, FINANCE, GROCERY, GOVT, HOTEL, HEALTH, NONPROFIT, PROF_SERVICES, RETAIL, TRAVEL, RESTAURANT, ALCOHOL, ONLINE_GAMBLING, PHYSICAL_GAMBLING, OTC_DRUGS, MATRIMONY_SERVICE}

Business category. These values map to the following strings, which are displayed in the business profile in the WhatsApp client.

  • ALCOHOL = Alcoholic Beverages
  • APPAREL = Clothing and Apparel
  • AUTO = Automotive
  • BEAUTY = Beauty, Spa and Salon
  • EDU = Education
  • ENTERTAIN = Entertainment
  • EVENT_PLAN = Event Planning and Service
  • FINANCE = Finance and Banking
  • GOVT = Public Service
  • GROCERY = Food and Grocery
  • HEALTH = Medical and Health
  • HOTEL = Hotel and Lodging
  • NONPROFIT = Non-profit
  • ONLINE_GAMBLING = Online Gambling & Gaming
  • OTC_DRUGS = Over-the-Counter Drugs
  • OTHER = Other
  • PHYSICAL_GAMBLING = Non-Online Gambling & Gaming (E.g. Brick and mortar)
  • PROF_SERVICES = Professional Services
  • RESTAURANT = Restaurant
  • RETAIL = Shopping and Retail
  • TRAVEL = Travel and Transportation

websites
array<URI>

URLs associated with the business, such as a website, Facebook Page, or Instagram profile. Strings must be prefixed with http:// or https://.

  • Maximum of 2 strings
  • Maximum 256 characters per string

Return Type

This endpoint supports read-after-write and will read the node to which you POSTed.
Struct {
success: bool,
}

Error Codes

ErrorDescription
100Invalid parameter
200Permissions error
131000Something went wrong
131009Parameter value is not valid
131031Business Account locked
105The number of parameters exceeded the maximum for this operation

Deleting

You can't perform this operation on this endpoint.