Skip to main content
POST
/
{phone_number_id}
/
whatsapp_business_profile
curl --request POST \
  --url https://api.kapso.ai/meta/whatsapp/v23.0/{phone_number_id}/whatsapp_business_profile \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '{
  "messaging_product": "whatsapp",
  "about": "Welcome to our store! We'\''re here to help you 24/7 with all your shopping needs."
}'
{
  "success": true
}

Authorizations

​
X-API-Key
string
header
required

Project API key for authentication. This is the recommended authentication method.

Get your API key from the Kapso dashboard under Project Settings > API Keys.

Path Parameters

​
phone_number_id
string
required

WhatsApp Business Phone Number ID

Body

application/json
​
messaging_product
enum<string>
required

Always "whatsapp"

Available options:
whatsapp
Example:

"whatsapp"

​
about
string

Business About text (appears in profile beneath image and contact buttons).

  • Must be 1-139 characters
  • Rendered emojis supported (unicode values must be encoded)
  • Hyperlinks included but won't render as clickable
  • Markdown not supported
Required string length: 1 - 139
Example:

"Welcome to our store! We're here to help you 24/7."

​
address
string

Business address (max 256 characters)

Maximum length: 256
Example:

"123 Main Street, San Francisco, CA 94102"

​
description
string

Business description (max 512 characters)

Maximum length: 512
Example:

"Leading provider of premium products and services since 2010. We pride ourselves on exceptional customer service and quality."

​
email
string<email>

Contact email address (max 128 characters)

Maximum length: 128
Example:

"support@example.com"

​
profile_picture_handle
string

Handle from resumable upload API for profile picture

Example:

"h:resumable-upload-handle-abc123xyz789"

​
vertical
enum<string>

Business category displayed in WhatsApp profile:

  • ALCOHOL: Alcoholic Beverages
  • APPAREL: Clothing and Apparel
  • AUTO: Automotive
  • BEAUTY: Beauty, Spa and Salon
  • EDU: Education
  • ENTERTAIN: Entertainment
  • EVENT_PLAN: Event Planning and Service
  • 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 & Gaming
  • OTC_DRUGS: Over-the-Counter Drugs
  • OTHER: Other
  • PHYSICAL_GAMBLING: Non-Online Gambling & Gaming
  • PROF_SERVICES: Professional Services
  • RESTAURANT: Restaurant
  • RETAIL: Shopping and Retail
  • TRAVEL: Travel and Transportation
Available options:
ALCOHOL,
APPAREL,
AUTO,
BEAUTY,
EDU,
ENTERTAIN,
EVENT_PLAN,
FINANCE,
GOVT,
GROCERY,
HEALTH,
HOTEL,
NONPROFIT,
ONLINE_GAMBLING,
OTC_DRUGS,
OTHER,
PHYSICAL_GAMBLING,
PROF_SERVICES,
RESTAURANT,
RETAIL,
TRAVEL
​
websites
string<uri>[]

URLs associated with business (max 2, 256 chars each, must include http:// or https://)

Maximum length: 2
Example:
[
  "https://www.example.com",
  "https://www.instagram.com/example"
]

Response

Business profile updated successfully

​
success
boolean
required

Whether the update succeeded

Example:

true