Skip to main content
POST
Configures a worker sync (interval and configuration values).

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

Represents a configuration key that serves as a unique identifier for configuration entities.

Body

application/json

Request parameters

Configures a worker sync (interval and configuration values). - Request

interval
string<duration>

The new sync interval. When not sent the interval is left unchanged.

configurations
object[]

The configuration values to assign. When not sent no configuration value is changed.

Response

The changed worker configuration.

A worker sync and its configuration.

identifier
string<uuid>

The unique identifier of a sync.

syncName
string

The name of the sync.

salesChannelName
string

The name of the sales channel.

salesChannelId
string

The sales channel for the sync.

interval
string<duration>

The sync interval.

reportProgress
boolean

Indicates whether the sync reports progress in percent.

configurations
object[]

The configuration entries of the worker sync.