Skip to main content
PATCH
/
v1
/
organization
/
whatsapp
/
phone-numbers
/
{phoneNumberId}
/
business-profile
cURL
curl --request PATCH \
  --url https://api.buildwithchirp.com/v1/organization/whatsapp/phone-numbers/{phoneNumberId}/business-profile \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "about": "We are a company that sells things",
  "address": "123 Main St, San Francisco, CA 94105",
  "description": "We provide excellent products and services...",
  "email": "contact@example.com",
  "websites": [
    "https://www.example.com"
  ],
  "vertical": "RETAIL"
}
'
{
  "success": true
}

Authorizations

​
Authorization
string
header
required

Admin API key (format: sk_admin_*) for organization-level operations

Path Parameters

​
phoneNumberId
string
required

WhatsApp phone number ID (internal Chirp ID)

Example:

"wapn_2DbBs7GWhGvVNJGrDXr5RG0mBWI"

Body

application/json
​
about
string

Short description (max 139 characters)

Maximum string length: 139
Example:

"We are a company that sells things"

​
address
string

Business address

Example:

"123 Main St, San Francisco, CA 94105"

​
description
string

Full business description

Example:

"We provide excellent products and services..."

​
email
string<email>

Business email address

Example:

"contact@example.com"

​
websites
string<uri>[]

Business websites (max 2)

Maximum array length: 2
Example:
["https://www.example.com"]
​
vertical
enum<string>

Business category/vertical

Available options:
UNDEFINED,
OTHER,
AUTO,
BEAUTY,
APPAREL,
EDU,
ENTERTAIN,
EVENT_PLAN,
FINANCE,
GROCERY,
GOVT,
HOTEL,
HEALTH,
NONPROFIT,
PROF_SERVICES,
RETAIL,
RESTAURANT,
TRAVEL,
NOT_A_BIZ
Example:

"RETAIL"

Response

Business profile updated successfully

​
success
enum<boolean>
required
Available options:
true