Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

WhatsApp Business Profile API

Get and update WhatsApp Business profile information

WhatsApp Business Profile API is one of 17 APIs that WhatsApp publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

This API exposes 2 JSON Schema definitions.

Tagged areas include Business Profile. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, an AsyncAPI specification, an API reference, a getting-started guide, and 2 JSON Schemas.

This API exposes 2 operations across 1 path, and defines 3 schemas. It is described by OpenAPI 3.1.0, at version 21.0.

Requests are made against a single base URL, https://graph.facebook.com/v21.0.

2 operations 1 paths 3 schemas 1 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
21.0
Base URL
https://graph.facebook.com/v21.0
Authentication
HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 1

WhatsApp Business Profile API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — System User Token with whatsappbusinessmanagement permission

Paths & Operations 2

Across 1 path, the API surfaces 2 operations — 1 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Business Profile 2

Get and update WhatsApp Business profile information

GET
/{phone-number-id}/whatsapp_business_profile
WhatsApp Get Business Profile
getBusinessProfile 2 params → 200
POST
/{phone-number-id}/whatsapp_business_profile
WhatsApp Update Business Profile
updateBusinessProfile 1 param body → 200

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are BusinessProfile (8 properties), UpdateBusinessProfileRequest (8 properties), SuccessResponse (1 property). Each schema is shown below with its type and property counts.

UpdateBusinessProfileRequest
object
8 properties 1 required
SuccessResponse
object
1 property
BusinessProfile
object
8 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

whatsapp-business-profile-api-openapi.yml Raw ↑

Other APIs WhatsApp publishes across the network.

WhatsApp Flows API
WhatsApp On-Premises API
WhatsApp Analytics API
WhatsApp Assets API
WhatsApp Assigned Users API
WhatsApp Business Accounts API
WhatsApp Lifecycle API
WhatsApp Media API
WhatsApp Message Templates API
WhatsApp Messages API
WhatsApp Phone Numbers API
WhatsApp Product Catalogs API