Business profile

Last update: 6 hours ago by Irais Aguirre

Integration summary
Base URL: https://{{url}}/whatsapp-bsp-admin-ext-endpoint-ws/services
Token: admin token, in the Authorization: Bearer {{admin-token}} header (how to generate it)
Endpoints on this page:
GET /v1/profile: Get business profile
POST /v1/profile: Update business profile

Get and update the business profile of a phone number: about text, address, description, email, category and websites.

Get business profile

Request

Get business profile request:


URL	https://{{url}}/whatsapp-bsp-admin-ext-endpoint-ws/services/v1/profile
Method	GET

Headers

Get business profile headers:

Name	Description	Type	Requirements
Authorization	Admin token. See Generate authentication token.	String	Required
phone_number_id	Business phone number, including country code. Example: 5215500000000.	String	Required

Example

Complete Get business profile example:

curl --location 'https://{{url}}/whatsapp-bsp-admin-ext-endpoint-ws/services/v1/profile' \
--header 'phone_number_id: 5215500000000' \
--header 'Authorization: Bearer {{admin-token}}'

Response

Get business profile response:

Name	Description	Type
about	The business's "About" text. It appears in the profile, below the profile picture, phone number and contact buttons.	String
address	Business address.	String
description	Business description.	String
email	Business email address.	String
vertical	Business category.	String
websites	URLs associated with the business, such as its website or its Facebook or Instagram page. Include http:// or https://.	Array
profile_picture_url	Profile picture URL.	String

{
    "about": "<Business Profile About>",
    "address": "<Business Profile Address>",
    "description": "<Business Profile Description>",
    "email": "<Business Profile Email>",
    "profile_picture_url": "https://pps.whatsapp.net/v/t61.24694-24/628788792_1980972062842455_4262174738568759725_n.jpg",
    "vertical": "<Business Profile Vertical>",
    "websites": ["https://www.whatsapp.com", "https://www.facebook.com"]
}

Update business profile

Request

Update business profile request:


URL	https://{{url}}/whatsapp-bsp-admin-ext-endpoint-ws/services/v1/profile
Method	POST
Type	application/json

Headers

Update business profile headers:

Name	Description	Type	Requirements
Content-Type	application/json	String	Required
Authorization	Admin token. See Generate authentication token.	String	Required
phone_number_id	Business phone number, including country code. Example: 5215500000000.	String	Required

Body

Update business profile body fields:

Name	Description	Type	Requirements
about	The business's "About" text. It appears in the profile, below the profile picture, phone number and contact buttons.	String	Optional. Up to 139 characters. Emojis are supported, but not their Unicode values (encode them with Java or JavaScript). You can include links, but they aren't shown as clickable. Formatting isn't supported.
address	Business address.	String	Optional. Up to 256 characters.
description	Business description.	String	Optional. Up to 256 characters.
email	Business email address.	String	Optional. Up to 128 characters.
profile_picture_url	URL of the business profile picture.	String	Optional.
vertical	Business category. Possible values: ALCOHOL: Alcoholic beverages APPAREL: Clothing and apparel AUTO: Automotive BEAUTY: Beauty, spa and salon EDU: Education ENTERTAIN: Entertainment EVENT_PLAN: Event planning and services 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 and gaming OTC_DRUGS: Over-the-counter drugs OTHER: Other PHYSICAL_GAMBLING: Non-online gambling and gaming (for example, a physical venue) PROF_SERVICES: Professional services RESTAURANT: Restaurant RETAIL: Shopping and retail TRAVEL: Travel and transportation	String	Optional. Can be an empty string or one of the listed values.
websites	URLs associated with the business, such as its website or its Facebook or Instagram page. Include http:// or https://.	Array	Optional. Up to 2 websites, each up to 256 characters (validated by Meta).

Note: the allowed vertical values and the websites limits are validated by Meta, not by this service.

Example

Complete Update business profile example:

curl --location 'https://{{url}}/whatsapp-bsp-admin-ext-endpoint-ws/services/v1/profile' \
--header 'Content-Type: application/json' \
--header 'phone_number_id: 5215500000000' \
--header 'Authorization: Bearer {{admin-token}}' \
--data '{
    "about": "<Business Profile About>",
    "address": "<Business Profile Address>",
    "description": "<Business Profile Description>",
    "email": "<Business Profile Email>",
    "vertical": "RETAIL",
    "websites": ["https://www.whatsapp.com", "https://www.facebook.com"]
}'

Response

Update business profile response:

Name	Description	Type
code	Response code. If the request succeeds, the value is 0.	Integer
detail	Response detail. If the request succeeds, the value is "Success".	String

{
    "code": 0,
    "detail": "Success"
}

WhatsApp — Previous

Profile and logo

Profile picture