get
https://partner.gupshup.io/partner/app//waba/info
Use this API to retrieve comprehensive WhatsApp Business Account (WABA) information and health status for your application. This endpoint provides critical details about account status, messaging capabilities, phone number quality, ownership, and any errors or limitations.
Important Requirements:
- Valid app ID required
- App must be WhatsApp Business API enabled
- Rate limit: 10 requests per 60 seconds
- PARTNER_APP role mandatory
Common Use Cases:
- Monitor WABA account health and status
- Check messaging availability before sending
- Verify phone number and quality status
- Diagnose account issues and errors
- Validate account configuration
- Track ownership and account type
Note: This endpoint provides real-time status information directly from WhatsApp Business API, including any active restrictions or limitations on the account.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
API Request
curl --location --request GET '{{partner_portal_base_url}}/partner/app/:appId/waba/info' \
--header 'token: {{PARTNER_APP_TOKEN}}' \
API Response
| Status Code | Response | Comments |
|---|---|---|
| Success | ||
| 200 | | |
| Error | ||
| 400 | | If app is not live |
| 400 | | If waba id is not present in DB |
| 400 | | If waba id present in DB is not correct |
| 400 | | |
| 401 | | |
| 429 | | 10 Requests per Minute |
| 500 | | For any Internal Error |
Request Params
| Key | Description | Constraints |
|---|---|---|
| Headers | ||
| PARTNER_APP_TOKEN | App Access Token issues post Partner login | Should be a valid Partner app access token belonging to the passed appId |
| Path Params | ||
| APP_ID | appId of the app | App Id for the app that is linked to the Partner Account |
Response Params
| Key | Description |
|---|---|
| accountStatus | Waba account status - ACTIVE | BANNED |
| dockerStatus | Waba docker status - CONNECTED | DISCONNECTED | FLAGGED | PENDING | RESTRICTED | UNKNOWN |
| messagingLimit | messaging tier - TIER_50 | TIER_250 | TIER_2K | TIER_10K | TIER_100K | TIER_NOT_SET | TIER_UNLIMITED This is BM level messaging limit |
| mmLiteStatus | INELIGIBLE| ELIGIBLE| ONBOARD|INELIGIBLE_ON_BEHALF_OF_WABA | INELIGIBLE_INACTIVE_OR_RESTRICTED |INELIGIBLE_COUNTRY_NOT_SUPPORTED |INELIGIBLE_COUNTRY_NOT_SUPPORTED| PENDING_VALID_PAYMENT_METHOD |PENDING_INTERNAL_SETUP" |
| phone | Phone number |
| phoneQuality | Phone number quality - GREEN | YELLOW | RED | UNKNOWN |
| verifiedName | Display name for the WABA |
| wabaId | Waba Id |
| canSendMessage | Message sending is allowed or not - AVAILABLE | LIMITED | BLOCKED |
| errors | |
| additionalInfo | Additional information associated with the waba |