Business Profile Settings

/v1/settings/business/profile

Use the /v1/settings/business/profile endpoint to configure your business profile settings such as:

  • Business address
  • Business description
  • Email for business contact
  • Business industry
  • Business website

This document covers using API calls in order to:

Some of these settings are configurable using the WhatsApp Busines web tool.

Note: For versions 2.21.6 and earlier, business profile settings could only be configured as a group. Beginning with v2.23, partial updating of the business profile settings is supported, so individual fields in the business profile settings can be set.

You must use the admin account to access the business profile settings.

Update Business Profile Settings

Request

POST /v1/settings/business/profile
{
    "address": "your-business-address",
    "description": "your-business-description",
    "email": "your-business-email",
    "vertical": "your-business-industry",
    "websites": [ "your-website-1", "your-website-2" ]
}

Parameters

NameTypeDescription

address

String

Address of the business
Maximum of 256 characters

description

String

Description of the business
Maximum of 256 characters

email

String

Email address to contact the business
Maximum of 128 characters

vertical

String

Industry of the business
Maximum of 128 characters

websites

Array of strings

URLs associated with business (e.g., website, Facebook page, Instagram)
Maximum of 2 websites with a maximum of 256 characters each

If you need to update a couple of fields with new information, you can now make a request similar to the following, which changes only the address and email fields:

  POST /v1/settings/business/profile
{
    "address": "new-business-address",
    "email": "new-business-email"
}

Response

A successful request returns the HTTP Status Code 200 OK and either null or {}.

If you encounter any errors, see Error and Status Messages.

Retrieve Business Profile Settings

Request

GET /v1/settings/business/profile

Response

A successful response includes the profile object containing the business profile data. The following example includes the new field values changed with the second POST request above.

For more description of the data, see the Parameters list above.

{
   "settings": {
     "business": {
        "profile": {
          "address": "new-business-address",
          "description": "business-description",
          "email": "new-business-email",
          "vertical": "business-industry",
          "websites": [ "website-1", "website-2" ]
        }
      }
}

An empty profile object will be returned if the the business profile is only partially populated. Please upgrade to v2.21.4 to resolve this issue.

If you encounter any errors, see Error and Status Messages.