---
title: "Update sync job settings"
method: POST
path: "/api/v1/edit/imapsync_settings"
tags: ["Sync jobs"]
---

# Update sync job settings

`POST /api/v1/edit/imapsync_settings`

## Request

- Base URL: `/` (relative, and the document was published on a file host, not at the API’s origin)
- URL: `/api/v1/edit/imapsync_settings`
- Auth: API key in header `X-API-Key`

Update global sync job settings (admin only). `max_parallel` is the number of imapsync processes that may run concurrently (1-32); `max_kb_per_second` is a per-process bandwidth cap in KB/s (0 = unlimited, max. 10485760 = 10 GiB/s), stored internally in bytes/s.

## Request body

- object
  - `attr` object
    - `max_parallel` number: max. concurrent sync processes (1-32)
    - `max_kb_per_second` number: bandwidth limit per process in KB/s (0 = unlimited, max. 10485760)

## Response `200`

OK

- object
  - `log` unknown[]: contains request object (secrets are masked as "*")
    - unknown
  - `msg` unknown[]
    - unknown
  - `type` 'success' | 'danger' | 'error'

## Other responses

- `401`: Unauthorized

## Changes

- **2026-10-22** `cf82ac1f801a`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/mailcow/apis/mailcow-api/changes/api/v1/edit/imapsync_settings/post.md)

---

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