{
"id": "<string>",
"name": "<string>",
"currency": "<string>",
"messageTemplateNamespace": "<string>",
"accountReviewStatus": "PENDING",
"businessId": "<string>",
"businessName": "<string>",
"businessStatus": "<string>",
"businessVerificationStatus": "expired",
"country": "<string>",
"ownershipType": "<string>",
"paymentMethodAttached": true,
"primaryFundingId": "<string>",
"purchaseOrderNumber": "<string>",
"timezoneId": "1",
"decision": "APPROVED",
"updateEvent": "DISABLED_UPDATE",
"banState": "SCHEDULE_FOR_DISABLE",
"banDate": "December 9, 2022",
"violationType": "SCAM",
"restrictions": [
{
"restrictionType": "RESTRICTED_ADD_PHONE_NUMBER_ACTION",
"expiration": "2022-06-01T12:00:00.000Z"
}
],
"maxPhoneNumbersPerBusiness": 20,
"maxPhoneNumbersPerWaba": 25,
"authIntlRateEligibilityCountries": [
{
"countryCode": "IN",
"startTime": "2024-07-01T00:00:00.000Z"
}
],
"primaryBusinessLocation": "US",
"whatsappBusinessManagerMessagingLimit": "TIER_2K",
"removedReason": "ACCOUNT_DISCONNECTED",
"removedInitiatedBy": "USER",
"removedTime": "2026-05-19T12:00:00.000Z"
}{
"error": {
"status": 404,
"code": "NOT_FOUND",
"message": "The requested resource does not exist.",
"target": "",
"docUrl": "",
"requestId": "req_1KjtKI80IKoaJNa6n6p",
"whatsappApiError": {
"message": "HSM Template creation failed",
"code": 200002,
"type": "OAuthException",
"is_transient": false,
"error_subcode": 2388109,
"error_user_msg": "This message template cannot be created.",
"error_user_title": "Message Cannot Be Submitted",
"fbtrace_id": "AVGjJ7ia2zJkrHG",
"error_data": "<string>"
},
"metaBusinessAgentApiError": {
"title": "<string>",
"detail": "<string>",
"type": "<string>",
"status": 123,
"requestId": "<string>"
}
}
}Retrieve a WABA
Retrieves a WABA you’ve registered.
{
"id": "<string>",
"name": "<string>",
"currency": "<string>",
"messageTemplateNamespace": "<string>",
"accountReviewStatus": "PENDING",
"businessId": "<string>",
"businessName": "<string>",
"businessStatus": "<string>",
"businessVerificationStatus": "expired",
"country": "<string>",
"ownershipType": "<string>",
"paymentMethodAttached": true,
"primaryFundingId": "<string>",
"purchaseOrderNumber": "<string>",
"timezoneId": "1",
"decision": "APPROVED",
"updateEvent": "DISABLED_UPDATE",
"banState": "SCHEDULE_FOR_DISABLE",
"banDate": "December 9, 2022",
"violationType": "SCAM",
"restrictions": [
{
"restrictionType": "RESTRICTED_ADD_PHONE_NUMBER_ACTION",
"expiration": "2022-06-01T12:00:00.000Z"
}
],
"maxPhoneNumbersPerBusiness": 20,
"maxPhoneNumbersPerWaba": 25,
"authIntlRateEligibilityCountries": [
{
"countryCode": "IN",
"startTime": "2024-07-01T00:00:00.000Z"
}
],
"primaryBusinessLocation": "US",
"whatsappBusinessManagerMessagingLimit": "TIER_2K",
"removedReason": "ACCOUNT_DISCONNECTED",
"removedInitiatedBy": "USER",
"removedTime": "2026-05-19T12:00:00.000Z"
}{
"error": {
"status": 404,
"code": "NOT_FOUND",
"message": "The requested resource does not exist.",
"target": "",
"docUrl": "",
"requestId": "req_1KjtKI80IKoaJNa6n6p",
"whatsappApiError": {
"message": "HSM Template creation failed",
"code": 200002,
"type": "OAuthException",
"is_transient": false,
"error_subcode": 2388109,
"error_user_msg": "This message template cannot be created.",
"error_user_title": "Message Cannot Be Submitted",
"fbtrace_id": "AVGjJ7ia2zJkrHG",
"error_data": "<string>"
},
"metaBusinessAgentApiError": {
"title": "<string>",
"detail": "<string>",
"type": "<string>",
"status": 123,
"requestId": "<string>"
}
}
}Authorizations
Path Parameters
WhatsApp Business Account ID.
"whatsapp-business-account-id"
Response
Successfully retrieved the WABA.
Represents a specific WhatsApp Business Account (WABA).
WhatApp Business Account ID.
User-friendly name to differentiate WhatsApp Business Accounts.
The currency in which the payment transactions for the WhatsApp Business Account will be processed.
Namespace string for the message templates that belong to the WhatsApp Business Account.
WhatsApp Business Account review status.
PENDING, APPROVED, REJECTED Business Portfolio ID.
Business Portfolio Name.
Business Portfolio Status,Default:APPROVED
Current status of business verification of Meta Business Account which owns this WhatsApp Business Account.
expired, failed, ineligible, not_verified, pending, pending_need_more_info, pending_submission, rejected, revoked, verified Country of the WhatsApp Business Account's owning Meta Business account.
Ownership type of the WhatsApp Business Account.
Whether we have attached a payment method to the WhatsApp Business Account.
Primary funding ID for the WhatsApp Business Account paid service.
The purchase order number supplied by the business for payment management purposes.
The timezone ID of the WhatsApp Business Account. See Timezone IDs.
"1"
Review decision made on this WhatsApp Business Account. One of APPROVED or REJECTED or DEFERRED.
APPROVED, REJECTED, DEFERRED Indicates the update event type of the WABA when a notification is sent to you to report a policy violation, a WABA has been banned and more.
DISABLED_UPDATE: WhatsApp Business Account Banned.ACCOUNT_RESTRICTION: WhatsApp Business Account Restricted Due To Policy Violations.ACCOUNT_VIOLATION: WhatsApp Business Account Violates Policy.PARTNER_REMOVED: WhatsApp Business Account was removed from the partner connection.PARTNER_APP_UNINSTALLED: WhatsApp Business Account partner app was uninstalled.AUTH_INTL_PRICE_ELIGIBILITY_UPDATE: WhatsApp Business Account is eligible for the authentication-international rate.BUSINESS_PRIMARY_LOCATION_COUNTRY_UPDATE: Business's primary business location is set.BUSINESS_CAPABILITY_UPDATE: Meta reported a change to the Business Portfolio or WABA phone-number registration limit.
DISABLED_UPDATE, ACCOUNT_RESTRICTION, ACCOUNT_VIOLATION, PARTNER_REMOVED, PARTNER_APP_UNINSTALLED, AUTH_INTL_PRICE_ELIGIBILITY_UPDATE, BUSINESS_PRIMARY_LOCATION_COUNTRY_UPDATE, BUSINESS_CAPABILITY_UPDATE The ban state of the WhatsApp Business Account.
SCHEDULE_FOR_DISABLE, DISABLE, REINSTATE The date when the WABA is banned.
"December 9, 2022"
Used to report violations imposed on the WABA. See also WhatsApp Business Platform Policy Violations.
"SCAM"
Used to report restrictions imposed on the WABA, when that WABA violates WhatsApp Business Platform policies.
Show child attributes
Show child attributes
Included in a whatsapp.business_account.updated webhook with updateEvent=BUSINESS_CAPABILITY_UPDATE when Meta reports the Business Portfolio phone-number registration limit. Meta currently reports this field separately from maxPhoneNumbersPerWaba, but consumers must process both if a future update includes them together.
20
Included in a whatsapp.business_account.updated webhook with updateEvent=BUSINESS_CAPABILITY_UPDATE when Meta reports the WABA phone-number registration limit. Meta currently reports this field separately from maxPhoneNumbersPerBusiness, but consumers must process both if a future update includes them together.
25
Starting June 1, 2024, we are updating our authentication rate card and introducing a new authentication-international rate. This rate will apply in the the following countries:
- June 1, 2024 – Indonesia (country calling code +62, country code
ID) - July 1, 2024 – India (country calling code +91, country code
IN)
See also Authentication-International Rates.
Show child attributes
Show child attributes
Your primary business location is the country where your business is based. It will appear in the Business Manager under the Primary Business Location field starting May 1, 2024. ISO 3166-1 alpha-2 country code.
"US"
The owning business portfolio's messaging limit. Starting October 7, 2025, messaging limits will instead be calculated and set on a business portfolio basis, and will be shared by all business phone numbers within each portfolio. See also phone_number_quality_update webhook reference.
TIER_NOT_SET: The business phone number has not been used to send a message yet.TIER_50: Messaging limit of 50 business-initiated conversations in a rolling 24-hour period.TIER_250: Messaging limit of 250 business-initiated conversations in a rolling 24-hour period.TIER_2K: Messaging limit of 2,000 business-initiated conversations in a rolling 24-hour period.TIER_10K: Messaging limit of 10,000 business-initiated conversations in a rolling 24-hour period.TIER_100K: Messaging limit of 100,000 business-initiated conversations in a rolling 24-hour period.TIER_UNLIMITED: The business phone number has higher throughput with unlimited business-initiated conversations.
"TIER_2K"
Raw reason from the WhatsApp Business Account deletion event. Known values include:
ACCOUNT_DISCONNECTED: The account was disconnected due to enforcement or because the WhatsApp account was explicitly deleted.BUSINESS_DOWNGRADE: The phone number was registered with the consumer WhatsApp app.CHANGE_NUMBER: The WhatsApp phone number was changed.COMPANION_INACTIVITY: A companion device was inactive for approximately 30 days.PRIMARY_INACTIVITY: A primary device was inactive for approximately 30 days.USER_RE_REGISTERED: WhatsApp was re-registered on a new device.
Unknown values are returned as received.
"ACCOUNT_DISCONNECTED"
Raw initiator from the WhatsApp Business Account deletion event. Known values include:
USER: The removal was initiated by the WhatsApp user.SYSTEM: The removal was initiated by the Meta system.
Unknown values are returned as received.
"USER"