WhatsappSetup

object

connectionsrequired: array of WhatsappConnection
embedded_signuprequired: object
embedded_signup.availablerequired: boolean
embedded_signup.app_idrequired: string or null
embedded_signup.config_idrequired: string or null
embedded_signup.graph_versionrequired: string or null
webhookrequired: object
webhook.callback_urlrequired: string
webhook.fieldsrequired: array of string
read_receiptsrequired: boolean
Blue ticks and “typing…” for customers when a member opens or answers a thread (INT-40).

Example

{
  "connections": [
    {
      "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"
        }
      ]
    }
  ],
  "embedded_signup": {
    "available": true,
    "app_id": "string",
    "config_id": "string",
    "graph_version": "string"
  },
  "webhook": {
    "callback_url": "string",
    "fields": [
      "string"
    ]
  },
  "read_receipts": true
}

{ "connections": [ { "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" } ] } ], "embedded_signup": { "available": true, "app_id": "string", "config_id": "string", "graph_version": "string" }, "webhook": { "callback_url": "string", "fields": [ "string" ] }, "read_receipts": true }