Skip to main content
POST
/
v2
/
workers
/
configure
Configures a worker sync (interval and configuration values).
curl --request POST \
  --url https://api.jtl-cloud.com/erp/v2/workers/configure \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-tenant-id: <x-tenant-id>' \
  --data '
{
  "syncId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "interval": "<string>",
  "configurations": [
    {
      "identifier": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "value": "<string>"
    }
  ]
}
'

Authorizations

​
Authorization
string
header
required

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

Headers

​
x-tenant-id
string<uuid>
required

The tenant ID for the target ERP instance.

​
x-runas
string

The User-Id (int or uuid) on whose behalf the request is executed. Requires scope 'Application.RunAs'.

​
x-companyid
string

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

Body

application/json

Request parameters

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

​
syncId
string<uuid>

The id of the sync to configure.

​
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

200 - application/json

The changed worker configuration.