Appearance
Fresh 2026
WhatsApp Business Account
Represents phone numbers that belong to a specific WhatsApp Business Account (WABA).
To find the ID of a WhatsApp Business Account, go to Business Manager > Business Settings > Accounts > WhatsApp Business Accounts. Find the account you want to use and click on it. A panel opens, with information about the account, including the ID.
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, andDELETEcalls to/{whats-app-business-account-id}/assigned_usersGETcalls to/{whats-app-business-account-id}
Reading
Returns the account information of a WhatsApp Business Account
Example
Requirements
whatsapp_business_management permission
whatsapp_business_messaging permission
public_profile permission
WhatsApp Business Account (WABA) ID
USER ACCESS TOKEN
Request
cURLAndroid SDKObjective-C
sh
curl -i -X GET \
"https://graph.facebook.com/LATEST-VERSION/WHATSAPP-BUSINESS-ACCOUNT-ID?access_token=USER-ACCESS-TOKEN"java
GraphRequest request = GraphRequest.newGraphPathRequest(
accessToken,
"/WHATSAPP-BUSINESS-ACCOUNT-ID",
new GraphRequest.Callback() {
@Override
public void onCompleted(GraphResponse response) {
// Insert your code here
}
});
request.executeAsync();m
FBSDKGraphRequest *request = [[FBSDKGraphRequest alloc]\
initWithGraphPath:@"/WHATSAPP-BUSINESS-ACCOUNT-ID"\
parameters:nil\
HTTPMethod:@"GET"];
[request startWithCompletionHandler:^(FBSDKGraphRequestConnection *connection, id result, NSError *error) {\
// Insert your code here\
}];Response
json
{
"id": "WHATSAPP-BUSINESS-ACCOUNT-ID",
"name": "Test WhatsApp Business Account",
"timezone_id": "1",
"message_template_namespace": "MESSAGE-TEMPLATE-NAMESPACE"
}Parameters
This endpoint doesn't have any parameters.
Fields
| Field | Description |
|---|---|
analytics<br>WABAAnalytics | Used to designate which analytics metrics you want returned. See Analytics. |
business_verification_status<br>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 |
country<br>string | country of the WhatsApp Business Account's owning Meta Business account |
currency<br>string | The currency in which the payment transactions for the WhatsApp Business Account will be processed<br>Default |
health_status<br>WhatsAppBusinessHealthStatusForMessageSend | Health status of the WABA in regards to whether the WABA, Business, and App can send a message |
is_enabled_for_insights<br>bool | If true, indicates the WhatsApp Business Account enabled template analytics. See Analytics. |
is_shared_with_partners<br>bool | is_shared_with_partners |
marketing_messages_lite_api_status<br>enum | WhatsApp Business Account's status for onboarding onto Marketing Messages Lite.<br>Values can be:<br>INELIGIBLE, Indicates the WABA has not met all eligibility requirements.<br>ELIGIBLE- Indicates WABA has met all eligibility requirements<br>ONBOARDED, Indicates the WABA is eligible to use MM Lite API and:<br>- the owning business has signed MM Lite Terms of Service<br>- the WABA has a valid payment method attached<br>- the WABA is linked to an Ad account<br>UNKNOWN- Indicates an unknown status. Please contact support for assistance. |
marketing_messages_onboarding_status<br>enum | Onboarding status of the WhatsApp Business account into Marketing Messages Lite API.<br>Values can be:<br>INELIGIBLE_ON_BEHALF_OF_WABA, The WhatsApp Business Account (“WABA”) uses the “OBO” model which is not supported. You must either first transfer ownership of the WABA to the customer or onboard using the Intent API.<br>INELIGIBLE_INACTIVE_OR_RESTRICTED, The WhatsApp Business Account is inactive or is restricted from messaging due to a policy enforcement issue.<br>INELIGIBLE_COUNTRY_NOT_SUPPORTED, The WhatsApp Business Account is in a region that does not support the MM Lite API.<br>INELIGIBLE_USING_WHATSAPP_BUSINESS_APP, The WhatsApp Business phone number is being used within the WhatsApp Business app.<br>ELIGIBLE, WhatsApp Business Account is eligible to onboard and use the MM Lite API.<br>PENDING_VALID_PAYMENT_METHOD, The WhatsApp Business Account requires setting up a valid payment method.<br>PENDING_INTERNAL_SETUP, WhatsApp Business Account is in the configuration process of using the MM Lite API and requires no further action from the business customer or partner.<br>The automated setup process is estimated to take less than ten minutes.<br>Subscribe to the account_update webhook and listen for the AD_ACCOUNT_LINKED event.<br>Submit a support ticket if the setup process takes more than ten minutes and you have not received a webhook.<br>ONBOARDED, The WhatsApp Business Account has successfully onboarded and is ready to use the MM Lite API. |
message_template_namespace<br>string | Namespace string for the message templates that belong to the WhatsApp Business Account<br>Default |
name<br>string | User-friendly name to differentiate WhatsApp Business Accounts<br>Default |
on_behalf_of_business_info<br>WABAOnBehalfOfComputedInfo | The "on behalf of" information for the WhatsApp Business Account |
ownership_type<br>enum | Ownership type of the WhatsApp Business Account |
primary_funding_id<br>numeric string | Primary funding ID for the WhatsApp Business Account paid service |
purchase_order_number<br>string | The purchase order number supplied by the business for payment management purposes |
status<br>string | WhatsApp Business Account status.<br>Default: ACTIVE |
timezone_id<br>string | The timezone of the WhatsApp Business Account<br>Default |
whatsapp_business_manager_messaging_limit<br>enum {TIER_100K, TIER_10K, TIER_250, TIER_2K, TIER_UNLIMITED, UNTIERED} | Maximum number of unique WhatsApp user phone numbers that your Business Manager account can message, outside of a customer service window, within a moving 24-hour period. This limit is shared across all WhatsApp phone numbers owned by your business. |
Edges
| Edge | Description |
|---|---|
activities<br>Edge<WhatsAppBusinessActivityHistory> | activities |
call_analytics<br>Edge<WABACallAnalytics> | Analytics data of the WhatsApp Business Account for calling |
conversation_analytics<br>Edge<WABAConversationAnalytics> | Analytics data of the WhatsApp Business Account with conversation based pricing |
dataset<br>Edge<Dataset> | ID of the dataset |
message_template_previews<br>Edge<WhatsAppBusinessAccountMessageTemplatePreview> | Retrieves a preview of a message template based on the provided configuration |
message_templates<br>Edge<WhatsAppBusinessHSM> | Message templates that belong to the WhatsApp Business Account |
payment_configuration<br>Edge<WhatsAppBusinessAccountPaymentConfiguration> | Fetch payment configuration attached to the WhatsApp Business Account. |
payment_configurations<br>Edge<WhatsAppBusinessAccountPaymentConfigurations> | Fetch all payment configurations attached to the WhatsApp Business Account. |
phone_numbers<br>Edge<WhatsAppBusinessAccountToNumberCurrentStatus> | The phone numbers that belong to the WhatsApp Business Account |
pricing_analytics<br>Edge<WABAPricingAnalytics> | Pricing analytics data of the WhatsApp Business Account with per message pricing |
product_catalogs<br>Edge<ProductCatalog> | product_catalogs |
solutions<br>Edge<WhatsAppBusinessSolution> | Partner solutions that this WhatsApp Business Account is linked to |
subscribed_apps<br>Edge<WhatsAppApplication> | List of apps that are subscribed to webhooks updates for this WABA |
template_groups<br>Edge<BusinessMessagingTemplateGroup> | Retrieve list of existing template groups associated with WhatsApp Business Account |
Error Codes
| Error | Description |
|---|---|
| 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. |
| 200008 | WhatsApp Business Account has no linked phone numbers. |
| 100 | Invalid parameter |
| 200 | Permissions error |
| 2500 | Error parsing graph query |
| 131031 | Business Account locked |
| 190 | Invalid OAuth 2.0 Access Token |
| 131000 | Something went wrong |
| 200005 | Template Insights are not available yet for this WhatsApp Business account |
Creating
You can't perform this operation on this endpoint.
Updating
You can update a WhatsAppBusinessAccount by making a POST request to /{whats_app_business_account_id}/assigned_users.
Parameters
| Parameter | Description |
|---|---|
tasks<br>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<br>Required |
user<br>UID | Business user ID<br>Required |
Return Type
This endpoint supports read-after-write and will read the node to which you POSTed.
Struct {
success: bool,
}
Error Codes
| 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. |
Deleting
You can dissociate a WhatsAppBusinessAccount from a WhatsAppBusinessAccount by making a DELETE request to /{whats_app_business_account_id}/assigned_users.
Parameters
| Parameter | Description |
|---|---|
user<br>UID | Business user ID<br>Required |
Return Type
Struct {
success: bool,
}
Error Codes
| Error | Description |
|---|---|
| 100 | Invalid parameter |
Supported values
Currencies
Supported values for currency codes can be found in currencies.
Time Zones
Supported values for time zones can be found in timezone ids.