---
title: "Start history sync"
method: POST
path: "/v1/senders/{senderId}/whatsapp-sync/history"
tags: ["WhatsApp Sync"]
---

# Start history sync

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

## Request

- Base URL: `https://api.zavu.dev`
- URL: `https://api.zavu.dev/v1/senders/{senderId}/whatsapp-sync/history`
- Auth: HTTP bearer

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.

## Path parameters

- `senderId` string, required

## Response `202`

History sync initiated.

- WhatsAppSyncStartResponse
  - `message` string, required: Success message.
  - `sync` WhatsAppSyncStatus, required: WhatsApp coexistence sync status.
    - `isCoexistence` boolean, required: Whether the account is in coexistence mode.
    - `status` 'pending_verification' | 'pending_registration' | 'active' | 'disconnected' | 'error', required: WhatsApp account status.
    - `history` WhatsAppSyncHistory, required: History sync status details.
      - `status` 'not_requested' | 'pending' | 'syncing' | 'completed' | 'rejected', required: Status of WhatsApp message history sync.
      - `canSync` boolean, required: Whether history sync can be initiated.
      - `requestedAt` string, date-time, nullable: When the sync was last requested.
      - `completedAt` string, date-time, nullable: When the sync was completed.
    - `contacts` WhatsAppSyncContacts, required: Contacts sync status details.
      - `status` 'not_requested' | 'pending' | 'syncing' | 'completed', required: Status of WhatsApp contacts sync.
      - `canSync` boolean, required: Whether contacts sync can be initiated.
      - `requestedAt` string, date-time, nullable: When the sync was last requested.

## Other responses

- `400`: Invalid request.
- `401`: Unauthorized.
- `404`: Sender not found.

---

[API](https://skmtc.dev/zavudev/apis/zavu-unified-messaging-layer-api.md) - [All operations](https://skmtc.dev/zavudev/apis/zavu-unified-messaging-layer-api/llms.txt) - [OpenAPI document](https://skmtc.dev/zavudev/apis/zavu-unified-messaging-layer-api/revisions/75bc777b0ffb?raw)