Start contacts sync

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.

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

Start contacts sync

cURL

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

202

Example

{
  "message": "Contacts sync initiated",
  "sync": {
    "isCoexistence": true,
    "status": "active",
    "history": {
      "status": "completed",
      "canSync": false,
      "requestedAt": "2024-01-15T10:00:00Z",
      "completedAt": "2024-01-15T10:05:00Z"
    },
    "contacts": {
      "status": "pending",
      "canSync": false,
      "requestedAt": "2024-01-15T11:00:00Z"
    }
  }
}

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

Contacts sync initiated.

message · string · required

Success message.

Example:

"History sync initiated"

sync · object · required

WhatsApp coexistence sync status.

Show child attributes