Profile: About

/v1/settings/profile/about

Use this edge to manage your profile's About section.

Before You Start

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

Retrieving

You can view your profile's About section in the following ways:

• In the WhatsApp app, click on Chat with business account, then click on the name at the top to see the complete contact information, including About.
• Use the WhatsApp Business API's /v1/settings/profile/about endpoint to retrieve the text displayed in your profile's About section.

Example

GET /v1/settings/profile/about

A successful response contains the profile object with the text parameter containing your profile's About content.

{
  "settings": {
    "profile": {
      "about": {
        "text": "your-profile-about-text"
      }
    }
  }
}

Updating

Use to update your profile's About section. Send the text for your profile's About section in the text field of an API call to the /v1/settings/profile/about endpoint.

Example

PATCH /v1/settings/profile/about
{
  "text": "your-profile-about-text"
}

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

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

Parameters