Update business profile with the WhatsApp API

Updates the business profile of a phone number. Fields left out keep their value, and websites replaces the websites of the profile.

Identifier
whatsapp_update_business_profile

The request

POST https://connect.reportei.com/api/tools/whatsapp_update_business_profile/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "phone_number_id": "<phone_number_id>",
    "messaging_product": "whatsapp"
  }
}

Your system sends your customer's connection id and the tool arguments. The headers are the same as the rest of the Connect API: your product's token and your customer's token.

Parameters

ParameterTypeRequiredDescription
phone_number_idstringYesId of the business phone number, from List phone numbers.
messaging_productstringYesAlways whatsapp.Values: whatsapp
aboutstringNoShort text shown under the name, up to 139 characters.
addressstringNoAddress of the business, up to 256 characters.
descriptionstringNoDescription of the business, up to 256 characters.
emailstringNoContact email of the business.
websitesarrayNoUp to 2 websites, with http or https.
verticalstringNoIndustry of the business.Values: OTHER, AUTO, BEAUTY, APPAREL, EDU, ENTERTAIN, EVENT_PLAN, FINANCE, GROCERY, GOVT, HOTEL, HEALTH, NONPROFIT, PROF_SERVICES, RETAIL, TRAVEL, RESTAURANT, ALCOHOL, ONLINE_GAMBLING, PHYSICAL_GAMBLING, OTC_DRUGS

Supported connections

Your customer connects their WhatsApp account once, with one of the modes below. The same connection serves every tool of the toolkit.

API key

Your customer pastes the app's key on a Connect screen, or your system sends the key with POST /api/customer-toolkits, with no screen.

The response

On success, Connect preserves the app's response status and body. HTTP errors returned by the app use the {error, api_error} envelope; authentication or validation can fail before execution. The X-Toolkit-Execution-Id header identifies the recorded execution, available at GET /api/tools/executions/{uuid}.

Ready for AI agents

This tool's input is a JSON Schema, available at GET /api/tools/whatsapp_update_business_profile. It becomes your agent's tool definition with no conversion.

Other WhatsApp tools

See all 10 tools

Toolkits in the same category

See all 100 toolkits

See Connect applied to your product.

Try it for 15 days with no card, or walk our team through your use case.