Sign in
Accounts

Check account health

Returns detailed health info for a specific account including token status, permissions, and recommendations.

For WhatsApp accounts the response also includes platformConnection, a live probe of the Meta link behind the channel (the same read as GET /v1/whatsapp/number-info). The OAuth token can be perfectly valid while Meta refuses to serve the phone-number object (for example after a phone-side coexistence disconnect), so tokenStatus alone is not a liveness signal for WhatsApp. When the Meta link is dead, platformConnection.status is disconnected and the overall status is error. When Meta reports that the number's inbound message webhook does not reach Zernio, platformConnection.inboundWebhookSubscribed is false, an entry is added to issues, and the overall status is at least warning.

get/v1/accounts/{accountId}/health

Path parameters

accountIdstring required

The account ID to check

Response

Account health details

accountIdstring
platformstring
integrationLane'business' | 'developer'

TikTok only. The TikTok integration the account is connected through: business (TikTok for Business, Accounts API) or developer (the original integration). Absent on other platforms.

usernamestring
displayNamestring
status'healthy' | 'warning' | 'error'

Overall health status

issuesstring[]

List of issues found

recommendationsstring[]

Actionable recommendations to fix issues

Changes

Changed in 7 of the 56 revisions of this API.12

  • 2c04683ce6944See the full diff
    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • a0d8f21b5abe1See the full diff
    • ○

      added the optional property / to the response with the status

      response-optional-property-added

  • eded32b628231See the full diff
    • ○

      added the optional property to the response with the status

      response-optional-property-added

  • 3e6ddf2a99ea1See the full diff
    • ○

      added the optional property / to the response with the status

      response-optional-property-added

  • 0dba7d004d752See the full diff
    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

  • 2d81890d21d51See the full diff
    • ○

      added the optional property to the response with the status

      response-optional-property-added

  • 0942091eaa8c2See the full diff
    • ○

      added the non-success response with the status

      response-non-success-status-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added