Update app business profile

Updates the WhatsApp business profile fields shown to end users — description, address, industry, email, and website.

Request parameters

Path parameters

KeyDescriptionValuesData TypeRequired/Optional
appIdPartner app UUID6f414190-d45c-4671-bca1-fb6c3018cb13StringRequired

Body

KeyDescriptionValuesData TypeRequired/Optional
businessNameRegistered business name shown on the WhatsApp business profile.Acme Support—Optional
descriptionShort description of the business, shown on its profile.We help customers 24/7—Optional
emailContact email published on the profile.[email protected]—Optional
websiteBusiness website published on the profile.https://acme.example—Optional
verticalBusiness verticalRETAIL—Optional
businessPhoneCodeCountry dialling code for the business contact number, without the plus sign.91—Optional
businessPhoneNumberBusiness contact number, without the country code.98XXXXXX10—Optional
streetAddress1First line of the registered business address.123—Optional
streetAddress2Second line of the address — suite, floor or unit.Suite 4—Optional
cityCity of the registered business address.Mumbai—Optional
stateState or region of the registered business address.MH—Optional
zipPostalPostal or ZIP code of the registered business address.400001—Optional
countryISO 3166-1 alpha-2 country code of the registered business address.IN—Optional
timezoneIANA timezone the business operates in, used for scheduling and reporting.Asia/Kolkata—Optional
phoneDisplayNameDisplay name on WhatsAppAcme Support—Optional
aboutThe About text shown at the top of the chat.Customer support hours 9am–6pm—Optional

Sample cURL — Update app business profile.

curl --request PUT \
  --url 'https://partner.gupshup.io/partner/bizgate/app/6f414190-d45c-4671-bca1-fb6c3018cb13/profile' \
  --header 'Authorization: Bearer <UT>' \
  --header 'Accept: application/json' \
  --data-urlencode 'businessName=Acme Support' \
  --data-urlencode 'description=We help customers 24/7' \
  --data-urlencode '[email protected]' \
  --data-urlencode 'website=https://acme.example' \
  --data-urlencode 'vertical=RETAIL' \
  --data-urlencode 'businessPhoneCode=91' \
  --data-urlencode 'businessPhoneNumber=98XXXXXX10' \
  --data-urlencode 'streetAddress1=123' \
  --data-urlencode 'streetAddress2=Suite 4' \
  --data-urlencode 'city=Mumbai' \
  --data-urlencode 'state=MH' \
  --data-urlencode 'zipPostal=400001' \
  --data-urlencode 'country=IN' \
  --data-urlencode 'timezone=Asia/Kolkata' \
  --data-urlencode 'phoneDisplayName=Acme Support' \
  --data-urlencode 'about=Customer support hours 9am–6pm'

Sample success response (200)

{
  "status": "success",
  "data": {
    "messaging_product": "whatsapp",
    "about": "Customer support",
    "address": "123 Main Street, Mumbai",
    "description": "We help customers 24/7",
    "email": "[email protected]",
    "websites": [
      "https://acme.example"
    ],
    "vertical": "RETAIL"
  }
}
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Partner app UUID

Form Data

Update WhatsApp business profile (application/x-www-form-urlencoded). Authorize with partner JWT or Universal Token (UT).

string

Registered business name shown on the WhatsApp business profile.

string

Short description of the business, shown on its profile.

string

Contact email published on the profile.

string

Business website published on the profile.

string

Business vertical

string

Country dialling code for the business contact number, without the plus sign.

string

Business contact number, without the country code.

string

First line of the registered business address.

string

Second line of the address — suite, floor or unit.

string

City of the registered business address.

string

State or region of the registered business address.

string

Postal or ZIP code of the registered business address.

string

ISO 3166-1 alpha-2 country code of the registered business address.

string

IANA timezone the business operates in, used for scheduling and reporting.

string

Display name on WhatsApp

string

The About text shown at the top of the chat.

Responses

Language
Credentials
Bearer
Universal Token (UT)
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json