Skip to content
DashboardGet API key

Start contacts sync

View .md
POST

Initiate contact names sync from the WhatsApp Business App. This imports contact names stored in the app to Zavu. Only available for coexistence accounts with active status.

Authorization

  • Authorizationheaderrequired

    Bearer YOUR_API_KEY. Create a key in the dashboard.

Path parameters

  • senderIdstringrequired

Responses

202Contacts sync initiated.
  • messagestringrequired

    Success message.

  • syncobjectrequired

    WhatsApp coexistence sync status.

    4 properties
    • isCoexistencebooleanrequired

      Whether the account is in coexistence mode.

    • statusstringrequired

      WhatsApp account status.

      One ofpending_verificationpending_registrationactivedisconnectederror
    • historyobjectrequired

      History sync status details.

      4 properties
      • statusstringrequired

        Status of WhatsApp message history sync.

        One ofnot_requestedpendingsyncingcompletedrejected
      • canSyncbooleanrequired

        Whether history sync can be initiated.

      • requestedAtstring<date-time>nullable

        When the sync was last requested.

      • completedAtstring<date-time>nullable

        When the sync was completed.

    • contactsobjectrequired

      Contacts sync status details.

      3 properties
      • statusstringrequired

        Status of WhatsApp contacts sync.

        One ofnot_requestedpendingsyncingcompleted
      • canSyncbooleanrequired

        Whether contacts sync can be initiated.

      • requestedAtstring<date-time>nullable

        When the sync was last requested.

400Invalid request.
  • codestringrequired
  • messagestringrequired
  • detailsobject
401Unauthorized.
  • codestringrequired
  • messagestringrequired
  • detailsobject
404Sender not found.
  • codestringrequired
  • messagestringrequired
  • detailsobject