Profile Settings

/v1/settings/profile

Update or retrieve your profile settings using the WhatsApp Busines web tool or by using API calls to the /v1/settings/profile endpoints.

This document covers using API calls in order to:

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

Update Profile: About

To update your profile's About section use the /v1/settings/profile/about endpoint.

Request

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

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

Parameters

NameTypeDescription

text

String

Text to display in your profile's About section
The max length for the string is 139 characters.

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.

View Current Profile: About

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 Busines web tool.
  • Use the WhatsApp Business API's /v1/settings/profile/about endpoint to retrieve the text displayed in your profile's About section.

Request

GET /v1/settings/profile/about

Response

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"
      }
    }
  }
}

Update Profile: Photo

To change your profile photo using the API, send the raw image to the /v1/settings/profile/photo endpoint.

Request

The WhatsApp Business API Client will scale and crop uploaded profile photos to be a square with a max edge of 640px and max size of 5MB before uploading to our servers. Images with a height or width of less than 192px may cause issues when the resizing occurs, because of this, an image size of 640x640 is recommended.

Note: Before version v2.19.7 the profile photo max size was restricted to 63kB.

POST /v1/settings/profile/photo
Content-Type: image/jpeg, or other appropriate type

your-binary-image-content

The cURL should look like:

curl -X POST \
  https://your-webapp-hostname:your-webapp-port/v1/settings/profile/photo \
  -H 'Authorization: Bearer your-auth-token \
  'Content-Type: image/png' 
  --data-binary @your-path-to-image

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 Profile Photo

You can retrieve an existing profile photo 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 the profile photo.
  • Use the WhatsApp Busines web tool file picker to view and/or change the photo.
  • Use the WhatsApp Business API's /v1/settings/profile/photo endpoint to retrieve the image that you are using as your profile photo as base64-encoded binary content.

Get the Photo Binary

Request

GET /v1/settings/profile/photo

Response

A successful response contains the base64 encoding of the profile photo.

Content-Type: mage/jpeg, or other appropriate type
Content-Length: content-size

binary-image-content

Delete Profile Photo

Beginning with v2.21.3 you can remove an existing profile photo with the following API call:

DELETE /v1/settings/profile/photo

A successful request returns the HTTP status code 200 OK.