---
title: "Update WhatsApp sync settings"
method: POST
path: "/api/v1/tools/update_sync_settings"
---

# Update WhatsApp sync settings

`POST /api/v1/tools/update_sync_settings`

## Request

- Base URL: `https://whatsync.app`
- URL: `https://whatsync.app/api/v1/tools/update_sync_settings`
- Auth: one of:
  - HTTP bearer
  - API key in header `X-API-Key`

Owner-only: pause/resume workspace sync, turn saving of one-to-one QR chats on or off, select groups, change include/exclude mode or set the account timezone. Changing mode reinterprets the existing number list; inspect settings first. Pausing also blocks agent sends. Turning one-to-one saving off stops new direct chats being saved and hides saved contacts; it does not delete history.

## Headers

- `Idempotency-Key` string

## Request body

- object
  - `idempotencyKey` string, required: Unique key for this intended action. Reuse exactly on retries; use a new key only for a new action.
  - `syncEnabled` boolean
  - `directChatSyncEnabled` boolean
  - `groupSyncEnabled` boolean
  - `selectedGroups` object[]
    - `jid` string, required
    - `name` string
  - `numberFilterMode` 'include' | 'exclude'
  - `timezone` string: IANA timezone such as Asia/Kolkata

## Response `200`

JSON result. Every response includes X-Request-Id.

- object

## Other responses

- `400`: API error
- `401`: API error
- `403`: API error
- `404`: API error
- `409`: API error
- `413`: API error
- `415`: API error
- `422`: API error
- `429`: API error
- `503`: API error

---

[API](https://skmtc.dev/whatsync/apis/whatsync-api.md) · [All operations](https://skmtc.dev/whatsync/apis/whatsync-api/llms.txt) · [OpenAPI document](https://skmtc.dev/whatsync/apis/whatsync-api/revisions/6fa5498b63b7?raw)