Skip to main content
POST
Configure Sync

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

x-companyid
string

The Company-Id (int or uuid) of the company on whose behalf the request is executed.

x-tenant-id
string<uuid>
required

The tenant ID for the target ERP instance.

Path Parameters

syncId
string<uuid>
required

The id of the job to Configure Represents a configuration key that serves as a unique identifier for configuration entities.

Body

application/json

The relevant Information of the Sync Item

Model Class: CreateWorkerSyncConfiguration

interval
string<duration>

The Sync Interval

configs
object[]

The Config Items to Set

Response

The changed Worker Configuration

Model Class: WorkerSyncItem

identifier
string<uuid>
required

The Unique Identifier of a Sync

syncName
string
required

the Name of the Sync

reportProgress
boolean
required

The Sync can Report Progress in Percent

configurations
object[]
required

The Configurations

salesChannelName
string

The Name of the Sales Channel

salesChannelId
string

The SalesChannel for the Sync

interval
string<duration>

The Sync Interval