Skip to main content
POST
whatsapp.account.health.get

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
accountId
string

The sending account, from social.accounts.list. Optional when only one is connected.

Required string length: 1 - 256

Response

The result

status
enum<string>
required

Business account health.

Available options:
healthy,
restricted,
unhealthy,
unknown
issues
enum<string>[]
required

Neutral account problems.

Available options:
account_banned,
messaging_blocked,
messaging_limited,
disconnected,
restricted,
configuration_error
messageLimit
integer

Messaging tier limit; absent if unknown or unlimited.

Required range: 0 <= x <= 9007199254740991
unlimited
boolean

Whether the messaging tier is unlimited.