Start history sync

Initiate message history sync from the WhatsApp Business App. This sends a request to the account owner to approve sharing their conversation history. Only available for coexistence accounts with active status.

POST /v1/senders/{senderId}/whatsapp-sync/history

Start history sync

cURL

curl --request POST \
  --url https://api.zavu.dev/v1/senders/{senderId}/whatsapp-sync/history \
  --header 'Authorization: Bearer <token>'

202

Example

{
  "message": "History sync initiated",
  "sync": {
    "isCoexistence": true,
    "status": "active",
    "history": {
      "status": "pending",
      "canSync": false,
      "requestedAt": "2024-01-15T10:00:00Z",
      "completedAt": null
    },
    "contacts": {
      "status": "not_requested",
      "canSync": true,
      "requestedAt": null
    }
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

senderId · string · required

Response

202

application/json

History sync initiated.

message · string · required

Success message.

Example:

"History sync initiated"

sync · object · required

WhatsApp coexistence sync status.

Show child attributes