---
title: "Configure Sync"
method: POST
path: "/v2/workers/{syncId}"
tags: ["worker"]
---

# Configure Sync

`POST /v2/workers/{syncId}`

Restart the Worker

## Path parameters

- `syncId` string, uuid, required — Represents a configuration key that serves as a unique identifier for configuration entities.

## Headers

- `x-tenant-id` string, uuid, required
- `x-runas` string
- `x-companyid` string

## Request body

- JTLWawiRestContractsModelsV1WorkerCreateWorkerSyncConfiguration — Model Class: CreateWorkerSyncConfiguration
  - `interval` string, duration — The Sync Interval
  - `configs` JTLWawiRestContractsModelsV1CommonCreateConfigItem[] — The Config Items to Set
    - `identifier` string, uuid — Represents a configuration key that serves as a unique identifier for configuration entities.
    - `value` string — The Serialized Configuration Value to set.

## Response `200`

The changed Worker Configuration

- JTLWawiRestContractsModelsV1WorkerWorkerSyncItem — Model Class: WorkerSyncItem
  - `identifier` string, uuid — Represents a configuration key that serves as a unique identifier for configuration entities.
  - `syncName` string — the Name of the Sync
  - `salesChannelName` string — The Name of the Sales Channel
  - `salesChannelId` string — The SalesChannel for the Sync
  - `interval` string, duration — The Sync Interval
  - `reportProgress` boolean — The Sync can Report Progress in Percent
  - `configurations` JTLWawiRestContractsModelsV1CommonConfig[] — The Configurations
    - `identifier` string, uuid — Represents a configuration key that serves as a unique identifier for configuration entities.
    - `displayName` string — The Display Name of a Setting
    - `displayDescription` string — The Display Description of a Setting
    - `type` string — The Type of the Setting
    - `currentValue` string — The Current Value of the Setting
    - `isRequired` boolean — If the Setting is Required

## Other responses

- `401`
- `402` — No licence available or the app has not been authorised by JTL.
- `404` — No item with the given ID exists.

---

[API](https://skmtc.net/jtl-software/apis/scx-authentication-api.md) · [All operations](https://skmtc.net/jtl-software/apis/scx-authentication-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/jtl-software/scx-authentication-api/revisions/f979b1ea6951/schema)