For more information on how to use the API, see WhatsApp Business Management API.
The following API calls are subject to Business Use Case Rate Limits:
GET
, POST
, and DELETE
calls to /{whats-app-business-account-id}/assigned_users
GET
calls to /{whats-app-business-account-id}
Returns the account information of a WhatsApp Business Account
Requirements
whatsapp_business_management permission
whatsapp_business_messaging permission
public_profile permission
WhatsApp Business Account (WABA) ID
USER ACCESS TOKEN
Request
curl -i -X GET \
"https://graph.facebook.com/LATEST-VERSION/WHATSAPP-BUSINESS-ACCOUNT-ID?access_token=USER-ACCESS-TOKEN"
Response
{ "id": "WHATSAPP-BUSINESS-ACCOUNT-ID", "name": "Test WhatsApp Business Account", "timezone_id": "1", "message_template_namespace": "MESSAGE-TEMPLATE-NAMESPACE" }
Field | Description |
---|---|
analytics | Used to designate which analytics metrics you want returned. See Analytics. |
business_verification_status enum {expired, failed, ineligible, not_verified, pending, pending_need_more_info, pending_submission, rejected, revoked, verified} | Current status of business verification of Meta Business Account which owns this WhatsApp Business Account |
string | country of the WhatsApp Business Account's owning Meta Business account |
currency string | The currency in which the payment transactions for the WhatsApp Business Account will be processed |
is_enabled_for_insights bool | If |
message_template_namespace string | Namespace string for the message templates that belong to the WhatsApp Business Account |
name string | User-friendly name to differentiate WhatsApp Business Accounts |
on_behalf_of_business_info WABAOnBehalfOfComputedInfo | The "on behalf of" information for the WhatsApp Business Account |
enum | Ownership type of the WhatsApp Business Account |
primary_funding_id numeric string | Primary funding ID for the WhatsApp Business Account paid service |
purchase_order_number string | The purchase order number supplied by the business for payment management purposes |
timezone_id string | The timezone of the WhatsApp Business Account |
Edge | Description |
---|---|
Edge<WhatsAppBusinessActivityHistory> | activities |
Edge<WABACallAnalytics> | Analytics data of the WhatsApp Business Account for calling |
Edge<WABAConversationAnalytics> | Analytics data of the WhatsApp Business Account with conversation based pricing |
Edge<Dataset> | ID of the dataset |
Edge<WhatsAppBusinessDirectConnectionExternalConfig> | Returns a list of DCC configs |
Edge<WhatsAppBusinessAccountMessageTemplatePreview> | Retrieves a preview of a message template based on the provided configuration |
Edge<WhatsAppBusinessHSM> | Message templates that belong to the WhatsApp Business Account |
Edge<WhatsAppBusinessAccountPaymentConfiguration> | Fetch payment configuration attached to the WhatsApp Business Account. |
Edge<WhatsAppBusinessAccountPaymentConfigurations> | Fetch all payment configurations attached to the WhatsApp Business Account. |
Edge<WhatsAppBusinessAccountToNumberCurrentStatus> | The phone numbers that belong to the WhatsApp Business Account |
Edge<ProductCatalog> | product_catalogs |
Edge<WhatsAppBusinessSolution> | Partner solutions that this WhatsApp Business Account is linked to |
Edge<WhatsAppApplication> | List of apps that are subscribed to webhooks updates for this WABA |
Edge<WhatsAppBusinessHSMWhatsAppBusinessPerformanceMetrics> | template_performance_metrics |
Error | Description |
---|---|
100 | Invalid parameter |
200008 | WhatsApp Business Account has no linked phone numbers. |
200 | Permissions error |
80008 | There have been too many calls to this WhatsApp Business account. Wait a bit and try again. For more info, please refer to https://developers.facebook.com/docs/graph-api/overview/rate-limiting. |
190 | Invalid OAuth 2.0 Access Token |
2500 | Error parsing graph query |
200005 | Template Insights are not available yet for this WhatsApp Business account |
/{whats_app_business_account_id}/assigned_users
.Parameter | Description |
---|---|
tasks array<enum {MANAGE, DEVELOP, MANAGE_TEMPLATES, MANAGE_PHONE, VIEW_COST, MANAGE_EXTENSIONS, VIEW_PHONE_ASSETS, MANAGE_PHONE_ASSETS, VIEW_TEMPLATES, MESSAGING}> | Permissions on WhatsApp Business Account Required |
user UID | Business user ID Required |
success
: bool, Error | Description |
---|---|
100 | Invalid parameter |
200 | Permissions error |
80008 | There have been too many calls to this WhatsApp Business account. Wait a bit and try again. For more info, please refer to https://developers.facebook.com/docs/graph-api/overview/rate-limiting. |
/{whats_app_business_account_id}/assigned_users
.Parameter | Description |
---|---|
user UID | Business user ID Required |
success
: bool, Error | Description |
---|---|
100 | Invalid parameter |
Supported values for currency codes can be found in currencies.
Supported values for time zones can be found in timezone ids.