> ## Documentation Index
> Fetch the complete documentation index at: https://docs.zavu.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Get WhatsApp sync status

> Get the current sync status for a sender's WhatsApp coexistence account. Only available for senders connected in coexistence mode (WhatsApp Business App + Cloud API).



## OpenAPI

````yaml /openapi.json get /v1/senders/{senderId}/whatsapp-sync
openapi: 3.0.3
info:
  title: Zavu Unified Messaging Layer API
  version: 0.2.0
  description: >
    Unified multi-channel messaging API for Zavu.


    Supported channels:

    - **SMS**: Simple text messages

    - **WhatsApp**: Rich messaging with media, buttons, lists, CTA URL buttons,
    and templates

    - **Telegram**: Bot messaging with text, media, and interactive elements

    - **Email**: Transactional emails via Amazon SES


    Design goals:

    - Simple `send()` entrypoint for developers

    - Project-level authentication via Bearer token

    - Support for all WhatsApp message types (text, image, video, audio,
    document, sticker, location, contact, buttons, list, cta_url, reaction,
    template)

    - If a non-text message type is sent, WhatsApp channel is used automatically

    - 24-hour WhatsApp conversation window enforcement

    - Universal `to` field accepts phone numbers (E.164), email addresses, or
    numeric chat IDs (Telegram/Instagram)
servers:
  - url: https://api.zavu.dev
security:
  - bearerAuth: []
paths:
  /v1/senders/{senderId}/whatsapp-sync:
    get:
      tags:
        - WhatsApp Sync
      summary: Get WhatsApp sync status
      description: >-
        Get the current sync status for a sender's WhatsApp coexistence account.
        Only available for senders connected in coexistence mode (WhatsApp
        Business App + Cloud API).
      operationId: getWhatsAppSyncStatus
      parameters:
        - $ref: '#/components/parameters/SenderIdParam'
      responses:
        '200':
          description: Sync status.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WhatsAppSyncStatusResponse'
              example:
                sync:
                  isCoexistence: true
                  status: active
                  history:
                    status: completed
                    canSync: false
                    requestedAt: '2024-01-15T10:00:00Z'
                    completedAt: '2024-01-15T10:05:00Z'
                  contacts:
                    status: not_requested
                    canSync: true
                    requestedAt: null
        '400':
          description: >-
            Sender does not have a WhatsApp Business Account connected or is not
            in coexistence mode.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                no_waba:
                  summary: No WABA connected
                  value:
                    code: bad_request
                    message: Sender does not have a WhatsApp Business Account connected
                not_coexistence:
                  summary: Not coexistence mode
                  value:
                    code: bad_request
                    message: Sync is only available for coexistence accounts
        '401':
          description: Unauthorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Sender not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - bearerAuth: []
components:
  parameters:
    SenderIdParam:
      name: senderId
      in: path
      required: true
      schema:
        type: string
  schemas:
    WhatsAppSyncStatusResponse:
      type: object
      required:
        - sync
      properties:
        sync:
          $ref: '#/components/schemas/WhatsAppSyncStatus'
    Error:
      type: object
      required:
        - code
        - message
      properties:
        code:
          type: string
          example: invalid_request
        message:
          type: string
          example: Phone number is invalid
        details:
          type: object
          additionalProperties: true
    WhatsAppSyncStatus:
      type: object
      description: WhatsApp coexistence sync status.
      required:
        - isCoexistence
        - status
        - history
        - contacts
      properties:
        isCoexistence:
          type: boolean
          description: Whether the account is in coexistence mode.
        status:
          type: string
          description: WhatsApp account status.
          enum:
            - pending_verification
            - pending_registration
            - active
            - disconnected
            - error
        history:
          $ref: '#/components/schemas/WhatsAppSyncHistory'
        contacts:
          $ref: '#/components/schemas/WhatsAppSyncContacts'
    WhatsAppSyncHistory:
      type: object
      description: History sync status details.
      required:
        - status
        - canSync
      properties:
        status:
          $ref: '#/components/schemas/WhatsAppSyncHistoryStatus'
        canSync:
          type: boolean
          description: Whether history sync can be initiated.
        requestedAt:
          type: string
          format: date-time
          nullable: true
          description: When the sync was last requested.
        completedAt:
          type: string
          format: date-time
          nullable: true
          description: When the sync was completed.
    WhatsAppSyncContacts:
      type: object
      description: Contacts sync status details.
      required:
        - status
        - canSync
      properties:
        status:
          $ref: '#/components/schemas/WhatsAppSyncContactsStatus'
        canSync:
          type: boolean
          description: Whether contacts sync can be initiated.
        requestedAt:
          type: string
          format: date-time
          nullable: true
          description: When the sync was last requested.
    WhatsAppSyncHistoryStatus:
      type: string
      description: Status of WhatsApp message history sync.
      enum:
        - not_requested
        - pending
        - syncing
        - completed
        - rejected
    WhatsAppSyncContactsStatus:
      type: string
      description: Status of WhatsApp contacts sync.
      enum:
        - not_requested
        - pending
        - syncing
        - completed
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````