Get Node Health Status

Retrieve the messaging health status of a WhatsApp node (Business Account, Phone Number, or Message Template) to determine whether it can be used to send messages successfully.

The response includes the overall health status (AVAILABLE, LIMITED, or BLOCKED) along with a detailed breakdown of related node components involved in message delivery, which may include:

  • WhatsApp Business Account (WABA)
  • Business Phone Number
  • Message Template
  • App
  • Business Profile

Each node component in the response will have a status reflecting its messaging health:

  • AVAILABLE: The node meets all messaging requirements.
  • LIMITED: The node has some limitations; additional information will be provided.
  • BLOCKED: The node does not meet messaging requirements; errors and possible solutions will be included.

The overall health status reflects a summary of the messaging health of all the nodes involved in messaging requests if using the targeted node:

  • BLOCKED: One or more node components is BLOCKED.
  • LIMITED: No nodes are BLOCKED, but one or more is LIMITED.
  • AVAILABLE: All nodes are AVAILABLE.
Query Params
string
required

the id of the node you want to use in order to get the health status of the messaging process. (WABA ID, phone number ID, template ID).

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json