WhatsappConnection

object

idrequired: Id
Opaque record id.
namerequired: string or null
statusrequired: string
healthrequired: "ok" | "degraded" | "error" | "disconnected" | "pending"
moderequired: "byo" | "embedded"
waba_idrequired: string or null
waba_namerequired: string or null
currencyrequired: string or null
Indian portfolios must bill in INR from 1 Jan 2027.
review_statusrequired: string or null
subscribedrequired: boolean
app_idrequired: string or null
token_hintrequired: string or null
last_errorrequired: string or null
last_ok_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
connected_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
last_syncrequired: object
last_sync.atrequired: string or null
last_sync.errorrequired: string or null
last_sync.templatesrequired: integer
tokenrequired: object
Access token expiry (null = never or unknown); reconnect from 3 days before it.
token.expires_atrequired: string or null
token.reconnectrequired: boolean
account_healthrequired: object or null
The daily WABA health read from Meta; null before the first one.
account_health.checked_atrequired: string
account_health.currencyrequired: string or null
account_health.payment_methodrequired: "present" | "missing" | "unknown"
account_health.account_statusrequired: string or null
account_health.business_verificationrequired: string or null
account_health.can_sendrequired: "AVAILABLE" | "LIMITED" | "BLOCKED" or null
account_health.problemsrequired: array of object
account_health.problems[].entityrequired: string
account_health.problems[].coderequired: string or null
account_health.problems[].textrequired: string
account_health.errorrequired: string or null
numbersrequired: array of WhatsappNumber

Example

{
  "id": "cmusrceel0000q7kaafxqi1om",
  "name": "string",
  "status": "string",
  "health": "ok",
  "mode": "byo",
  "waba_id": "string",
  "waba_name": "string",
  "currency": "string",
  "review_status": "string",
  "subscribed": true,
  "app_id": "string",
  "token_hint": "string",
  "last_error": "string",
  "last_ok_at": "2026-10-06T05:30:00.000Z",
  "connected_at": "2026-10-06T05:30:00.000Z",
  "last_sync": {
    "at": "string",
    "error": "string",
    "templates": 0
  },
  "token": {
    "expires_at": "string",
    "reconnect": true
  },
  "account_health": {
    "checked_at": "string",
    "currency": "string",
    "payment_method": "present",
    "account_status": "string",
    "business_verification": "string",
    "can_send": "AVAILABLE",
    "problems": [
      {
        "entity": "string",
        "code": "string",
        "text": "string"
      }
    ],
    "error": "string"
  },
  "numbers": [
    {
      "id": "cmusrceel0000q7kaafxqi1om",
      "connection_id": "cmusrceel0000q7kaafxqi1om",
      "phone_number_id": "string",
      "address": "string",
      "display_phone_number": "string",
      "label": "string",
      "verified_name": "string",
      "name_status": "string",
      "quality_rating": "string",
      "messaging_limit_tier": "string",
      "throughput": "string",
      "status": "string",
      "meta_status": "string",
      "code_verification_status": "string",
      "coexistence": true,
      "is_default": true,
      "last_seen_at": "2026-10-06T05:30:00.000Z"
    }
  ]
}

{ "id": "cmusrceel0000q7kaafxqi1om", "name": "string", "status": "string", "health": "ok", "mode": "byo", "waba_id": "string", "waba_name": "string", "currency": "string", "review_status": "string", "subscribed": true, "app_id": "string", "token_hint": "string", "last_error": "string", "last_ok_at": "2026-10-06T05:30:00.000Z", "connected_at": "2026-10-06T05:30:00.000Z", "last_sync": { "at": "string", "error": "string", "templates": 0 }, "token": { "expires_at": "string", "reconnect": true }, "account_health": { "checked_at": "string", "currency": "string", "payment_method": "present", "account_status": "string", "business_verification": "string", "can_send": "AVAILABLE", "problems": [ { "entity": "string", "code": "string", "text": "string" } ], "error": "string" }, "numbers": [ { "id": "cmusrceel0000q7kaafxqi1om", "connection_id": "cmusrceel0000q7kaafxqi1om", "phone_number_id": "string", "address": "string", "display_phone_number": "string", "label": "string", "verified_name": "string", "name_status": "string", "quality_rating": "string", "messaging_limit_tier": "string", "throughput": "string", "status": "string", "meta_status": "string", "code_verification_status": "string", "coexistence": true, "is_default": true, "last_seen_at": "2026-10-06T05:30:00.000Z" } ] }